Imported Upstream version 0.20.12
[profile/ivi/GUPnP.git] / doc / html / GUPnPService.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>GUPnP Reference Manual: GUPnPService</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="GUPnP Reference Manual">
8 <link rel="up" href="api-device-impl.html" title="Device Implementation">
9 <link rel="prev" href="GUPnPRootDevice.html" title="GUPnPRootDevice">
10 <link rel="next" href="api-context.html" title="Network context handling">
11 <meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
18                   <a href="#GUPnPService.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19                   <a href="#GUPnPService.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
20                   <a href="#GUPnPService.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 
21                   <a href="#GUPnPService.signals" class="shortcut">Signals</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="api-device-impl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="GUPnPRootDevice.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="api-context.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="GUPnPService"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="GUPnPService.top_of_page"></a>GUPnPService</span></h2>
33 <p>GUPnPService — Class for service implementations.</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="GUPnPService.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_return">
42 <col class="functions_name">
43 </colgroup>
44 <tbody>
45 <tr>
46 <td class="function_type">const <span class="returnvalue">char</span> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="GUPnPService.html#gupnp-service-action-get-name" title="gupnp_service_action_get_name ()">gupnp_service_action_get_name</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
55 </td>
56 <td class="function_name">
57 <a class="link" href="GUPnPService.html#gupnp-service-action-get-locales" title="gupnp_service_action_get_locales ()">gupnp_service_action_get_locales</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <span class="returnvalue">void</span>
63 </td>
64 <td class="function_name">
65 <a class="link" href="GUPnPService.html#gupnp-service-action-get" title="gupnp_service_action_get ()">gupnp_service_action_get</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <span class="returnvalue">void</span>
71 </td>
72 <td class="function_name">
73 <a class="link" href="GUPnPService.html#gupnp-service-action-get-valist" title="gupnp_service_action_get_valist ()">gupnp_service_action_get_valist</a> <span class="c_punctuation">()</span>
74 </td>
75 </tr>
76 <tr>
77 <td class="function_type">
78 <span class="returnvalue">void</span>
79 </td>
80 <td class="function_name">
81 <a class="link" href="GUPnPService.html#gupnp-service-action-get-value" title="gupnp_service_action_get_value ()">gupnp_service_action_get_value</a> <span class="c_punctuation">()</span>
82 </td>
83 </tr>
84 <tr>
85 <td class="function_type">
86 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *
87 </td>
88 <td class="function_name">
89 <a class="link" href="GUPnPService.html#gupnp-service-action-get-gvalue" title="gupnp_service_action_get_gvalue ()">gupnp_service_action_get_gvalue</a> <span class="c_punctuation">()</span>
90 </td>
91 </tr>
92 <tr>
93 <td class="function_type">
94 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
95 </td>
96 <td class="function_name">
97 <a class="link" href="GUPnPService.html#gupnp-service-action-get-values" title="gupnp_service_action_get_values ()">gupnp_service_action_get_values</a> <span class="c_punctuation">()</span>
98 </td>
99 </tr>
100 <tr>
101 <td class="function_type">
102 <span class="returnvalue">void</span>
103 </td>
104 <td class="function_name">
105 <a class="link" href="GUPnPService.html#gupnp-service-action-set" title="gupnp_service_action_set ()">gupnp_service_action_set</a> <span class="c_punctuation">()</span>
106 </td>
107 </tr>
108 <tr>
109 <td class="function_type">
110 <span class="returnvalue">void</span>
111 </td>
112 <td class="function_name">
113 <a class="link" href="GUPnPService.html#gupnp-service-action-set-valist" title="gupnp_service_action_set_valist ()">gupnp_service_action_set_valist</a> <span class="c_punctuation">()</span>
114 </td>
115 </tr>
116 <tr>
117 <td class="function_type">
118 <span class="returnvalue">void</span>
119 </td>
120 <td class="function_name">
121 <a class="link" href="GUPnPService.html#gupnp-service-action-set-value" title="gupnp_service_action_set_value ()">gupnp_service_action_set_value</a> <span class="c_punctuation">()</span>
122 </td>
123 </tr>
124 <tr>
125 <td class="function_type">
126 <span class="returnvalue">void</span>
127 </td>
128 <td class="function_name">
129 <a class="link" href="GUPnPService.html#gupnp-service-action-set-values" title="gupnp_service_action_set_values ()">gupnp_service_action_set_values</a> <span class="c_punctuation">()</span>
130 </td>
131 </tr>
132 <tr>
133 <td class="function_type">
134 <span class="returnvalue">void</span>
135 </td>
136 <td class="function_name">
137 <a class="link" href="GUPnPService.html#gupnp-service-action-return" title="gupnp_service_action_return ()">gupnp_service_action_return</a> <span class="c_punctuation">()</span>
138 </td>
139 </tr>
140 <tr>
141 <td class="function_type">
142 <span class="returnvalue">void</span>
143 </td>
144 <td class="function_name">
145 <a class="link" href="GUPnPService.html#gupnp-service-action-return-error" title="gupnp_service_action_return_error ()">gupnp_service_action_return_error</a> <span class="c_punctuation">()</span>
146 </td>
147 </tr>
148 <tr>
149 <td class="function_type">
150 <a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupMessage.html"><span class="returnvalue">SoupMessage</span></a> *
151 </td>
152 <td class="function_name">
153 <a class="link" href="GUPnPService.html#gupnp-service-action-get-message" title="gupnp_service_action_get_message ()">gupnp_service_action_get_message</a> <span class="c_punctuation">()</span>
154 </td>
155 </tr>
156 <tr>
157 <td class="function_type">
158 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
159 </td>
160 <td class="function_name">
161 <a class="link" href="GUPnPService.html#gupnp-service-action-get-argument-count" title="gupnp_service_action_get_argument_count ()">gupnp_service_action_get_argument_count</a> <span class="c_punctuation">()</span>
162 </td>
163 </tr>
164 <tr>
165 <td class="function_type">
166 <span class="returnvalue">void</span>
167 </td>
168 <td class="function_name">
169 <a class="link" href="GUPnPService.html#gupnp-service-notify" title="gupnp_service_notify ()">gupnp_service_notify</a> <span class="c_punctuation">()</span>
170 </td>
171 </tr>
172 <tr>
173 <td class="function_type">
174 <span class="returnvalue">void</span>
175 </td>
176 <td class="function_name">
177 <a class="link" href="GUPnPService.html#gupnp-service-notify-valist" title="gupnp_service_notify_valist ()">gupnp_service_notify_valist</a> <span class="c_punctuation">()</span>
178 </td>
179 </tr>
180 <tr>
181 <td class="function_type">
182 <span class="returnvalue">void</span>
183 </td>
184 <td class="function_name">
185 <a class="link" href="GUPnPService.html#gupnp-service-notify-value" title="gupnp_service_notify_value ()">gupnp_service_notify_value</a> <span class="c_punctuation">()</span>
186 </td>
187 </tr>
188 <tr>
189 <td class="function_type">
190 <span class="returnvalue">void</span>
191 </td>
192 <td class="function_name">
193 <a class="link" href="GUPnPService.html#gupnp-service-freeze-notify" title="gupnp_service_freeze_notify ()">gupnp_service_freeze_notify</a> <span class="c_punctuation">()</span>
194 </td>
195 </tr>
196 <tr>
197 <td class="function_type">
198 <span class="returnvalue">void</span>
199 </td>
200 <td class="function_name">
201 <a class="link" href="GUPnPService.html#gupnp-service-thaw-notify" title="gupnp_service_thaw_notify ()">gupnp_service_thaw_notify</a> <span class="c_punctuation">()</span>
202 </td>
203 </tr>
204 <tr>
205 <td class="function_type">
206 <span class="returnvalue">void</span>
207 </td>
208 <td class="function_name">
209 <a class="link" href="GUPnPService.html#gupnp-service-signals-autoconnect" title="gupnp_service_signals_autoconnect ()">gupnp_service_signals_autoconnect</a> <span class="c_punctuation">()</span>
210 </td>
211 </tr>
212 </tbody>
213 </table></div>
214 </div>
215 <div class="refsect1">
216 <a name="GUPnPService.properties"></a><h2>Properties</h2>
217 <div class="informaltable"><table border="0">
218 <colgroup>
219 <col width="150px" class="properties_type">
220 <col width="300px" class="properties_name">
221 <col width="200px" class="properties_flags">
222 </colgroup>
223 <tbody><tr>
224 <td class="property_type">
225 <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *</td>
226 <td class="property_name"><a class="link" href="GUPnPService.html#GUPnPService--root-device" title="The “root-device” property">root-device</a></td>
227 <td class="property_flags">Read / Write / Construct Only</td>
228 </tr></tbody>
229 </table></div>
230 </div>
231 <div class="refsect1">
232 <a name="GUPnPService.signals"></a><h2>Signals</h2>
233 <div class="informaltable"><table border="0">
234 <colgroup>
235 <col width="150px" class="signals_return">
236 <col width="300px" class="signals_name">
237 <col width="200px" class="signals_flags">
238 </colgroup>
239 <tbody>
240 <tr>
241 <td class="signal_type"><span class="returnvalue">void</span></td>
242 <td class="signal_name"><a class="link" href="GUPnPService.html#GUPnPService-action-invoked" title="The “action-invoked” signal">action-invoked</a></td>
243 <td class="signal_flags">Has Details</td>
244 </tr>
245 <tr>
246 <td class="signal_type"><span class="returnvalue">void</span></td>
247 <td class="signal_name"><a class="link" href="GUPnPService.html#GUPnPService-notify-failed" title="The “notify-failed” signal">notify-failed</a></td>
248 <td class="signal_flags">Run Last</td>
249 </tr>
250 <tr>
251 <td class="signal_type"><span class="returnvalue">void</span></td>
252 <td class="signal_name"><a class="link" href="GUPnPService.html#GUPnPService-query-variable" title="The “query-variable” signal">query-variable</a></td>
253 <td class="signal_flags">Has Details</td>
254 </tr>
255 </tbody>
256 </table></div>
257 </div>
258 <a name="GUPnPServiceAction"></a><div class="refsect1">
259 <a name="GUPnPService.other"></a><h2>Types and Values</h2>
260 <div class="informaltable"><table width="100%" border="0">
261 <colgroup>
262 <col width="150px" class="name">
263 <col class="description">
264 </colgroup>
265 <tbody>
266 <tr>
267 <td class="datatype_keyword"> </td>
268 <td class="function_name"><a class="link" href="GUPnPService.html#GUPnPService-struct" title="GUPnPService">GUPnPService</a></td>
269 </tr>
270 <tr>
271 <td class="datatype_keyword"> </td>
272 <td class="function_name"><a class="link" href="GUPnPService.html#GUPnPServiceAction-struct" title="GUPnPServiceAction">GUPnPServiceAction</a></td>
273 </tr>
274 </tbody>
275 </table></div>
276 </div>
277 <div class="refsect1">
278 <a name="GUPnPService.object-hierarchy"></a><h2>Object Hierarchy</h2>
279 <pre class="screen">    GBoxed
280     <span class="lineart">╰──</span> GUPnPServiceAction
281     <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
282     <span class="lineart">╰──</span> <a class="link" href="GUPnPServiceInfo.html" title="GUPnPServiceInfo">GUPnPServiceInfo</a>
283         <span class="lineart">╰──</span> GUPnPService
284 </pre>
285 </div>
286 <div class="refsect1">
287 <a name="GUPnPService.description"></a><h2>Description</h2>
288 <p><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> allows for handling incoming actions and state variable
289 notification. <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> implements the <a class="link" href="GUPnPServiceInfo.html" title="GUPnPServiceInfo"><span class="type">GUPnPServiceInfo</span></a> interface.</p>
290 </div>
291 <div class="refsect1">
292 <a name="GUPnPService.functions_details"></a><h2>Functions</h2>
293 <div class="refsect2">
294 <a name="gupnp-service-action-get-name"></a><h3>gupnp_service_action_get_name ()</h3>
295 <pre class="programlisting">const <span class="returnvalue">char</span> *
296 gupnp_service_action_get_name (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);</pre>
297 <p>Get the name of <em class="parameter"><code>action</code></em>
298 .</p>
299 <div class="refsect3">
300 <a name="id-1.3.4.4.10.2.5"></a><h4>Parameters</h4>
301 <div class="informaltable"><table width="100%" border="0">
302 <colgroup>
303 <col width="150px" class="parameters_name">
304 <col class="parameters_description">
305 <col width="200px" class="parameters_annotations">
306 </colgroup>
307 <tbody><tr>
308 <td class="parameter_name"><p>action</p></td>
309 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
310 <td class="parameter_annotations"> </td>
311 </tr></tbody>
312 </table></div>
313 </div>
314 <div class="refsect3">
315 <a name="id-1.3.4.4.10.2.6"></a><h4>Returns</h4>
316 <p> The name of <em class="parameter"><code>action</code></em>
317 </p>
318 <p></p>
319 </div>
320 </div>
321 <hr>
322 <div class="refsect2">
323 <a name="gupnp-service-action-get-locales"></a><h3>gupnp_service_action_get_locales ()</h3>
324 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
325 gupnp_service_action_get_locales (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);</pre>
326 <p>Get an ordered (preferred first) <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of locales preferred by
327 the client. Free list and elements after use.</p>
328 <div class="refsect3">
329 <a name="id-1.3.4.4.10.3.5"></a><h4>Parameters</h4>
330 <div class="informaltable"><table width="100%" border="0">
331 <colgroup>
332 <col width="150px" class="parameters_name">
333 <col class="parameters_description">
334 <col width="200px" class="parameters_annotations">
335 </colgroup>
336 <tbody><tr>
337 <td class="parameter_name"><p>action</p></td>
338 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
339 <td class="parameter_annotations"> </td>
340 </tr></tbody>
341 </table></div>
342 </div>
343 <div class="refsect3">
344 <a name="id-1.3.4.4.10.3.6"></a><h4>Returns</h4>
345 <p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <span class="type">char</span>*
346 locale names. </p>
347 <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
348 </div>
349 </div>
350 <hr>
351 <div class="refsect2">
352 <a name="gupnp-service-action-get"></a><h3>gupnp_service_action_get ()</h3>
353 <pre class="programlisting"><span class="returnvalue">void</span>
354 gupnp_service_action_get (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
355                           <em class="parameter"><code>...</code></em>);</pre>
356 <p>Retrieves the specified action arguments.</p>
357 <div class="refsect3">
358 <a name="id-1.3.4.4.10.4.5"></a><h4>Parameters</h4>
359 <div class="informaltable"><table width="100%" border="0">
360 <colgroup>
361 <col width="150px" class="parameters_name">
362 <col class="parameters_description">
363 <col width="200px" class="parameters_annotations">
364 </colgroup>
365 <tbody>
366 <tr>
367 <td class="parameter_name"><p>action</p></td>
368 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
369 <td class="parameter_annotations"> </td>
370 </tr>
371 <tr>
372 <td class="parameter_name"><p>...</p></td>
373 <td class="parameter_description"><p>tuples of argument name, argument type, and argument value
374 location, terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
375 <td class="parameter_annotations"> </td>
376 </tr>
377 </tbody>
378 </table></div>
379 </div>
380 </div>
381 <hr>
382 <div class="refsect2">
383 <a name="gupnp-service-action-get-valist"></a><h3>gupnp_service_action_get_valist ()</h3>
384 <pre class="programlisting"><span class="returnvalue">void</span>
385 gupnp_service_action_get_valist (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
386                                  <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
387 <p>See <a class="link" href="GUPnPService.html#gupnp-service-action-get" title="gupnp_service_action_get ()"><code class="function">gupnp_service_action_get()</code></a>; this version takes a va_list for
388 use by language bindings.</p>
389 <div class="refsect3">
390 <a name="id-1.3.4.4.10.5.5"></a><h4>Parameters</h4>
391 <div class="informaltable"><table width="100%" border="0">
392 <colgroup>
393 <col width="150px" class="parameters_name">
394 <col class="parameters_description">
395 <col width="200px" class="parameters_annotations">
396 </colgroup>
397 <tbody>
398 <tr>
399 <td class="parameter_name"><p>action</p></td>
400 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
401 <td class="parameter_annotations"> </td>
402 </tr>
403 <tr>
404 <td class="parameter_name"><p>var_args</p></td>
405 <td class="parameter_description"><p>va_list of tuples of argument name, argument type, and argument
406 value location.</p></td>
407 <td class="parameter_annotations"> </td>
408 </tr>
409 </tbody>
410 </table></div>
411 </div>
412 </div>
413 <hr>
414 <div class="refsect2">
415 <a name="gupnp-service-action-get-value"></a><h3>gupnp_service_action_get_value ()</h3>
416 <pre class="programlisting"><span class="returnvalue">void</span>
417 gupnp_service_action_get_value (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
418                                 <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
419                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
420 <p>Retrieves the value of <em class="parameter"><code>argument</code></em>
421  into <em class="parameter"><code>value</code></em>
422 .</p>
423 <div class="refsect3">
424 <a name="id-1.3.4.4.10.6.5"></a><h4>Parameters</h4>
425 <div class="informaltable"><table width="100%" border="0">
426 <colgroup>
427 <col width="150px" class="parameters_name">
428 <col class="parameters_description">
429 <col width="200px" class="parameters_annotations">
430 </colgroup>
431 <tbody>
432 <tr>
433 <td class="parameter_name"><p>action</p></td>
434 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
435 <td class="parameter_annotations"> </td>
436 </tr>
437 <tr>
438 <td class="parameter_name"><p>argument</p></td>
439 <td class="parameter_description"><p>The name of the argument to retrieve</p></td>
440 <td class="parameter_annotations"> </td>
441 </tr>
442 <tr>
443 <td class="parameter_name"><p>value</p></td>
444 <td class="parameter_description"><p>The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to store the value of the argument, initialized
445 to the correct type. </p></td>
446 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
447 </tr>
448 </tbody>
449 </table></div>
450 </div>
451 </div>
452 <hr>
453 <div class="refsect2">
454 <a name="gupnp-service-action-get-gvalue"></a><h3>gupnp_service_action_get_gvalue ()</h3>
455 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *
456 gupnp_service_action_get_gvalue (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
457                                  <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
458                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
459 <p>Retrieves the value of <em class="parameter"><code>argument</code></em>
460  into a GValue of type <em class="parameter"><code>type</code></em>
461  and returns it.
462 The method exists only and only to satify PyGI, please use
463 <a class="link" href="GUPnPService.html#gupnp-service-action-get-value" title="gupnp_service_action_get_value ()"><code class="function">gupnp_service_action_get_value()</code></a> and ignore this if possible.</p>
464 <div class="refsect3">
465 <a name="id-1.3.4.4.10.7.5"></a><h4>Parameters</h4>
466 <div class="informaltable"><table width="100%" border="0">
467 <colgroup>
468 <col width="150px" class="parameters_name">
469 <col class="parameters_description">
470 <col width="200px" class="parameters_annotations">
471 </colgroup>
472 <tbody>
473 <tr>
474 <td class="parameter_name"><p>action</p></td>
475 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
476 <td class="parameter_annotations"> </td>
477 </tr>
478 <tr>
479 <td class="parameter_name"><p>argument</p></td>
480 <td class="parameter_description"><p>The name of the argument to retrieve</p></td>
481 <td class="parameter_annotations"> </td>
482 </tr>
483 <tr>
484 <td class="parameter_name"><p>type</p></td>
485 <td class="parameter_description"><p>The type of argument to retrieve</p></td>
486 <td class="parameter_annotations"> </td>
487 </tr>
488 </tbody>
489 </table></div>
490 </div>
491 <div class="refsect3">
492 <a name="id-1.3.4.4.10.7.6"></a><h4>Returns</h4>
493 <p> Value as <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> associated with <em class="parameter"><code>action</code></em>
494 .
495 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a> and <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Slices.html#g-slice-free"><code class="function">g_slice_free()</code></a> it after usage. </p>
496 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
497 </div>
498 <p class="since">Since 0.13.3</p>
499 </div>
500 <hr>
501 <div class="refsect2">
502 <a name="gupnp-service-action-get-values"></a><h3>gupnp_service_action_get_values ()</h3>
503 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
504 gupnp_service_action_get_values (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
505                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *arg_names</code></em>,
506                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *arg_types</code></em>);</pre>
507 <p>A variant of <a class="link" href="GUPnPService.html#gupnp-service-action-get" title="gupnp_service_action_get ()"><span class="type">gupnp_service_action_get</span></a> that uses <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> instead of varargs.</p>
508 <div class="refsect3">
509 <a name="id-1.3.4.4.10.8.5"></a><h4>Parameters</h4>
510 <div class="informaltable"><table width="100%" border="0">
511 <colgroup>
512 <col width="150px" class="parameters_name">
513 <col class="parameters_description">
514 <col width="200px" class="parameters_annotations">
515 </colgroup>
516 <tbody>
517 <tr>
518 <td class="parameter_name"><p>action</p></td>
519 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
520 <td class="parameter_annotations"> </td>
521 </tr>
522 <tr>
523 <td class="parameter_name"><p>arg_names</p></td>
524 <td class="parameter_description"><p>(element-type utf8) : A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of argument names as string</p></td>
525 <td class="parameter_annotations"> </td>
526 </tr>
527 <tr>
528 <td class="parameter_name"><p>arg_types</p></td>
529 <td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of argument types as <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>. </p></td>
530 <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GType]</span></td>
531 </tr>
532 </tbody>
533 </table></div>
534 </div>
535 <div class="refsect3">
536 <a name="id-1.3.4.4.10.8.6"></a><h4>Returns</h4>
537 <p> The values as <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
538 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>. <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a> the returned list and <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a> and <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Slices.html#g-slice-free"><code class="function">g_slice_free()</code></a>
539 each element. </p>
540 <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GValue][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
541 </div>
542 <p class="since">Since 0.13.3</p>
543 </div>
544 <hr>
545 <div class="refsect2">
546 <a name="gupnp-service-action-set"></a><h3>gupnp_service_action_set ()</h3>
547 <pre class="programlisting"><span class="returnvalue">void</span>
548 gupnp_service_action_set (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
549                           <em class="parameter"><code>...</code></em>);</pre>
550 <p>Sets the specified action return values.</p>
551 <div class="refsect3">
552 <a name="id-1.3.4.4.10.9.5"></a><h4>Parameters</h4>
553 <div class="informaltable"><table width="100%" border="0">
554 <colgroup>
555 <col width="150px" class="parameters_name">
556 <col class="parameters_description">
557 <col width="200px" class="parameters_annotations">
558 </colgroup>
559 <tbody>
560 <tr>
561 <td class="parameter_name"><p>action</p></td>
562 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
563 <td class="parameter_annotations"> </td>
564 </tr>
565 <tr>
566 <td class="parameter_name"><p>...</p></td>
567 <td class="parameter_description"><p>tuples of return value name, return value type, and
568 actual return value, terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
569 <td class="parameter_annotations"> </td>
570 </tr>
571 </tbody>
572 </table></div>
573 </div>
574 </div>
575 <hr>
576 <div class="refsect2">
577 <a name="gupnp-service-action-set-valist"></a><h3>gupnp_service_action_set_valist ()</h3>
578 <pre class="programlisting"><span class="returnvalue">void</span>
579 gupnp_service_action_set_valist (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
580                                  <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
581 <p>See <a class="link" href="GUPnPService.html#gupnp-service-action-set" title="gupnp_service_action_set ()"><code class="function">gupnp_service_action_set()</code></a>; this version takes a va_list for
582 use by language bindings.</p>
583 <div class="refsect3">
584 <a name="id-1.3.4.4.10.10.5"></a><h4>Parameters</h4>
585 <div class="informaltable"><table width="100%" border="0">
586 <colgroup>
587 <col width="150px" class="parameters_name">
588 <col class="parameters_description">
589 <col width="200px" class="parameters_annotations">
590 </colgroup>
591 <tbody>
592 <tr>
593 <td class="parameter_name"><p>action</p></td>
594 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
595 <td class="parameter_annotations"> </td>
596 </tr>
597 <tr>
598 <td class="parameter_name"><p>var_args</p></td>
599 <td class="parameter_description"><p>va_list of tuples of return value name, return value type, and
600 actual return value.</p></td>
601 <td class="parameter_annotations"> </td>
602 </tr>
603 </tbody>
604 </table></div>
605 </div>
606 </div>
607 <hr>
608 <div class="refsect2">
609 <a name="gupnp-service-action-set-value"></a><h3>gupnp_service_action_set_value ()</h3>
610 <pre class="programlisting"><span class="returnvalue">void</span>
611 gupnp_service_action_set_value (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
612                                 <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
613                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
614 <p>Sets the value of <em class="parameter"><code>argument</code></em>
615  to <em class="parameter"><code>value</code></em>
616 .</p>
617 <div class="refsect3">
618 <a name="id-1.3.4.4.10.11.5"></a><h4>Parameters</h4>
619 <div class="informaltable"><table width="100%" border="0">
620 <colgroup>
621 <col width="150px" class="parameters_name">
622 <col class="parameters_description">
623 <col width="200px" class="parameters_annotations">
624 </colgroup>
625 <tbody>
626 <tr>
627 <td class="parameter_name"><p>action</p></td>
628 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
629 <td class="parameter_annotations"> </td>
630 </tr>
631 <tr>
632 <td class="parameter_name"><p>argument</p></td>
633 <td class="parameter_description"><p>The name of the return value to retrieve</p></td>
634 <td class="parameter_annotations"> </td>
635 </tr>
636 <tr>
637 <td class="parameter_name"><p>value</p></td>
638 <td class="parameter_description"><p>The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to store the return value</p></td>
639 <td class="parameter_annotations"> </td>
640 </tr>
641 </tbody>
642 </table></div>
643 </div>
644 </div>
645 <hr>
646 <div class="refsect2">
647 <a name="gupnp-service-action-set-values"></a><h3>gupnp_service_action_set_values ()</h3>
648 <pre class="programlisting"><span class="returnvalue">void</span>
649 gupnp_service_action_set_values (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
650                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *arg_names</code></em>,
651                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *arg_values</code></em>);</pre>
652 <p>Sets the specified action return values.</p>
653 <div class="refsect3">
654 <a name="id-1.3.4.4.10.12.5"></a><h4>Parameters</h4>
655 <div class="informaltable"><table width="100%" border="0">
656 <colgroup>
657 <col width="150px" class="parameters_name">
658 <col class="parameters_description">
659 <col width="200px" class="parameters_annotations">
660 </colgroup>
661 <tbody>
662 <tr>
663 <td class="parameter_name"><p>action</p></td>
664 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
665 <td class="parameter_annotations"> </td>
666 </tr>
667 <tr>
668 <td class="parameter_name"><p>arg_names</p></td>
669 <td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of argument names. </p></td>
670 <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
671 </tr>
672 <tr>
673 <td class="parameter_name"><p>arg_values</p></td>
674 <td class="parameter_description"><p> The <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of values (as
675 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValues</span></a>) that line up with <em class="parameter"><code>arg_names</code></em>
676 . </p></td>
677 <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GValue][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
678 </tr>
679 </tbody>
680 </table></div>
681 </div>
682 <p class="since">Since 0.13.3</p>
683 </div>
684 <hr>
685 <div class="refsect2">
686 <a name="gupnp-service-action-return"></a><h3>gupnp_service_action_return ()</h3>
687 <pre class="programlisting"><span class="returnvalue">void</span>
688 gupnp_service_action_return (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);</pre>
689 <p>Return succesfully.</p>
690 <div class="refsect3">
691 <a name="id-1.3.4.4.10.13.5"></a><h4>Parameters</h4>
692 <div class="informaltable"><table width="100%" border="0">
693 <colgroup>
694 <col width="150px" class="parameters_name">
695 <col class="parameters_description">
696 <col width="200px" class="parameters_annotations">
697 </colgroup>
698 <tbody><tr>
699 <td class="parameter_name"><p>action</p></td>
700 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
701 <td class="parameter_annotations"> </td>
702 </tr></tbody>
703 </table></div>
704 </div>
705 </div>
706 <hr>
707 <div class="refsect2">
708 <a name="gupnp-service-action-return-error"></a><h3>gupnp_service_action_return_error ()</h3>
709 <pre class="programlisting"><span class="returnvalue">void</span>
710 gupnp_service_action_return_error (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
711                                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> error_code</code></em>,
712                                    <em class="parameter"><code>const <span class="type">char</span> *error_description</code></em>);</pre>
713 <p>Return <em class="parameter"><code>error_code</code></em>
714 .</p>
715 <div class="refsect3">
716 <a name="id-1.3.4.4.10.14.5"></a><h4>Parameters</h4>
717 <div class="informaltable"><table width="100%" border="0">
718 <colgroup>
719 <col width="150px" class="parameters_name">
720 <col class="parameters_description">
721 <col width="200px" class="parameters_annotations">
722 </colgroup>
723 <tbody>
724 <tr>
725 <td class="parameter_name"><p>action</p></td>
726 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
727 <td class="parameter_annotations"> </td>
728 </tr>
729 <tr>
730 <td class="parameter_name"><p>error_code</p></td>
731 <td class="parameter_description"><p>The error code</p></td>
732 <td class="parameter_annotations"> </td>
733 </tr>
734 <tr>
735 <td class="parameter_name"><p>error_description</p></td>
736 <td class="parameter_description"><p>The error description, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error_code</code></em>
737 is
738 one of <a class="link" href="gupnp-Error-codes.html#GUPNP-CONTROL-ERROR-INVALID-ACTION:CAPS"><span class="type">GUPNP_CONTROL_ERROR_INVALID_ACTION</span></a>,
739 <a class="link" href="gupnp-Error-codes.html#GUPNP-CONTROL-ERROR-INVALID-ARGS:CAPS"><span class="type">GUPNP_CONTROL_ERROR_INVALID_ARGS</span></a>, <a class="link" href="gupnp-Error-codes.html#GUPNP-CONTROL-ERROR-OUT-OF-SYNC:CAPS"><span class="type">GUPNP_CONTROL_ERROR_OUT_OF_SYNC</span></a> or
740 <a class="link" href="gupnp-Error-codes.html#GUPNP-CONTROL-ERROR-ACTION-FAILED:CAPS"><span class="type">GUPNP_CONTROL_ERROR_ACTION_FAILED</span></a>, in which case a description is
741 provided automatically.</p></td>
742 <td class="parameter_annotations"> </td>
743 </tr>
744 </tbody>
745 </table></div>
746 </div>
747 </div>
748 <hr>
749 <div class="refsect2">
750 <a name="gupnp-service-action-get-message"></a><h3>gupnp_service_action_get_message ()</h3>
751 <pre class="programlisting"><a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupMessage.html"><span class="returnvalue">SoupMessage</span></a> *
752 gupnp_service_action_get_message (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);</pre>
753 <p>Get the <a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupMessage.html"><span class="type">SoupMessage</span></a> associated with <em class="parameter"><code>action</code></em>
754 . Mainly intended for
755 applications to be able to read HTTP headers received from clients.</p>
756 <div class="refsect3">
757 <a name="id-1.3.4.4.10.15.5"></a><h4>Parameters</h4>
758 <div class="informaltable"><table width="100%" border="0">
759 <colgroup>
760 <col width="150px" class="parameters_name">
761 <col class="parameters_description">
762 <col width="200px" class="parameters_annotations">
763 </colgroup>
764 <tbody><tr>
765 <td class="parameter_name"><p>action</p></td>
766 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
767 <td class="parameter_annotations"> </td>
768 </tr></tbody>
769 </table></div>
770 </div>
771 <div class="refsect3">
772 <a name="id-1.3.4.4.10.15.6"></a><h4>Returns</h4>
773 <p> <a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupMessage.html"><span class="type">SoupMessage</span></a> associated with <em class="parameter"><code>action</code></em>
774 . Unref
775 after using it. </p>
776 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
777 </div>
778 <p class="since">Since 0.13.0</p>
779 </div>
780 <hr>
781 <div class="refsect2">
782 <a name="gupnp-service-action-get-argument-count"></a><h3>gupnp_service_action_get_argument_count ()</h3>
783 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
784 gupnp_service_action_get_argument_count
785                                (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);</pre>
786 <p>Get the number of IN arguments from the <em class="parameter"><code>action</code></em>
787  and return it.</p>
788 <div class="refsect3">
789 <a name="id-1.3.4.4.10.16.5"></a><h4>Parameters</h4>
790 <div class="informaltable"><table width="100%" border="0">
791 <colgroup>
792 <col width="150px" class="parameters_name">
793 <col class="parameters_description">
794 <col width="200px" class="parameters_annotations">
795 </colgroup>
796 <tbody><tr>
797 <td class="parameter_name"><p>action</p></td>
798 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
799 <td class="parameter_annotations"> </td>
800 </tr></tbody>
801 </table></div>
802 </div>
803 <div class="refsect3">
804 <a name="id-1.3.4.4.10.16.6"></a><h4>Returns</h4>
805 <p> The number of IN arguments from the <em class="parameter"><code>action</code></em>
806 .</p>
807 <p></p>
808 </div>
809 <p class="since">Since 0.17.0</p>
810 </div>
811 <hr>
812 <div class="refsect2">
813 <a name="gupnp-service-notify"></a><h3>gupnp_service_notify ()</h3>
814 <pre class="programlisting"><span class="returnvalue">void</span>
815 gupnp_service_notify (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
816                       <em class="parameter"><code>...</code></em>);</pre>
817 <p>Notifies listening clients that the properties listed in <em class="parameter"><code>Varargs</code></em>
818
819 have changed to the specified values.</p>
820 <div class="refsect3">
821 <a name="id-1.3.4.4.10.17.5"></a><h4>Parameters</h4>
822 <div class="informaltable"><table width="100%" border="0">
823 <colgroup>
824 <col width="150px" class="parameters_name">
825 <col class="parameters_description">
826 <col width="200px" class="parameters_annotations">
827 </colgroup>
828 <tbody>
829 <tr>
830 <td class="parameter_name"><p>service</p></td>
831 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a></p></td>
832 <td class="parameter_annotations"> </td>
833 </tr>
834 <tr>
835 <td class="parameter_name"><p>...</p></td>
836 <td class="parameter_description"><p>Tuples of variable name, variable type, and variable value,
837 terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
838 <td class="parameter_annotations"> </td>
839 </tr>
840 </tbody>
841 </table></div>
842 </div>
843 </div>
844 <hr>
845 <div class="refsect2">
846 <a name="gupnp-service-notify-valist"></a><h3>gupnp_service_notify_valist ()</h3>
847 <pre class="programlisting"><span class="returnvalue">void</span>
848 gupnp_service_notify_valist (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
849                              <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
850 <p>See <a class="link" href="GUPnPService.html#gupnp-service-notify" title="gupnp_service_notify ()"><code class="function">gupnp_service_notify()</code></a>; this version takes a va_list for
851 use by language bindings.</p>
852 <div class="refsect3">
853 <a name="id-1.3.4.4.10.18.5"></a><h4>Parameters</h4>
854 <div class="informaltable"><table width="100%" border="0">
855 <colgroup>
856 <col width="150px" class="parameters_name">
857 <col class="parameters_description">
858 <col width="200px" class="parameters_annotations">
859 </colgroup>
860 <tbody>
861 <tr>
862 <td class="parameter_name"><p>service</p></td>
863 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a></p></td>
864 <td class="parameter_annotations"> </td>
865 </tr>
866 <tr>
867 <td class="parameter_name"><p>var_args</p></td>
868 <td class="parameter_description"><p>A va_list of tuples of variable name, variable type, and variable
869 value, terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
870 <td class="parameter_annotations"> </td>
871 </tr>
872 </tbody>
873 </table></div>
874 </div>
875 </div>
876 <hr>
877 <div class="refsect2">
878 <a name="gupnp-service-notify-value"></a><h3>gupnp_service_notify_value ()</h3>
879 <pre class="programlisting"><span class="returnvalue">void</span>
880 gupnp_service_notify_value (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
881                             <em class="parameter"><code>const <span class="type">char</span> *variable</code></em>,
882                             <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
883 <p>Notifies listening clients that <em class="parameter"><code>variable</code></em>
884  has changed to <em class="parameter"><code>value</code></em>
885 .</p>
886 <div class="refsect3">
887 <a name="id-1.3.4.4.10.19.5"></a><h4>Parameters</h4>
888 <div class="informaltable"><table width="100%" border="0">
889 <colgroup>
890 <col width="150px" class="parameters_name">
891 <col class="parameters_description">
892 <col width="200px" class="parameters_annotations">
893 </colgroup>
894 <tbody>
895 <tr>
896 <td class="parameter_name"><p>service</p></td>
897 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a></p></td>
898 <td class="parameter_annotations"> </td>
899 </tr>
900 <tr>
901 <td class="parameter_name"><p>variable</p></td>
902 <td class="parameter_description"><p>The name of the variable to notify</p></td>
903 <td class="parameter_annotations"> </td>
904 </tr>
905 <tr>
906 <td class="parameter_name"><p>value</p></td>
907 <td class="parameter_description"><p>The value of the variable</p></td>
908 <td class="parameter_annotations"> </td>
909 </tr>
910 </tbody>
911 </table></div>
912 </div>
913 </div>
914 <hr>
915 <div class="refsect2">
916 <a name="gupnp-service-freeze-notify"></a><h3>gupnp_service_freeze_notify ()</h3>
917 <pre class="programlisting"><span class="returnvalue">void</span>
918 gupnp_service_freeze_notify (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>);</pre>
919 <p>Causes new notifications to be queued up until <a class="link" href="GUPnPService.html#gupnp-service-thaw-notify" title="gupnp_service_thaw_notify ()"><code class="function">gupnp_service_thaw_notify()</code></a>
920 is called.</p>
921 <div class="refsect3">
922 <a name="id-1.3.4.4.10.20.5"></a><h4>Parameters</h4>
923 <div class="informaltable"><table width="100%" border="0">
924 <colgroup>
925 <col width="150px" class="parameters_name">
926 <col class="parameters_description">
927 <col width="200px" class="parameters_annotations">
928 </colgroup>
929 <tbody><tr>
930 <td class="parameter_name"><p>service</p></td>
931 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a></p></td>
932 <td class="parameter_annotations"> </td>
933 </tr></tbody>
934 </table></div>
935 </div>
936 </div>
937 <hr>
938 <div class="refsect2">
939 <a name="gupnp-service-thaw-notify"></a><h3>gupnp_service_thaw_notify ()</h3>
940 <pre class="programlisting"><span class="returnvalue">void</span>
941 gupnp_service_thaw_notify (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>);</pre>
942 <p>Sends out any pending notifications, and stops queuing of new ones.</p>
943 <div class="refsect3">
944 <a name="id-1.3.4.4.10.21.5"></a><h4>Parameters</h4>
945 <div class="informaltable"><table width="100%" border="0">
946 <colgroup>
947 <col width="150px" class="parameters_name">
948 <col class="parameters_description">
949 <col width="200px" class="parameters_annotations">
950 </colgroup>
951 <tbody><tr>
952 <td class="parameter_name"><p>service</p></td>
953 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a></p></td>
954 <td class="parameter_annotations"> </td>
955 </tr></tbody>
956 </table></div>
957 </div>
958 </div>
959 <hr>
960 <div class="refsect2">
961 <a name="gupnp-service-signals-autoconnect"></a><h3>gupnp_service_signals_autoconnect ()</h3>
962 <pre class="programlisting"><span class="returnvalue">void</span>
963 gupnp_service_signals_autoconnect (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
964                                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
965                                    <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
966 <p>A convenience function that attempts to connect all possible
967 <a class="link" href="GUPnPService.html#GUPnPService-action-invoked" title="The “action-invoked” signal"><span class="type">“action-invoked”</span></a> and <a class="link" href="GUPnPService.html#GUPnPService-query-variable" title="The “query-variable” signal"><span class="type">“query-variable”</span></a> signals to
968 appropriate callbacks for the service <em class="parameter"><code>service</code></em>
969 . It uses service introspection
970 and <a href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"><span class="type">GModule</span></a>'s introspective features. It is very simillar to
971 <a href="http://library.gnome.org/devel/gtk3/GtkBuilder.html#gtk-builder-connect-signals"><code class="function">gtk_builder_connect_signals()</code></a> except that it attempts to guess the names of
972 the signal handlers on its own.</p>
973 <p>For this function to do its magic, the application must name the callback
974 functions for <a class="link" href="GUPnPService.html#GUPnPService-action-invoked" title="The “action-invoked” signal"><span class="type">“action-invoked”</span></a> signals by striping the CamelCase
975 off the action names and either prepend "on_" or append "_cb" to them. Same
976 goes for <a class="link" href="GUPnPService.html#GUPnPService-query-variable" title="The “query-variable” signal"><span class="type">“query-variable”</span></a> signals, except that "query_" should
977 be prepended to the variable name. For example, callback function for
978 <code class="varname">GetSystemUpdateID</code> action should be either named as
979 "get_system_update_id_cb" or "on_get_system_update_id" and callback function
980 for the query of "SystemUpdateID" state variable should be named
981 <code class="function">query_system_update_id_cb</code> or
982 <code class="function">on_query_system_update_id</code>.</p>
983 <div class="note">This function will not work correctly if <a href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"><span class="type">GModule</span></a> is not supported
984 on the platform or introspection is not available for <em class="parameter"><code>service</code></em>.</div>
985 <div class="warning">This function can not and therefore does not guarantee that the
986 resulting signal connections will be correct as it depends heavily on a
987 particular naming schemes described above.</div>
988 <div class="refsect3">
989 <a name="id-1.3.4.4.10.22.8"></a><h4>Parameters</h4>
990 <div class="informaltable"><table width="100%" border="0">
991 <colgroup>
992 <col width="150px" class="parameters_name">
993 <col class="parameters_description">
994 <col width="200px" class="parameters_annotations">
995 </colgroup>
996 <tbody>
997 <tr>
998 <td class="parameter_name"><p>service</p></td>
999 <td class="parameter_description"><p>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a></p></td>
1000 <td class="parameter_annotations"> </td>
1001 </tr>
1002 <tr>
1003 <td class="parameter_name"><p>user_data</p></td>
1004 <td class="parameter_description"><p>the data to pass to each of the callbacks</p></td>
1005 <td class="parameter_annotations"> </td>
1006 </tr>
1007 <tr>
1008 <td class="parameter_name"><p>error</p></td>
1009 <td class="parameter_description"><p>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
1010 <td class="parameter_annotations"> </td>
1011 </tr>
1012 </tbody>
1013 </table></div>
1014 </div>
1015 </div>
1016 </div>
1017 <div class="refsect1">
1018 <a name="GUPnPService.other_details"></a><h2>Types and Values</h2>
1019 <div class="refsect2">
1020 <a name="GUPnPService-struct"></a><h3>GUPnPService</h3>
1021 <pre class="programlisting">typedef struct _GUPnPService GUPnPService;</pre>
1022 <p>This struct contains private data only, and should be accessed using the
1023 functions below.</p>
1024 </div>
1025 <hr>
1026 <div class="refsect2">
1027 <a name="GUPnPServiceAction-struct"></a><h3>GUPnPServiceAction</h3>
1028 <pre class="programlisting">typedef struct _GUPnPServiceAction GUPnPServiceAction;</pre>
1029 <p>Opaque structure for holding in-progress action data.</p>
1030 </div>
1031 </div>
1032 <div class="refsect1">
1033 <a name="GUPnPService.property-details"></a><h2>Property Details</h2>
1034 <div class="refsect2">
1035 <a name="GUPnPService--root-device"></a><h3>The <code class="literal">“root-device”</code> property</h3>
1036 <pre class="programlisting">  “root-device”              <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *</pre>
1037 <p>The containing <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>.</p>
1038 <p>Flags: Read / Write / Construct Only</p>
1039 </div>
1040 </div>
1041 <div class="refsect1">
1042 <a name="GUPnPService.signal-details"></a><h2>Signal Details</h2>
1043 <div class="refsect2">
1044 <a name="GUPnPService-action-invoked"></a><h3>The <code class="literal">“action-invoked”</code> signal</h3>
1045 <pre class="programlisting"><span class="returnvalue">void</span>
1046 user_function (<a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>       *service,
1047                <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action,
1048                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)</pre>
1049 <p>Emitted whenever an action is invoked. Handler should process
1050 <em class="parameter"><code>action</code></em>
1051  and must call either <a class="link" href="GUPnPService.html#gupnp-service-action-return" title="gupnp_service_action_return ()"><code class="function">gupnp_service_action_return()</code></a> or
1052 <a class="link" href="GUPnPService.html#gupnp-service-action-return-error" title="gupnp_service_action_return_error ()"><code class="function">gupnp_service_action_return_error()</code></a>.</p>
1053 <div class="refsect3">
1054 <a name="id-1.3.4.4.13.2.5"></a><h4>Parameters</h4>
1055 <div class="informaltable"><table width="100%" border="0">
1056 <colgroup>
1057 <col width="150px" class="parameters_name">
1058 <col class="parameters_description">
1059 <col width="200px" class="parameters_annotations">
1060 </colgroup>
1061 <tbody>
1062 <tr>
1063 <td class="parameter_name"><p>service</p></td>
1064 <td class="parameter_description"><p>The <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> that received the signal</p></td>
1065 <td class="parameter_annotations"> </td>
1066 </tr>
1067 <tr>
1068 <td class="parameter_name"><p>action</p></td>
1069 <td class="parameter_description"><p>The invoked <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a></p></td>
1070 <td class="parameter_annotations"> </td>
1071 </tr>
1072 <tr>
1073 <td class="parameter_name"><p>user_data</p></td>
1074 <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1075 <td class="parameter_annotations"> </td>
1076 </tr>
1077 </tbody>
1078 </table></div>
1079 </div>
1080 <p>Flags: Has Details</p>
1081 </div>
1082 <hr>
1083 <div class="refsect2">
1084 <a name="GUPnPService-notify-failed"></a><h3>The <code class="literal">“notify-failed”</code> signal</h3>
1085 <pre class="programlisting"><span class="returnvalue">void</span>
1086 user_function (<a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service,
1087                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      callback_url,
1088                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      reason,
1089                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
1090 <p>Emitted whenever notification of a client fails.</p>
1091 <div class="refsect3">
1092 <a name="id-1.3.4.4.13.3.5"></a><h4>Parameters</h4>
1093 <div class="informaltable"><table width="100%" border="0">
1094 <colgroup>
1095 <col width="150px" class="parameters_name">
1096 <col class="parameters_description">
1097 <col width="200px" class="parameters_annotations">
1098 </colgroup>
1099 <tbody>
1100 <tr>
1101 <td class="parameter_name"><p>service</p></td>
1102 <td class="parameter_description"><p>The <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> that received the signal</p></td>
1103 <td class="parameter_annotations"> </td>
1104 </tr>
1105 <tr>
1106 <td class="parameter_name"><p>callback_url</p></td>
1107 <td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of callback URLs. </p></td>
1108 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GList][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SoupURI]</span></td>
1109 </tr>
1110 <tr>
1111 <td class="parameter_name"><p>reason</p></td>
1112 <td class="parameter_description"><p> A pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> describing why the notify failed. </p></td>
1113 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GError]</span></td>
1114 </tr>
1115 <tr>
1116 <td class="parameter_name"><p>user_data</p></td>
1117 <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1118 <td class="parameter_annotations"> </td>
1119 </tr>
1120 </tbody>
1121 </table></div>
1122 </div>
1123 <p>Flags: Run Last</p>
1124 </div>
1125 <hr>
1126 <div class="refsect2">
1127 <a name="GUPnPService-query-variable"></a><h3>The <code class="literal">“query-variable”</code> signal</h3>
1128 <pre class="programlisting"><span class="returnvalue">void</span>
1129 user_function (<a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service,
1130                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *variable,
1131                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      value,
1132                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
1133 <p>Emitted whenever <em class="parameter"><code>service</code></em>
1134  needs to know the value of <em class="parameter"><code>variable</code></em>
1135 .
1136 Handler should fill <em class="parameter"><code>value</code></em>
1137  with the value of <em class="parameter"><code>variable</code></em>
1138 .</p>
1139 <div class="refsect3">
1140 <a name="id-1.3.4.4.13.4.5"></a><h4>Parameters</h4>
1141 <div class="informaltable"><table width="100%" border="0">
1142 <colgroup>
1143 <col width="150px" class="parameters_name">
1144 <col class="parameters_description">
1145 <col width="200px" class="parameters_annotations">
1146 </colgroup>
1147 <tbody>
1148 <tr>
1149 <td class="parameter_name"><p>service</p></td>
1150 <td class="parameter_description"><p>The <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> that received the signal</p></td>
1151 <td class="parameter_annotations"> </td>
1152 </tr>
1153 <tr>
1154 <td class="parameter_name"><p>variable</p></td>
1155 <td class="parameter_description"><p>The variable that is being queried</p></td>
1156 <td class="parameter_annotations"> </td>
1157 </tr>
1158 <tr>
1159 <td class="parameter_name"><p>value</p></td>
1160 <td class="parameter_description"><p>The location of the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> of the variable. </p></td>
1161 <td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GValue][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
1162 </tr>
1163 <tr>
1164 <td class="parameter_name"><p>user_data</p></td>
1165 <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1166 <td class="parameter_annotations"> </td>
1167 </tr>
1168 </tbody>
1169 </table></div>
1170 </div>
1171 <p>Flags: Has Details</p>
1172 </div>
1173 </div>
1174 </div>
1175 <div class="footer">
1176 <hr>
1177           Generated by GTK-Doc V1.20</div>
1178 </body>
1179 </html>