1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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">
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">
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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GNetworkService.synopsis" class="shortcut">Top</a>
26 <a href="#GNetworkService.description" class="shortcut">Description</a>
28 <a href="#GNetworkService.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#GNetworkService.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#GNetworkService.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="GNetworkService"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
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>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="GNetworkService.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">
47 #include <gio/gio.h>
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>);
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>
68 <div class="refsect1">
69 <a name="GNetworkService.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
71 GNetworkService implements
72 <a class="link" href="GSocketConnectable.html" title="GSocketConnectable">GSocketConnectable</a>.</p>
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
83 <div class="refsect1">
84 <a name="GNetworkService.description"></a><h2>Description</h2>
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
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
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>
104 A <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> for resolving a SRV record and connecting to
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>
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.
119 <div class="variablelist"><table border="0">
120 <col align="left" valign="top">
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>
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>
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>
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>
141 <p class="since">Since 2.22</p>
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>
148 Gets <em class="parameter"><code>srv</code></em>'s service name (eg, "ldap").
150 <div class="variablelist"><table border="0">
151 <col align="left" valign="top">
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>
159 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161 <em class="parameter"><code>srv</code></em>'s service name</td>
165 <p class="since">Since 2.22</p>
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>
172 Gets <em class="parameter"><code>srv</code></em>'s protocol name (eg, "tcp").
174 <div class="variablelist"><table border="0">
175 <col align="left" valign="top">
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>
183 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185 <em class="parameter"><code>srv</code></em>'s protocol name</td>
189 <p class="since">Since 2.22</p>
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>
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.
199 <div class="variablelist"><table border="0">
200 <col align="left" valign="top">
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>
208 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210 <em class="parameter"><code>srv</code></em>'s domain name</td>
214 <p class="since">Since 2.22</p>
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>
221 Get's the URI scheme used to resolve proxies. By default, the service name
224 <div class="variablelist"><table border="0">
225 <col align="left" valign="top">
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>
233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
235 <em class="parameter"><code>srv</code></em>'s scheme name</td>
239 <p class="since">Since 2.26</p>
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>
247 Set's the URI scheme used to resolve proxies. By default, the service name
250 <div class="variablelist"><table border="0">
251 <col align="left" valign="top">
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>
259 <td><p><span class="term"><em class="parameter"><code>scheme</code></em> :</span></p></td>
260 <td>a URI scheme</td>
264 <p class="since">Since 2.26</p>
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>
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>
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>
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>
300 Generated by GTK-Doc V1.18</div>