Updated GSSDP version to 0.13.1 (85c939e)
[profile/ivi/GSSDP.git] / doc / html / GSSDPClient.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>GSSDPClient</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GSSDP Reference Manual">
8 <link rel="up" href="ch01.html" title="GSSDP">
9 <link rel="prev" href="ch01.html" title="GSSDP">
10 <link rel="next" href="GSSDPResourceBrowser.html" title="GSSDPResourceBrowser">
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="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.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">GSSDP Reference Manual</th>
21 <td><a accesskey="n" href="GSSDPResourceBrowser.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="#GSSDPClient.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GSSDPClient.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GSSDPClient.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#GSSDPClient.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#GSSDPClient.properties" class="shortcut">Properties</a>
33                    | 
34                   <a href="#GSSDPClient.signals" class="shortcut">Signals</a>
35 </td></tr>
36 </table>
37 <div class="refentry">
38 <a name="GSSDPClient"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
40 <td valign="top">
41 <h2><span class="refentrytitle"><a name="GSSDPClient.top_of_page"></a>GSSDPClient</span></h2>
42 <p>GSSDPClient — SSDP "bus" wrapper.</p>
43 </td>
44 <td valign="top" align="right"></td>
45 </tr></table></div>
46 <div class="refsynopsisdiv">
47 <a name="GSSDPClient.synopsis"></a><h2>Synopsis</h2>
48 <pre class="synopsis">struct              <a class="link" href="GSSDPClient.html#GSSDPClient-struct" title="struct GSSDPClient">GSSDPClient</a>;
49 <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="returnvalue">GSSDPClient</span></a> *       <a class="link" href="GSSDPClient.html#gssdp-client-new" title="gssdp_client_new ()">gssdp_client_new</a>                    (<em class="parameter"><code><span class="type">GMainContext</span> *main_context</code></em>,
50                                                          <em class="parameter"><code>const <span class="type">char</span> *iface</code></em>,
51                                                          <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
52 <span class="returnvalue">GMainContext</span> *      <a class="link" href="GSSDPClient.html#gssdp-client-get-main-context" title="gssdp_client_get_main_context ()">gssdp_client_get_main_context</a>       (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
53 <span class="returnvalue">void</span>                <a class="link" href="GSSDPClient.html#gssdp-client-set-server-id" title="gssdp_client_set_server_id ()">gssdp_client_set_server_id</a>          (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>,
54                                                          <em class="parameter"><code>const <span class="type">char</span> *server_id</code></em>);
55 const <span class="returnvalue">char</span> *        <a class="link" href="GSSDPClient.html#gssdp-client-get-server-id" title="gssdp_client_get_server_id ()">gssdp_client_get_server_id</a>          (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
56 const <span class="returnvalue">char</span> *        <a class="link" href="GSSDPClient.html#gssdp-client-get-interface" title="gssdp_client_get_interface ()">gssdp_client_get_interface</a>          (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
57 const <span class="returnvalue">char</span> *        <a class="link" href="GSSDPClient.html#gssdp-client-get-host-ip" title="gssdp_client_get_host_ip ()">gssdp_client_get_host_ip</a>            (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
58 <span class="returnvalue">void</span>                <a class="link" href="GSSDPClient.html#gssdp-client-set-network" title="gssdp_client_set_network ()">gssdp_client_set_network</a>            (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>,
59                                                          <em class="parameter"><code>const <span class="type">char</span> *network</code></em>);
60 const <span class="returnvalue">char</span> *        <a class="link" href="GSSDPClient.html#gssdp-client-get-network" title="gssdp_client_get_network ()">gssdp_client_get_network</a>            (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
61 <span class="returnvalue">gboolean</span>            <a class="link" href="GSSDPClient.html#gssdp-client-get-active" title="gssdp_client_get_active ()">gssdp_client_get_active</a>             (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
62 </pre>
63 </div>
64 <div class="refsect1">
65 <a name="GSSDPClient.object-hierarchy"></a><h2>Object Hierarchy</h2>
66 <pre class="synopsis">
67   GObject
68    +----GSSDPClient
69 </pre>
70 </div>
71 <div class="refsect1">
72 <a name="GSSDPClient.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
73 <p>
74 GSSDPClient implements
75  GInitable.</p>
76 </div>
77 <div class="refsect1">
78 <a name="GSSDPClient.properties"></a><h2>Properties</h2>
79 <pre class="synopsis">
80   "<a class="link" href="GSSDPClient.html#GSSDPClient--active" title='The "active" property'>active</a>"                   <span class="type">gboolean</span>              : Read / Write
81   "<a class="link" href="GSSDPClient.html#GSSDPClient--host-ip" title='The "host-ip" property'>host-ip</a>"                  <span class="type">gchar</span>*                : Read
82   "<a class="link" href="GSSDPClient.html#GSSDPClient--interface" title='The "interface" property'>interface</a>"                <span class="type">gchar</span>*                : Read / Write / Construct Only
83   "<a class="link" href="GSSDPClient.html#GSSDPClient--main-context" title='The "main-context" property'>main-context</a>"             <span class="type">gpointer</span>              : Read / Write / Construct Only
84   "<a class="link" href="GSSDPClient.html#GSSDPClient--network" title='The "network" property'>network</a>"                  <span class="type">gchar</span>*                : Read / Write / Construct
85   "<a class="link" href="GSSDPClient.html#GSSDPClient--server-id" title='The "server-id" property'>server-id</a>"                <span class="type">gchar</span>*                : Read / Write
86 </pre>
87 </div>
88 <div class="refsect1">
89 <a name="GSSDPClient.signals"></a><h2>Signals</h2>
90 <pre class="synopsis">
91   "<a class="link" href="GSSDPClient.html#GSSDPClient-message-received" title='The "message-received" signal'>message-received</a>"                               : <code class="literal">Run Last</code>
92 </pre>
93 </div>
94 <div class="refsect1">
95 <a name="GSSDPClient.description"></a><h2>Description</h2>
96 <p>
97 <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> wraps the SSDP "bus" as used by both <a class="link" href="GSSDPResourceBrowser.html" title="GSSDPResourceBrowser"><span class="type">GSSDPResourceBrowser</span></a>
98 and <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>.
99 </p>
100 </div>
101 <div class="refsect1">
102 <a name="GSSDPClient.details"></a><h2>Details</h2>
103 <div class="refsect2">
104 <a name="GSSDPClient-struct"></a><h3>struct GSSDPClient</h3>
105 <pre class="programlisting">struct GSSDPClient;</pre>
106 <p>
107 </p>
108 </div>
109 <hr>
110 <div class="refsect2">
111 <a name="gssdp-client-new"></a><h3>gssdp_client_new ()</h3>
112 <pre class="programlisting"><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="returnvalue">GSSDPClient</span></a> *       gssdp_client_new                    (<em class="parameter"><code><span class="type">GMainContext</span> *main_context</code></em>,
113                                                          <em class="parameter"><code>const <span class="type">char</span> *iface</code></em>,
114                                                          <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
117 <tbody>
118 <tr>
119 <td><p><span class="term"><em class="parameter"><code>main_context</code></em> :</span></p></td>
120 <td>Deprecated: 0.11.2: Always set to NULL. If you want to
121 specify a context use <code class="function">g_main_context_push_thread_default()</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
122 </td>
123 </tr>
124 <tr>
125 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
126 <td>The name of the network interface, or <code class="literal">NULL</code> for auto-detection.</td>
127 </tr>
128 <tr>
129 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
130 <td>Location to store error, or NULL</td>
131 </tr>
132 <tr>
133 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
134 <td>A new <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> object.</td>
135 </tr>
136 </tbody>
137 </table></div>
138 </div>
139 <hr>
140 <div class="refsect2">
141 <a name="gssdp-client-get-main-context"></a><h3>gssdp_client_get_main_context ()</h3>
142 <pre class="programlisting"><span class="returnvalue">GMainContext</span> *      gssdp_client_get_main_context       (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
143 <p>
144 </p>
145 </div>
146 <hr>
147 <div class="refsect2">
148 <a name="gssdp-client-set-server-id"></a><h3>gssdp_client_set_server_id ()</h3>
149 <pre class="programlisting"><span class="returnvalue">void</span>                gssdp_client_set_server_id          (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>,
150                                                          <em class="parameter"><code>const <span class="type">char</span> *server_id</code></em>);</pre>
151 <p>
152 Sets the server ID of <em class="parameter"><code>client</code></em> to <em class="parameter"><code>server_id</code></em>.
153 </p>
154 <div class="variablelist"><table border="0">
155 <col align="left" valign="top">
156 <tbody>
157 <tr>
158 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
159 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
160 </td>
161 </tr>
162 <tr>
163 <td><p><span class="term"><em class="parameter"><code>server_id</code></em> :</span></p></td>
164 <td>The server ID</td>
165 </tr>
166 </tbody>
167 </table></div>
168 </div>
169 <hr>
170 <div class="refsect2">
171 <a name="gssdp-client-get-server-id"></a><h3>gssdp_client_get_server_id ()</h3>
172 <pre class="programlisting">const <span class="returnvalue">char</span> *        gssdp_client_get_server_id          (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
173 <div class="variablelist"><table border="0">
174 <col align="left" valign="top">
175 <tbody>
176 <tr>
177 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
178 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
179 </td>
180 </tr>
181 <tr>
182 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
183 <td>The server ID.</td>
184 </tr>
185 </tbody>
186 </table></div>
187 </div>
188 <hr>
189 <div class="refsect2">
190 <a name="gssdp-client-get-interface"></a><h3>gssdp_client_get_interface ()</h3>
191 <pre class="programlisting">const <span class="returnvalue">char</span> *        gssdp_client_get_interface          (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
192 <p>
193 Get the name of the network interface associated to <em class="parameter"><code>client</code></em>.
194 </p>
195 <div class="variablelist"><table border="0">
196 <col align="left" valign="top">
197 <tbody>
198 <tr>
199 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
200 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
201 </td>
202 </tr>
203 <tr>
204 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
205 <td>The network interface name. This string should not be freed.</td>
206 </tr>
207 </tbody>
208 </table></div>
209 </div>
210 <hr>
211 <div class="refsect2">
212 <a name="gssdp-client-get-host-ip"></a><h3>gssdp_client_get_host_ip ()</h3>
213 <pre class="programlisting">const <span class="returnvalue">char</span> *        gssdp_client_get_host_ip            (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
214 <p>
215 Get the IP address we advertise ourselves as using.
216 </p>
217 <div class="variablelist"><table border="0">
218 <col align="left" valign="top">
219 <tbody>
220 <tr>
221 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
222 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
223 </td>
224 </tr>
225 <tr>
226 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
227 <td>The IP address. This string should not be freed.</td>
228 </tr>
229 </tbody>
230 </table></div>
231 </div>
232 <hr>
233 <div class="refsect2">
234 <a name="gssdp-client-set-network"></a><h3>gssdp_client_set_network ()</h3>
235 <pre class="programlisting"><span class="returnvalue">void</span>                gssdp_client_set_network            (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>,
236                                                          <em class="parameter"><code>const <span class="type">char</span> *network</code></em>);</pre>
237 <p>
238 Sets the network identification of <em class="parameter"><code>client</code></em> to <em class="parameter"><code>network</code></em>.
239 </p>
240 <div class="variablelist"><table border="0">
241 <col align="left" valign="top">
242 <tbody>
243 <tr>
244 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
245 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
246 </td>
247 </tr>
248 <tr>
249 <td><p><span class="term"><em class="parameter"><code>network</code></em> :</span></p></td>
250 <td>The string identifying the network</td>
251 </tr>
252 </tbody>
253 </table></div>
254 </div>
255 <hr>
256 <div class="refsect2">
257 <a name="gssdp-client-get-network"></a><h3>gssdp_client_get_network ()</h3>
258 <pre class="programlisting">const <span class="returnvalue">char</span> *        gssdp_client_get_network            (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
259 <p>
260 Get the network this client is associated with.
261 </p>
262 <div class="variablelist"><table border="0">
263 <col align="left" valign="top">
264 <tbody>
265 <tr>
266 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
267 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
268 </td>
269 </tr>
270 <tr>
271 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
272 <td>The network identification. This string should not be freed.</td>
273 </tr>
274 </tbody>
275 </table></div>
276 </div>
277 <hr>
278 <div class="refsect2">
279 <a name="gssdp-client-get-active"></a><h3>gssdp_client_get_active ()</h3>
280 <pre class="programlisting"><span class="returnvalue">gboolean</span>            gssdp_client_get_active             (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
281 <div class="variablelist"><table border="0">
282 <col align="left" valign="top">
283 <tbody>
284 <tr>
285 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
286 <td>A <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>
287 </td>
288 </tr>
289 <tr>
290 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
291 <td>
292 <code class="literal">TRUE</code> if <em class="parameter"><code>client</code></em> is active, <code class="literal">FALSE</code> otherwise.</td>
293 </tr>
294 </tbody>
295 </table></div>
296 </div>
297 </div>
298 <div class="refsect1">
299 <a name="GSSDPClient.property-details"></a><h2>Property Details</h2>
300 <div class="refsect2">
301 <a name="GSSDPClient--active"></a><h3>The <code class="literal">"active"</code> property</h3>
302 <pre class="programlisting">  "active"                   <span class="type">gboolean</span>              : Read / Write</pre>
303 <p>
304 Whether this client is active or not (passive). When active
305 (default), the client sends messages on the network, otherwise
306 not. In most cases, you don't want to touch this property.
307 </p>
308 <p>Default value: TRUE</p>
309 </div>
310 <hr>
311 <div class="refsect2">
312 <a name="GSSDPClient--host-ip"></a><h3>The <code class="literal">"host-ip"</code> property</h3>
313 <pre class="programlisting">  "host-ip"                  <span class="type">gchar</span>*                : Read</pre>
314 <p>
315 The IP address of the assoicated network interface.
316 </p>
317 <p>Default value: NULL</p>
318 </div>
319 <hr>
320 <div class="refsect2">
321 <a name="GSSDPClient--interface"></a><h3>The <code class="literal">"interface"</code> property</h3>
322 <pre class="programlisting">  "interface"                <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
323 <p>
324 The name of the network interface this client is associated with.
325 Set to NULL to autodetect.
326 </p>
327 <p>Default value: NULL</p>
328 </div>
329 <hr>
330 <div class="refsect2">
331 <a name="GSSDPClient--main-context"></a><h3>The <code class="literal">"main-context"</code> property</h3>
332 <pre class="programlisting">  "main-context"             <span class="type">gpointer</span>              : Read / Write / Construct Only</pre>
333 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
334 <h3 class="title">Warning</h3>
335 <p><code class="literal">GSSDPClient:main-context</code> has been deprecated since version 0.11.2 and should not be used in newly-written code. Use <code class="function">g_main_context_push_thread_default()</code>.</p>
336 </div>
337 <p>
338 The <span class="type">GMainContext</span> to use. Set to NULL to use the default.
339 </p>
340 </div>
341 <hr>
342 <div class="refsect2">
343 <a name="GSSDPClient--network"></a><h3>The <code class="literal">"network"</code> property</h3>
344 <pre class="programlisting">  "network"                  <span class="type">gchar</span>*                : Read / Write / Construct</pre>
345 <p>
346 The network this client is currently connected to. You could set this
347 to anything you want to identify the network this client is
348 associated with. If you are using <a href="../gupnp/GUPnPContextManager.html"><span class="type">GUPnPContextManager</span></a> and associated
349 interface is a WiFi interface, this property is set to the ESSID of
350 the network. Otherwise, expect this to be the network IP address by
351 default.
352 </p>
353 <p>Default value: NULL</p>
354 </div>
355 <hr>
356 <div class="refsect2">
357 <a name="GSSDPClient--server-id"></a><h3>The <code class="literal">"server-id"</code> property</h3>
358 <pre class="programlisting">  "server-id"                <span class="type">gchar</span>*                : Read / Write</pre>
359 <p>
360 The SSDP server's identifier.
361 </p>
362 <p>Default value: NULL</p>
363 </div>
364 </div>
365 <div class="refsect1">
366 <a name="GSSDPClient.signal-details"></a><h2>Signal Details</h2>
367 <div class="refsect2">
368 <a name="GSSDPClient-message-received"></a><h3>The <code class="literal">"message-received"</code> signal</h3>
369 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *arg0,
370                                                         <span class="type">gchar</span>       *arg1,
371                                                         <span class="type">guint</span>        arg2,
372                                                         <span class="type">gint</span>         arg3,
373                                                         <span class="type">gpointer</span>     arg4,
374                                                         <span class="type">gpointer</span>     user_data)      : <code class="literal">Run Last</code></pre>
375 <p>
376 Internal signal.
377 </p>
378 <div class="variablelist"><table border="0">
379 <col align="left" valign="top">
380 <tbody><tr>
381 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
382 <td>user data set when the signal handler was connected.</td>
383 </tr></tbody>
384 </table></div>
385 <p class="stability">Stability Level: Private</p>
386 </div>
387 </div>
388 </div>
389 <div class="footer">
390 <hr>
391           Generated by GTK-Doc V1.18</div>
392 </body>
393 </html>