docs/reference/gio/html/GNetworkService.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>GNetworkService</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="GNetworkAddress.html" title="GNetworkAddress">
  10 <link rel="next" href="GSrvTarget.html" title="GSrvTarget">
  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="GNetworkAddress.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="GSrvTarget.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="#GNetworkService.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GNetworkService.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GNetworkService.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GNetworkService.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#GNetworkService.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="GNetworkService"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="GNetworkService.top_of_page"></a>GNetworkService</span></h2>
  40 <p>GNetworkService — A GSocketConnectable for resolving SRV records</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="GNetworkService.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">
  47 #include &lt;gio/gio.h&gt;
  48
  49                     <a class="link" href="GNetworkService.html#GNetworkService-struct" title="GNetworkService">GNetworkService</a>;
  50 <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="returnvalue">GSocketConnectable</span></a> * <a class="link" href="GNetworkService.html#g-network-service-new" title="g_network_service_new ()">g_network_service_new</a>              (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service</code></em>,
  51                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
  52                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);
  53 const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GNetworkService.html#g-network-service-get-service" title="g_network_service_get_service ()">g_network_service_get_service</a>       (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);
  54 const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GNetworkService.html#g-network-service-get-protocol" title="g_network_service_get_protocol ()">g_network_service_get_protocol</a>      (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);
  55 const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GNetworkService.html#g-network-service-get-domain" title="g_network_service_get_domain ()">g_network_service_get_domain</a>        (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);
  56 const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GNetworkService.html#g-network-service-get-scheme" title="g_network_service_get_scheme ()">g_network_service_get_scheme</a>        (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);
  57 <span class="returnvalue">void</span>                <a class="link" href="GNetworkService.html#g-network-service-set-scheme" title="g_network_service_set_scheme ()">g_network_service_set_scheme</a>        (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>,
  58                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *scheme</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="GNetworkService.object-hierarchy"></a><h2>Object Hierarchy</h2>
  63 <pre class="synopsis">
  64   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  65    +----GNetworkService
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GNetworkService.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  70 <p>
  71 GNetworkService implements
  72  <a class="link" href="GSocketConnectable.html" title="GSocketConnectable">GSocketConnectable</a>.</p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="GNetworkService.properties"></a><h2>Properties</h2>
  76 <pre class="synopsis">
  77   "<a class="link" href="GNetworkService.html#GNetworkService--domain" title='The "domain" property'>domain</a>"                   <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  78   "<a class="link" href="GNetworkService.html#GNetworkService--protocol" title='The "protocol" property'>protocol</a>"                 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  79   "<a class="link" href="GNetworkService.html#GNetworkService--scheme" title='The "scheme" property'>scheme</a>"                   <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  80   "<a class="link" href="GNetworkService.html#GNetworkService--service" title='The "service" property'>service</a>"                  <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="GNetworkService.description"></a><h2>Description</h2>
  85 <p>
  86 Like <a class="link" href="GNetworkAddress.html" title="GNetworkAddress"><span class="type">GNetworkAddress</span></a> does with hostnames, <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>
  87 provides an easy way to resolve a SRV record, and then attempt to
  88 connect to one of the hosts that implements that service, handling
  89 service priority/weighting, multiple IP addresses, and multiple
  90 address families.
  91 </p>
  92 <p>
  93 See <a class="link" href="GSrvTarget.html" title="GSrvTarget"><span class="type">GSrvTarget</span></a> for more information about SRV records, and see
  94 <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> for and example of using the connectable
  95 interface.
  96 </p>
  97 </div>
  98 <div class="refsect1">
  99 <a name="GNetworkService.details"></a><h2>Details</h2>
 100 <div class="refsect2">
 101 <a name="GNetworkService-struct"></a><h3>GNetworkService</h3>
 102 <pre class="programlisting">typedef struct _GNetworkService GNetworkService;</pre>
 103 <p>
 104 A <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> for resolving a SRV record and connecting to
 105 that service.
 106 </p>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="g-network-service-new"></a><h3>g_network_service_new ()</h3>
 111 <pre class="programlisting"><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="returnvalue">GSocketConnectable</span></a> * g_network_service_new              (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service</code></em>,
 112                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
 113                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);</pre>
 114 <p>
 115 Creates a new <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> representing the given <em class="parameter"><code>service</code></em>,
 116 <em class="parameter"><code>protocol</code></em>, and <em class="parameter"><code>domain</code></em>. This will initially be unresolved; use the
 117 <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> interface to resolve it.
 118 </p>
 119 <div class="variablelist"><table border="0">
 120 <col align="left" valign="top">
 121 <tbody>
 122 <tr>
 123 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 124 <td>the service type to look up (eg, "ldap")</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
 128 <td>the networking protocol to use for <em class="parameter"><code>service</code></em> (eg, "tcp")</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
 132 <td>the DNS domain to look up the service in</td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 136 <td>a new <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GNetworkService]</span>
 137 </td>
 138 </tr>
 139 </tbody>
 140 </table></div>
 141 <p class="since">Since 2.22</p>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="g-network-service-get-service"></a><h3>g_network_service_get_service ()</h3>
 146 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_network_service_get_service       (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);</pre>
 147 <p>
 148 Gets <em class="parameter"><code>srv</code></em>'s service name (eg, "ldap").
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>srv</code></em> :</span></p></td>
 155 <td>a <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 160 <td>
 161 <em class="parameter"><code>srv</code></em>'s service name</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 <p class="since">Since 2.22</p>
 166 </div>
 167 <hr>
 168 <div class="refsect2">
 169 <a name="g-network-service-get-protocol"></a><h3>g_network_service_get_protocol ()</h3>
 170 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_network_service_get_protocol      (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);</pre>
 171 <p>
 172 Gets <em class="parameter"><code>srv</code></em>'s protocol name (eg, "tcp").
 173 </p>
 174 <div class="variablelist"><table border="0">
 175 <col align="left" valign="top">
 176 <tbody>
 177 <tr>
 178 <td><p><span class="term"><em class="parameter"><code>srv</code></em> :</span></p></td>
 179 <td>a <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>
 180 </td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 184 <td>
 185 <em class="parameter"><code>srv</code></em>'s protocol name</td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 <p class="since">Since 2.22</p>
 190 </div>
 191 <hr>
 192 <div class="refsect2">
 193 <a name="g-network-service-get-domain"></a><h3>g_network_service_get_domain ()</h3>
 194 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_network_service_get_domain        (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);</pre>
 195 <p>
 196 Gets the domain that <em class="parameter"><code>srv</code></em> serves. This might be either UTF-8 or
 197 ASCII-encoded, depending on what <em class="parameter"><code>srv</code></em> was created with.
 198 </p>
 199 <div class="variablelist"><table border="0">
 200 <col align="left" valign="top">
 201 <tbody>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>srv</code></em> :</span></p></td>
 204 <td>a <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>
 205 </td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 209 <td>
 210 <em class="parameter"><code>srv</code></em>'s domain name</td>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 <p class="since">Since 2.22</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="g-network-service-get-scheme"></a><h3>g_network_service_get_scheme ()</h3>
 219 <pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_network_service_get_scheme        (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>);</pre>
 220 <p>
 221 Get's the URI scheme used to resolve proxies. By default, the service name
 222 is used as scheme.
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>srv</code></em> :</span></p></td>
 229 <td>a <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 234 <td>
 235 <em class="parameter"><code>srv</code></em>'s scheme name</td>
 236 </tr>
 237 </tbody>
 238 </table></div>
 239 <p class="since">Since 2.26</p>
 240 </div>
 241 <hr>
 242 <div class="refsect2">
 243 <a name="g-network-service-set-scheme"></a><h3>g_network_service_set_scheme ()</h3>
 244 <pre class="programlisting"><span class="returnvalue">void</span>                g_network_service_set_scheme        (<em class="parameter"><code><a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a> *srv</code></em>,
 245                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *scheme</code></em>);</pre>
 246 <p>
 247 Set's the URI scheme used to resolve proxies. By default, the service name
 248 is used as scheme.
 249 </p>
 250 <div class="variablelist"><table border="0">
 251 <col align="left" valign="top">
 252 <tbody>
 253 <tr>
 254 <td><p><span class="term"><em class="parameter"><code>srv</code></em> :</span></p></td>
 255 <td>a <a class="link" href="GNetworkService.html" title="GNetworkService"><span class="type">GNetworkService</span></a>
 256 </td>
 257 </tr>
 258 <tr>
 259 <td><p><span class="term"><em class="parameter"><code>scheme</code></em> :</span></p></td>
 260 <td>a URI scheme</td>
 261 </tr>
 262 </tbody>
 263 </table></div>
 264 <p class="since">Since 2.26</p>
 265 </div>
 266 </div>
 267 <div class="refsect1">
 268 <a name="GNetworkService.property-details"></a><h2>Property Details</h2>
 269 <div class="refsect2">
 270 <a name="GNetworkService--domain"></a><h3>The <code class="literal">"domain"</code> property</h3>
 271 <pre class="programlisting">  "domain"                   <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 272 <p>Network domain, eg, "example.com".</p>
 273 <p>Default value: NULL</p>
 274 </div>
 275 <hr>
 276 <div class="refsect2">
 277 <a name="GNetworkService--protocol"></a><h3>The <code class="literal">"protocol"</code> property</h3>
 278 <pre class="programlisting">  "protocol"                 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 279 <p>Network protocol, eg "tcp".</p>
 280 <p>Default value: NULL</p>
 281 </div>
 282 <hr>
 283 <div class="refsect2">
 284 <a name="GNetworkService--scheme"></a><h3>The <code class="literal">"scheme"</code> property</h3>
 285 <pre class="programlisting">  "scheme"                   <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 286 <p>Network scheme (default is to use service).</p>
 287 <p>Default value: NULL</p>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="GNetworkService--service"></a><h3>The <code class="literal">"service"</code> property</h3>
 292 <pre class="programlisting">  "service"                  <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 293 <p>Service name, eg "ldap".</p>
 294 <p>Default value: NULL</p>
 295 </div>
 296 </div>
 297 </div>
 298 <div class="footer">
 299 <hr>
 300           Generated by GTK-Doc V1.18</div>
 301 </body>
 302 </html>