docs/reference/gio/html/GSocketConnectable.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GSocketConnectable</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="resolver.html" title="DNS resolution">
   9 <link rel="prev" href="GProxyResolver.html" title="GProxyResolver">
  10 <link rel="next" href="GNetworkAddress.html" title="GNetworkAddress">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GProxyResolver.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="resolver.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GNetworkAddress.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GSocketConnectable.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GSocketConnectable.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GSocketConnectable.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GSocketConnectable.prerequisites" class="shortcut">Prerequisites</a>
  31                    |
  32                   <a href="#GSocketConnectable.implementations" class="shortcut">Known Implementations</a>
  33                    |
  34                   <a href="#GSocketConnectable.properties" class="shortcut">Properties</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="GSocketConnectable"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="GSocketConnectable.top_of_page"></a>GSocketConnectable</span></h2>
  42 <p>GSocketConnectable — Interface for potential socket endpoints</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="GSocketConnectable.synopsis"></a><h2>Synopsis</h2>
  48 <a name="GSocketAddressEnumerator"></a><a name="GProxyAddressEnumerator"></a><pre class="synopsis">                    <a class="link" href="GSocketConnectable.html#GSocketConnectable-struct" title="GSocketConnectable">GSocketConnectable</a>;
  49 struct              <a class="link" href="GSocketConnectable.html#GSocketConnectableIface" title="struct GSocketConnectableIface">GSocketConnectableIface</a>;
  50 <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="returnvalue">GSocketAddressEnumerator</span></a> * <a class="link" href="GSocketConnectable.html#g-socket-connectable-enumerate" title="g_socket_connectable_enumerate ()">g_socket_connectable_enumerate</a>
  51                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> *connectable</code></em>);
  52 <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="returnvalue">GSocketAddressEnumerator</span></a> * <a class="link" href="GSocketConnectable.html#g-socket-connectable-proxy-enumerate" title="g_socket_connectable_proxy_enumerate ()">g_socket_connectable_proxy_enumerate</a>
  53                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> *connectable</code></em>);
  54
  55                     <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator-struct" title="GSocketAddressEnumerator">GSocketAddressEnumerator</a>;
  56 <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> *    <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next" title="g_socket_address_enumerator_next ()">g_socket_address_enumerator_next</a>    (<em class="parameter"><code><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> *enumerator</code></em>,
  57                                                          <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  58                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next-async" title="g_socket_address_enumerator_next_async ()">g_socket_address_enumerator_next_async</a>
  60                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> *enumerator</code></em>,
  61                                                          <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  62                                                          <em class="parameter"><code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
  63                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
  64 <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> *    <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next-finish" title="g_socket_address_enumerator_next_finish ()">g_socket_address_enumerator_next_finish</a>
  65                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> *enumerator</code></em>,
  66                                                          <em class="parameter"><code><a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a> *result</code></em>,
  67                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  68
  69                     <a class="link" href="GSocketConnectable.html#GProxyAddressEnumerator-struct" title="GProxyAddressEnumerator">GProxyAddressEnumerator</a>;
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="GSocketConnectable.object-hierarchy"></a><h2>Object Hierarchy</h2>
  74 <pre class="synopsis">
  75   GInterface
  76    +----GSocketConnectable
  77 </pre>
  78 <pre class="synopsis">
  79   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  80    +----GSocketAddressEnumerator
  81          +----<a class="link" href="GSocketConnectable.html#GProxyAddressEnumerator">GProxyAddressEnumerator</a>
  82 </pre>
  83 <pre class="synopsis">
  84   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  85    +----<a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator">GSocketAddressEnumerator</a>
  86          +----GProxyAddressEnumerator
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="GSocketConnectable.prerequisites"></a><h2>Prerequisites</h2>
  91 <p>
  92 GSocketConnectable requires
  93  <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
  94 </div>
  95 <div class="refsect1">
  96 <a name="GSocketConnectable.implementations"></a><h2>Known Implementations</h2>
  97 <p>
  98 GSocketConnectable is implemented by
  99  <a class="link" href="GInetSocketAddress.html" title="GInetSocketAddress">GInetSocketAddress</a>,  <a class="link" href="GNetworkAddress.html" title="GNetworkAddress">GNetworkAddress</a>,  <a class="link" href="GNetworkService.html" title="GNetworkService">GNetworkService</a>,  <a class="link" href="GProxyAddress.html" title="GProxyAddress">GProxyAddress</a>,  <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> and  <a class="link" href="GUnixSocketAddress.html" title="GUnixSocketAddress">GUnixSocketAddress</a>.</p>
 100 </div>
 101 <div class="refsect1">
 102 <a name="GSocketConnectable.properties"></a><h2>Properties</h2>
 103 <pre class="synopsis">
 104   "<a class="link" href="GSocketConnectable.html#GProxyAddressEnumerator--connectable" title='The "connectable" property'>connectable</a>"              <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a>*   : Read / Write / Construct Only
 105   "<a class="link" href="GSocketConnectable.html#GProxyAddressEnumerator--uri" title='The "uri" property'>uri</a>"                      <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 106 </pre>
 107 </div>
 108 <div class="refsect1">
 109 <a name="GSocketConnectable.description"></a><h2>Description</h2>
 110 <p>
 111 Objects that describe one or more potential socket endpoints
 112 implement <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a>. Callers can then use
 113 <a class="link" href="GSocketConnectable.html#g-socket-connectable-enumerate" title="g_socket_connectable_enumerate ()"><code class="function">g_socket_connectable_enumerate()</code></a> to get a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>
 114 to try out each socket address in turn until one succeeds, as shown
 115 in the sample code below.
 116 </p>
 117 <p>
 118 </p>
 119 <div class="informalexample"><pre class="programlisting">
 120 MyConnectionType *
 121 connect_to_host (const char    *hostname,
 122                  guint16        port,
 123                  GCancellable  *cancellable,
 124                  GError       **error)
 125 {
 126   MyConnection *conn = NULL;
 127   GSocketConnectable *addr;
 128   GSocketAddressEnumerator *enumerator;
 129   GSocketAddress *sockaddr;
 130   GError *conn_error = NULL;
 131
 132   addr = g_network_address_new ("www.gnome.org", 80);
 133   enumerator = g_socket_connectable_enumerate (addr);
 134   g_object_unref (addr);
 135
 136   /* Try each sockaddr until we succeed. Record the first
 137    * connection error, but not any further ones (since they'll probably
 138    * be basically the same as the first).
 139    */
 140   while (!conn &amp;&amp; (sockaddr = g_socket_address_enumerator_next (enumerator, cancellable, error))
 141     {
 142       conn = connect_to_sockaddr (sockaddr, conn_error ? NULL : &amp;conn_error);
 143       g_object_unref (sockaddr);
 144     }
 145   g_object_unref (enumerator);
 146
 147   if (conn)
 148     {
 149       if (conn_error)
 150         {
 151           /* We couldn't connect to the first address, but we succeeded
 152            * in connecting to a later address.
 153            */
 154           g_error_free (conn_error);
 155         }
 156       return conn;
 157     }
 158   else if (error)
 159     {
 160       /* Either the initial lookup failed, or else the caller
 161        * cancelled us.
 162        */
 163       if (conn_error)
 164         g_error_free (conn_error);
 165       return NULL;
 166     }
 167   else
 168     {
 169       g_error_propagate (error, conn_error);
 170       return NULL;
 171     }
 172 }
 173 </pre></div>
 174 <p>
 175 </p>
 176 </div>
 177 <div class="refsect1">
 178 <a name="GSocketConnectable.details"></a><h2>Details</h2>
 179 <div class="refsect2">
 180 <a name="GSocketConnectable-struct"></a><h3>GSocketConnectable</h3>
 181 <pre class="programlisting">typedef struct _GSocketConnectable GSocketConnectable;</pre>
 182 <p>
 183 Interface for objects that contain or generate <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a>es.
 184 </p>
 185 </div>
 186 <hr>
 187 <div class="refsect2">
 188 <a name="GSocketConnectableIface"></a><h3>struct GSocketConnectableIface</h3>
 189 <pre class="programlisting">struct GSocketConnectableIface {
 190   GTypeInterface g_iface;
 191
 192   /* Virtual Table */
 193
 194   GSocketAddressEnumerator * (* enumerate)       (GSocketConnectable *connectable);
 195
 196   GSocketAddressEnumerator * (* proxy_enumerate) (GSocketConnectable *connectable);
 197 };
 198 </pre>
 199 <p>
 200 Provides an interface for returning a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>
 201 and <a class="link" href="GSocketConnectable.html#GProxyAddressEnumerator"><span class="type">GProxyAddressEnumerator</span></a>
 202 </p>
 203 <div class="variablelist"><table border="0">
 204 <col align="left" valign="top">
 205 <tbody>
 206 <tr>
 207 <td><p><span class="term"><a href="./../gobject/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GSocketConnectableIface.g-iface"></a>g_iface</code></em>;</span></p></td>
 208 <td>The parent interface.</td>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term"><em class="structfield"><code><a name="GSocketConnectableIface.enumerate"></a>enumerate</code></em> ()</span></p></td>
 212 <td>Creates a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>
 213 </td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term"><em class="structfield"><code><a name="GSocketConnectableIface.proxy-enumerate"></a>proxy_enumerate</code></em> ()</span></p></td>
 217 <td>Creates a <a class="link" href="GSocketConnectable.html#GProxyAddressEnumerator"><span class="type">GProxyAddressEnumerator</span></a>
 218 </td>
 219 </tr>
 220 </tbody>
 221 </table></div>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="g-socket-connectable-enumerate"></a><h3>g_socket_connectable_enumerate ()</h3>
 226 <pre class="programlisting"><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="returnvalue">GSocketAddressEnumerator</span></a> * g_socket_connectable_enumerate
 227                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> *connectable</code></em>);</pre>
 228 <p>
 229 Creates a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> for <em class="parameter"><code>connectable</code></em>.
 230 </p>
 231 <div class="variablelist"><table border="0">
 232 <col align="left" valign="top">
 233 <tbody>
 234 <tr>
 235 <td><p><span class="term"><em class="parameter"><code>connectable</code></em> :</span></p></td>
 236 <td>a <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a>
 237 </td>
 238 </tr>
 239 <tr>
 240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 241 <td>a new <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 242 </td>
 243 </tr>
 244 </tbody>
 245 </table></div>
 246 <p class="since">Since 2.22</p>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="g-socket-connectable-proxy-enumerate"></a><h3>g_socket_connectable_proxy_enumerate ()</h3>
 251 <pre class="programlisting"><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="returnvalue">GSocketAddressEnumerator</span></a> * g_socket_connectable_proxy_enumerate
 252                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> *connectable</code></em>);</pre>
 253 <p>
 254 Creates a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> for <em class="parameter"><code>connectable</code></em> that will
 255 return <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>es for addresses that you must connect
 256 to via a proxy.
 257 </p>
 258 <p>
 259 If <em class="parameter"><code>connectable</code></em> does not implement
 260 <a class="link" href="GSocketConnectable.html#g-socket-connectable-proxy-enumerate" title="g_socket_connectable_proxy_enumerate ()"><code class="function">g_socket_connectable_proxy_enumerate()</code></a>, this will fall back to
 261 calling <a class="link" href="GSocketConnectable.html#g-socket-connectable-enumerate" title="g_socket_connectable_enumerate ()"><code class="function">g_socket_connectable_enumerate()</code></a>.
 262 </p>
 263 <div class="variablelist"><table border="0">
 264 <col align="left" valign="top">
 265 <tbody>
 266 <tr>
 267 <td><p><span class="term"><em class="parameter"><code>connectable</code></em> :</span></p></td>
 268 <td>a <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a>
 269 </td>
 270 </tr>
 271 <tr>
 272 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 273 <td>a new <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 274 </td>
 275 </tr>
 276 </tbody>
 277 </table></div>
 278 <p class="since">Since 2.26</p>
 279 </div>
 280 <hr>
 281 <div class="refsect2">
 282 <a name="GSocketAddressEnumerator-struct"></a><h3>GSocketAddressEnumerator</h3>
 283 <pre class="programlisting">typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;</pre>
 284 <p>
 285 Enumerator type for objects that contain or generate
 286 <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a>es.
 287 </p>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="g-socket-address-enumerator-next"></a><h3>g_socket_address_enumerator_next ()</h3>
 292 <pre class="programlisting"><a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> *    g_socket_address_enumerator_next    (<em class="parameter"><code><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> *enumerator</code></em>,
 293                                                          <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 294                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 295 <p>
 296 Retrieves the next <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a> from <em class="parameter"><code>enumerator</code></em>. Note that this
 297 may block for some amount of time. (Eg, a <a class="link" href="GNetworkAddress.html" title="GNetworkAddress"><span class="type">GNetworkAddress</span></a> may need
 298 to do a DNS lookup before it can return an address.) Use
 299 <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next-async" title="g_socket_address_enumerator_next_async ()"><code class="function">g_socket_address_enumerator_next_async()</code></a> if you need to avoid
 300 blocking.
 301 </p>
 302 <p>
 303 If <em class="parameter"><code>enumerator</code></em> is expected to yield addresses, but for some reason
 304 is unable to (eg, because of a DNS error), then the first call to
 305 <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next" title="g_socket_address_enumerator_next ()"><code class="function">g_socket_address_enumerator_next()</code></a> will return an appropriate error
 306 in *<em class="parameter"><code>error</code></em>. However, if the first call to
 307 <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next" title="g_socket_address_enumerator_next ()"><code class="function">g_socket_address_enumerator_next()</code></a> succeeds, then any further
 308 internal errors (other than <em class="parameter"><code>cancellable</code></em> being triggered) will be
 309 ignored.
 310 </p>
 311 <div class="variablelist"><table border="0">
 312 <col align="left" valign="top">
 313 <tbody>
 314 <tr>
 315 <td><p><span class="term"><em class="parameter"><code>enumerator</code></em> :</span></p></td>
 316 <td>a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>
 317 </td>
 318 </tr>
 319 <tr>
 320 <td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 321 <td>optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 322 </td>
 323 </tr>
 324 <tr>
 325 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 326 <td>a <a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</td>
 327 </tr>
 328 <tr>
 329 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 330 <td>a <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a> (owned by the caller), or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on
 331 error (in which case *<em class="parameter"><code>error</code></em> will be set) or if there are no
 332 more addresses. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 333 </td>
 334 </tr>
 335 </tbody>
 336 </table></div>
 337 </div>
 338 <hr>
 339 <div class="refsect2">
 340 <a name="g-socket-address-enumerator-next-async"></a><h3>g_socket_address_enumerator_next_async ()</h3>
 341 <pre class="programlisting"><span class="returnvalue">void</span>                g_socket_address_enumerator_next_async
 342                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> *enumerator</code></em>,
 343                                                          <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 344                                                          <em class="parameter"><code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 345                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 346 <p>
 347 Asynchronously retrieves the next <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a> from <em class="parameter"><code>enumerator</code></em>
 348 and then calls <em class="parameter"><code>callback</code></em>, which must call
 349 <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next-finish" title="g_socket_address_enumerator_next_finish ()"><code class="function">g_socket_address_enumerator_next_finish()</code></a> to get the result.
 350 </p>
 351 <div class="variablelist"><table border="0">
 352 <col align="left" valign="top">
 353 <tbody>
 354 <tr>
 355 <td><p><span class="term"><em class="parameter"><code>enumerator</code></em> :</span></p></td>
 356 <td>a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>
 357 </td>
 358 </tr>
 359 <tr>
 360 <td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 361 <td>optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 362 </td>
 363 </tr>
 364 <tr>
 365 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 366 <td>a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a> to call when the request
 367 is satisfied. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span>
 368 </td>
 369 </tr>
 370 <tr>
 371 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 372 <td>the data to pass to callback function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 373 </td>
 374 </tr>
 375 </tbody>
 376 </table></div>
 377 </div>
 378 <hr>
 379 <div class="refsect2">
 380 <a name="g-socket-address-enumerator-next-finish"></a><h3>g_socket_address_enumerator_next_finish ()</h3>
 381 <pre class="programlisting"><a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> *    g_socket_address_enumerator_next_finish
 382                                                         (<em class="parameter"><code><a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> *enumerator</code></em>,
 383                                                          <em class="parameter"><code><a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a> *result</code></em>,
 384                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 385 <p>
 386 Retrieves the result of a completed call to
 387 <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next-async" title="g_socket_address_enumerator_next_async ()"><code class="function">g_socket_address_enumerator_next_async()</code></a>. See
 388 <a class="link" href="GSocketConnectable.html#g-socket-address-enumerator-next" title="g_socket_address_enumerator_next ()"><code class="function">g_socket_address_enumerator_next()</code></a> for more information about
 389 error handling.
 390 </p>
 391 <div class="variablelist"><table border="0">
 392 <col align="left" valign="top">
 393 <tbody>
 394 <tr>
 395 <td><p><span class="term"><em class="parameter"><code>enumerator</code></em> :</span></p></td>
 396 <td>a <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a>
 397 </td>
 398 </tr>
 399 <tr>
 400 <td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 401 <td>a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>
 402 </td>
 403 </tr>
 404 <tr>
 405 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 406 <td>a <a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 407 </td>
 408 </tr>
 409 <tr>
 410 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 411 <td>a <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a> (owned by the caller), or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on
 412 error (in which case *<em class="parameter"><code>error</code></em> will be set) or if there are no
 413 more addresses. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 414 </td>
 415 </tr>
 416 </tbody>
 417 </table></div>
 418 </div>
 419 <hr>
 420 <div class="refsect2">
 421 <a name="GProxyAddressEnumerator-struct"></a><h3>GProxyAddressEnumerator</h3>
 422 <pre class="programlisting">typedef struct _GProxyAddressEnumerator GProxyAddressEnumerator;</pre>
 423 <p>
 424 A subclass of <a class="link" href="GSocketConnectable.html#GSocketAddressEnumerator"><span class="type">GSocketAddressEnumerator</span></a> that takes another address
 425 enumerator and wraps its results in <a class="link" href="GProxyAddress.html" title="GProxyAddress"><span class="type">GProxyAddress</span></a>es as
 426 directed by the default <a class="link" href="GProxyResolver.html" title="GProxyResolver"><span class="type">GProxyResolver</span></a>.
 427 </p>
 428 </div>
 429 </div>
 430 <div class="refsect1">
 431 <a name="GSocketConnectable.property-details"></a><h2>Property Details</h2>
 432 <div class="refsect2">
 433 <a name="GProxyAddressEnumerator--connectable"></a><h3>The <code class="literal">"connectable"</code> property</h3>
 434 <pre class="programlisting">  "connectable"              <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a>*   : Read / Write / Construct Only</pre>
 435 <p>The connectable being enumerated.</p>
 436 </div>
 437 <hr>
 438 <div class="refsect2">
 439 <a name="GProxyAddressEnumerator--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
 440 <pre class="programlisting">  "uri"                      <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 441 <p>The destination URI, use none:// for generic socket.</p>
 442 <p>Default value: NULL</p>
 443 </div>
 444 </div>
 445 </div>
 446 <div class="footer">
 447 <hr>
 448           Generated by GTK-Doc V1.18</div>
 449 </body>
 450 </html>