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>GUPnPService</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.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-utility.html" title="Utility Functions">
  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="GUPnPRootDevice.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="api-device-impl.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">GUPnP Reference Manual</th>
  21 <td><a accesskey="n" href="api-utility.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="#GUPnPService.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPService.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPService.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GUPnPService.properties" class="shortcut">Properties</a>
  31                    |
  32                   <a href="#GUPnPService.signals" class="shortcut">Signals</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="GUPnPService"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="GUPnPService.top_of_page"></a>GUPnPService</span></h2>
  40 <p>GUPnPService — Class for service implementations.</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="GUPnPService.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GUPnPServiceAction"></a><pre class="synopsis">struct              <a class="link" href="GUPnPService.html#GUPnPService-struct" title="struct GUPnPService">GUPnPService</a>;
  47                     <a class="link" href="GUPnPService.html#GUPnPServiceAction-struct" title="GUPnPServiceAction">GUPnPServiceAction</a>;
  48 const <span class="returnvalue">char</span> *        <a class="link" href="GUPnPService.html#gupnp-service-action-get-name" title="gupnp_service_action_get_name ()">gupnp_service_action_get_name</a>       (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GUPnPService.html#gupnp-service-action-get-locales" title="gupnp_service_action_get_locales ()">gupnp_service_action_get_locales</a>    (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);
  50 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-get" title="gupnp_service_action_get ()">gupnp_service_action_get</a>            (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  51                                                          <em class="parameter"><code>...</code></em>);
  52 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-get-valist" title="gupnp_service_action_get_valist ()">gupnp_service_action_get_valist</a>     (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  53                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-get-value" title="gupnp_service_action_get_value ()">gupnp_service_action_get_value</a>      (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  55                                                          <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
  56                                                          <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>);
  57 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="GUPnPService.html#gupnp-service-action-get-gvalue" title="gupnp_service_action_get_gvalue ()">gupnp_service_action_get_gvalue</a>     (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  58                                                          <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
  59                                                          <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>);
  60 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GUPnPService.html#gupnp-service-action-get-values" title="gupnp_service_action_get_values ()">gupnp_service_action_get_values</a>     (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  61                                                          <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>,
  62                                                          <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>);
  63 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-set" title="gupnp_service_action_set ()">gupnp_service_action_set</a>            (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  64                                                          <em class="parameter"><code>...</code></em>);
  65 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-set-valist" title="gupnp_service_action_set_valist ()">gupnp_service_action_set_valist</a>     (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  66                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-set-value" title="gupnp_service_action_set_value ()">gupnp_service_action_set_value</a>      (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  68                                                          <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
  69                                                          <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>);
  70 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-set-values" title="gupnp_service_action_set_values ()">gupnp_service_action_set_values</a>     (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  71                                                          <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>,
  72                                                          <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>);
  73 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-return" title="gupnp_service_action_return ()">gupnp_service_action_return</a>         (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);
  74 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-action-return-error" title="gupnp_service_action_return_error ()">gupnp_service_action_return_error</a>   (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
  75                                                          <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>,
  76                                                          <em class="parameter"><code>const <span class="type">char</span> *error_description</code></em>);
  77 <a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupMessage.html"><span class="returnvalue">SoupMessage</span></a> *       <a class="link" href="GUPnPService.html#gupnp-service-action-get-message" title="gupnp_service_action_get_message ()">gupnp_service_action_get_message</a>    (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);
  78 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>
  79                                                         (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);
  80 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-notify" title="gupnp_service_notify ()">gupnp_service_notify</a>                (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
  81                                                          <em class="parameter"><code>...</code></em>);
  82 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-notify-valist" title="gupnp_service_notify_valist ()">gupnp_service_notify_valist</a>         (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
  83                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);
  84 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-notify-value" title="gupnp_service_notify_value ()">gupnp_service_notify_value</a>          (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
  85                                                          <em class="parameter"><code>const <span class="type">char</span> *variable</code></em>,
  86                                                          <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>);
  87 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-freeze-notify" title="gupnp_service_freeze_notify ()">gupnp_service_freeze_notify</a>         (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>);
  88 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-thaw-notify" title="gupnp_service_thaw_notify ()">gupnp_service_thaw_notify</a>           (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>);
  89 <span class="returnvalue">void</span>                <a class="link" href="GUPnPService.html#gupnp-service-signals-autoconnect" title="gupnp_service_signals_autoconnect ()">gupnp_service_signals_autoconnect</a>   (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
  90                                                          <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>,
  91                                                          <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>);
  92 </pre>
  93 </div>
  94 <div class="refsect1">
  95 <a name="GUPnPService.object-hierarchy"></a><h2>Object Hierarchy</h2>
  96 <pre class="synopsis">
  97   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  98    +----<a class="link" href="GUPnPServiceInfo.html" title="GUPnPServiceInfo">GUPnPServiceInfo</a>
  99          +----GUPnPService
 100 </pre>
 101 <pre class="synopsis">
 102   GBoxed
 103    +----GUPnPServiceAction
 104 </pre>
 105 </div>
 106 <div class="refsect1">
 107 <a name="GUPnPService.properties"></a><h2>Properties</h2>
 108 <pre class="synopsis">
 109   "<a class="link" href="GUPnPService.html#GUPnPService--root-device" title='The "root-device" property'>root-device</a>"              <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>*      : Read / Write / Construct Only
 110 </pre>
 111 </div>
 112 <div class="refsect1">
 113 <a name="GUPnPService.signals"></a><h2>Signals</h2>
 114 <pre class="synopsis">
 115   "<a class="link" href="GUPnPService.html#GUPnPService-action-invoked" title='The "action-invoked" signal'>action-invoked</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
 116   "<a class="link" href="GUPnPService.html#GUPnPService-notify-failed" title='The "notify-failed" signal'>notify-failed</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 117   "<a class="link" href="GUPnPService.html#GUPnPService-query-variable" title='The "query-variable" signal'>query-variable</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
 118 </pre>
 119 </div>
 120 <div class="refsect1">
 121 <a name="GUPnPService.description"></a><h2>Description</h2>
 122 <p>
 123 <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> allows for handling incoming actions and state variable
 124 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.
 125 </p>
 126 </div>
 127 <div class="refsect1">
 128 <a name="GUPnPService.details"></a><h2>Details</h2>
 129 <div class="refsect2">
 130 <a name="GUPnPService-struct"></a><h3>struct GUPnPService</h3>
 131 <pre class="programlisting">struct GUPnPService;</pre>
 132 <p>
 133 This struct contains private data only, and should be accessed using the
 134 functions below.
 135 </p>
 136 </div>
 137 <hr>
 138 <div class="refsect2">
 139 <a name="GUPnPServiceAction-struct"></a><h3>GUPnPServiceAction</h3>
 140 <pre class="programlisting">typedef struct _GUPnPServiceAction GUPnPServiceAction;</pre>
 141 <p>
 142 Opaque structure for holding in-progress action data.
 143 </p>
 144 </div>
 145 <hr>
 146 <div class="refsect2">
 147 <a name="gupnp-service-action-get-name"></a><h3>gupnp_service_action_get_name ()</h3>
 148 <pre class="programlisting">const <span class="returnvalue">char</span> *        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>
 149 <p>
 150 Get the name of <em class="parameter"><code>action</code></em>.
 151 </p>
 152 <div class="variablelist"><table border="0">
 153 <col align="left" valign="top">
 154 <tbody>
 155 <tr>
 156 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 157 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 158 </td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 162 <td>The name of <em class="parameter"><code>action</code></em>
 163 </td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="gupnp-service-action-get-locales"></a><h3>gupnp_service_action_get_locales ()</h3>
 171 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             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>
 172 <p>
 173 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
 174 the client. Free list and elements after use.
 175 </p>
 176 <div class="variablelist"><table border="0">
 177 <col align="left" valign="top">
 178 <tbody>
 179 <tr>
 180 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 181 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 182 </td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 186 <td>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>*
 187 locale names. <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>
 188 </td>
 189 </tr>
 190 </tbody>
 191 </table></div>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="gupnp-service-action-get"></a><h3>gupnp_service_action_get ()</h3>
 196 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_service_action_get            (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
 197                                                          <em class="parameter"><code>...</code></em>);</pre>
 198 <p>
 199 Retrieves the specified action arguments.
 200 </p>
 201 <div class="variablelist"><table border="0">
 202 <col align="left" valign="top">
 203 <tbody>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 206 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 207 </td>
 208 </tr>
 209 <tr>
 210 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 211 <td>tuples of argument name, argument type, and argument value
 212 location, terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 213 </tr>
 214 </tbody>
 215 </table></div>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="gupnp-service-action-get-valist"></a><h3>gupnp_service_action_get_valist ()</h3>
 220 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 221                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
 222 <p>
 223 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
 224 use by language bindings.
 225 </p>
 226 <div class="variablelist"><table border="0">
 227 <col align="left" valign="top">
 228 <tbody>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 231 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 232 </td>
 233 </tr>
 234 <tr>
 235 <td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
 236 <td>va_list of tuples of argument name, argument type, and argument
 237 value location.</td>
 238 </tr>
 239 </tbody>
 240 </table></div>
 241 </div>
 242 <hr>
 243 <div class="refsect2">
 244 <a name="gupnp-service-action-get-value"></a><h3>gupnp_service_action_get_value ()</h3>
 245 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 246                                                          <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
 247                                                          <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>
 248 <p>
 249 Retrieves the value of <em class="parameter"><code>argument</code></em> into <em class="parameter"><code>value</code></em>.
 250 </p>
 251 <div class="variablelist"><table border="0">
 252 <col align="left" valign="top">
 253 <tbody>
 254 <tr>
 255 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 256 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 257 </td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><em class="parameter"><code>argument</code></em> :</span></p></td>
 261 <td>The name of the argument to retrieve</td>
 262 </tr>
 263 <tr>
 264 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 265 <td>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
 266 to the correct type. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span>
 267 </td>
 268 </tr>
 269 </tbody>
 270 </table></div>
 271 </div>
 272 <hr>
 273 <div class="refsect2">
 274 <a name="gupnp-service-action-get-gvalue"></a><h3>gupnp_service_action_get_gvalue ()</h3>
 275 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            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>,
 276                                                          <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
 277                                                          <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>
 278 <p>
 279 Retrieves the value of <em class="parameter"><code>argument</code></em> into a GValue of type <em class="parameter"><code>type</code></em> and returns it.
 280 The method exists only and only to satify PyGI, please use
 281 <a class="link" href="GUPnPService.html#gupnp-service-action-get-value" title="gupnp_service_action_get_value ()"><span class="type">gupnp_service_action_get_value</span></a> and ignore this if possible.
 282 </p>
 283 <div class="variablelist"><table border="0">
 284 <col align="left" valign="top">
 285 <tbody>
 286 <tr>
 287 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 288 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 289 </td>
 290 </tr>
 291 <tr>
 292 <td><p><span class="term"><em class="parameter"><code>argument</code></em> :</span></p></td>
 293 <td>The name of the argument to retrieve</td>
 294 </tr>
 295 <tr>
 296 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 297 <td>The type of argument to retrieve</td>
 298 </tr>
 299 <tr>
 300 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 301 <td>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>.
 302 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><span class="type">g_value_unset</span></a> and <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Slices.html#g-slice-free"><span class="type">g_slice_free</span></a> it after usage.
 303 Rename To: gupnp_service_action_get_value. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 304 </td>
 305 </tr>
 306 </tbody>
 307 </table></div>
 308 </div>
 309 <hr>
 310 <div class="refsect2">
 311 <a name="gupnp-service-action-get-values"></a><h3>gupnp_service_action_get_values ()</h3>
 312 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             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>,
 313                                                          <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>,
 314                                                          <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>
 315 <p>
 316 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.
 317 </p>
 318 <div class="variablelist"><table border="0">
 319 <col align="left" valign="top">
 320 <tbody>
 321 <tr>
 322 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 323 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 324 </td>
 325 </tr>
 326 <tr>
 327 <td><p><span class="term"><em class="parameter"><code>arg_names</code></em> :</span></p></td>
 328 <td>(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</td>
 329 </tr>
 330 <tr>
 331 <td><p><span class="term"><em class="parameter"><code>arg_types</code></em> :</span></p></td>
 332 <td>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>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GType]</span>
 333 </td>
 334 </tr>
 335 <tr>
 336 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 337 <td>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
 338 <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"><span class="type">g_list_free</span></a> the returned list and <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-unset"><span class="type">g_value_unset</span></a> and <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Slices.html#g-slice-free"><span class="type">g_slice_free</span></a>
 339 each element. <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>
 340 </td>
 341 </tr>
 342 </tbody>
 343 </table></div>
 344 </div>
 345 <hr>
 346 <div class="refsect2">
 347 <a name="gupnp-service-action-set"></a><h3>gupnp_service_action_set ()</h3>
 348 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_service_action_set            (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>,
 349                                                          <em class="parameter"><code>...</code></em>);</pre>
 350 <p>
 351 Sets the specified action return values.
 352 </p>
 353 <div class="variablelist"><table border="0">
 354 <col align="left" valign="top">
 355 <tbody>
 356 <tr>
 357 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 358 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 359 </td>
 360 </tr>
 361 <tr>
 362 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 363 <td>tuples of return value name, return value type, and
 364 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>.</td>
 365 </tr>
 366 </tbody>
 367 </table></div>
 368 </div>
 369 <hr>
 370 <div class="refsect2">
 371 <a name="gupnp-service-action-set-valist"></a><h3>gupnp_service_action_set_valist ()</h3>
 372 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 373                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
 374 <p>
 375 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
 376 use by language bindings.
 377 </p>
 378 <div class="variablelist"><table border="0">
 379 <col align="left" valign="top">
 380 <tbody>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 383 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 384 </td>
 385 </tr>
 386 <tr>
 387 <td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
 388 <td>va_list of tuples of return value name, return value type, and
 389 actual return value.</td>
 390 </tr>
 391 </tbody>
 392 </table></div>
 393 </div>
 394 <hr>
 395 <div class="refsect2">
 396 <a name="gupnp-service-action-set-value"></a><h3>gupnp_service_action_set_value ()</h3>
 397 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 398                                                          <em class="parameter"><code>const <span class="type">char</span> *argument</code></em>,
 399                                                          <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>
 400 <p>
 401 Sets the value of <em class="parameter"><code>argument</code></em> to <em class="parameter"><code>value</code></em>.
 402 </p>
 403 <div class="variablelist"><table border="0">
 404 <col align="left" valign="top">
 405 <tbody>
 406 <tr>
 407 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 408 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 409 </td>
 410 </tr>
 411 <tr>
 412 <td><p><span class="term"><em class="parameter"><code>argument</code></em> :</span></p></td>
 413 <td>The name of the return value to retrieve</td>
 414 </tr>
 415 <tr>
 416 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 417 <td>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</td>
 418 </tr>
 419 </tbody>
 420 </table></div>
 421 </div>
 422 <hr>
 423 <div class="refsect2">
 424 <a name="gupnp-service-action-set-values"></a><h3>gupnp_service_action_set_values ()</h3>
 425 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 426                                                          <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>,
 427                                                          <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>
 428 <p>
 429 Sets the specified action return values.
 430 </p>
 431 <div class="variablelist"><table border="0">
 432 <col align="left" valign="top">
 433 <tbody>
 434 <tr>
 435 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 436 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 437 </td>
 438 </tr>
 439 <tr>
 440 <td><p><span class="term"><em class="parameter"><code>arg_names</code></em> :</span></p></td>
 441 <td>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. <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>
 442 </td>
 443 </tr>
 444 <tr>
 445 <td><p><span class="term"><em class="parameter"><code>arg_values</code></em> :</span></p></td>
 446 <td>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
 447 <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>. <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>
 448 </td>
 449 </tr>
 450 </tbody>
 451 </table></div>
 452 </div>
 453 <hr>
 454 <div class="refsect2">
 455 <a name="gupnp-service-action-return"></a><h3>gupnp_service_action_return ()</h3>
 456 <pre class="programlisting"><span class="returnvalue">void</span>                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>
 457 <p>
 458 Return succesfully.
 459 </p>
 460 <div class="variablelist"><table border="0">
 461 <col align="left" valign="top">
 462 <tbody><tr>
 463 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 464 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 465 </td>
 466 </tr></tbody>
 467 </table></div>
 468 </div>
 469 <hr>
 470 <div class="refsect2">
 471 <a name="gupnp-service-action-return-error"></a><h3>gupnp_service_action_return_error ()</h3>
 472 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 473                                                          <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>,
 474                                                          <em class="parameter"><code>const <span class="type">char</span> *error_description</code></em>);</pre>
 475 <p>
 476 Return <em class="parameter"><code>error_code</code></em>.
 477 </p>
 478 <div class="variablelist"><table border="0">
 479 <col align="left" valign="top">
 480 <tbody>
 481 <tr>
 482 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 483 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 484 </td>
 485 </tr>
 486 <tr>
 487 <td><p><span class="term"><em class="parameter"><code>error_code</code></em> :</span></p></td>
 488 <td>The error code</td>
 489 </tr>
 490 <tr>
 491 <td><p><span class="term"><em class="parameter"><code>error_description</code></em> :</span></p></td>
 492 <td>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> is
 493 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>,
 494 <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
 495 <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
 496 provided automatically.</td>
 497 </tr>
 498 </tbody>
 499 </table></div>
 500 </div>
 501 <hr>
 502 <div class="refsect2">
 503 <a name="gupnp-service-action-get-message"></a><h3>gupnp_service_action_get_message ()</h3>
 504 <pre class="programlisting"><a href="/usr/share/gtk-doc/html/libsoup-2.4/SoupMessage.html"><span class="returnvalue">SoupMessage</span></a> *       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>
 505 <p>
 506 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>. Mainly intended for
 507 applications to be able to read HTTP headers received from clients.
 508 </p>
 509 <div class="variablelist"><table border="0">
 510 <col align="left" valign="top">
 511 <tbody>
 512 <tr>
 513 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 514 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 515 </td>
 516 </tr>
 517 <tr>
 518 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 519 <td>
 520 <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>. Unref
 521 after using it. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 522 </td>
 523 </tr>
 524 </tbody>
 525 </table></div>
 526 </div>
 527 <hr>
 528 <div class="refsect2">
 529 <a name="gupnp-service-action-get-argument-count"></a><h3>gupnp_service_action_get_argument_count ()</h3>
 530 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gupnp_service_action_get_argument_count
 531                                                         (<em class="parameter"><code><a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action</code></em>);</pre>
 532 <p>
 533 Get the number of IN arguments from the <em class="parameter"><code>action</code></em> and return it.
 534 </p>
 535 <div class="variablelist"><table border="0">
 536 <col align="left" valign="top">
 537 <tbody>
 538 <tr>
 539 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 540 <td>A <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 541 </td>
 542 </tr>
 543 <tr>
 544 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 545 <td>The number of IN arguments from the <em class="parameter"><code>action</code></em>.</td>
 546 </tr>
 547 </tbody>
 548 </table></div>
 549 </div>
 550 <hr>
 551 <div class="refsect2">
 552 <a name="gupnp-service-notify"></a><h3>gupnp_service_notify ()</h3>
 553 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_service_notify                (<em class="parameter"><code><a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service</code></em>,
 554                                                          <em class="parameter"><code>...</code></em>);</pre>
 555 <p>
 556 Notifies listening clients that the properties listed in <em class="parameter"><code>Varargs</code></em>
 557 have changed to the specified values.
 558 </p>
 559 <div class="variablelist"><table border="0">
 560 <col align="left" valign="top">
 561 <tbody>
 562 <tr>
 563 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 564 <td>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>
 565 </td>
 566 </tr>
 567 <tr>
 568 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 569 <td>Tuples of variable name, variable type, and variable value,
 570 terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 571 </tr>
 572 </tbody>
 573 </table></div>
 574 </div>
 575 <hr>
 576 <div class="refsect2">
 577 <a name="gupnp-service-notify-valist"></a><h3>gupnp_service_notify_valist ()</h3>
 578 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 579                                                          <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
 580 <p>
 581 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
 582 use by language bindings.
 583 </p>
 584 <div class="variablelist"><table border="0">
 585 <col align="left" valign="top">
 586 <tbody>
 587 <tr>
 588 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 589 <td>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>
 590 </td>
 591 </tr>
 592 <tr>
 593 <td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
 594 <td>A va_list of tuples of variable name, variable type, and variable
 595 value, terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 596 </tr>
 597 </tbody>
 598 </table></div>
 599 </div>
 600 <hr>
 601 <div class="refsect2">
 602 <a name="gupnp-service-notify-value"></a><h3>gupnp_service_notify_value ()</h3>
 603 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 604                                                          <em class="parameter"><code>const <span class="type">char</span> *variable</code></em>,
 605                                                          <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>
 606 <p>
 607 Notifies listening clients that <em class="parameter"><code>variable</code></em> has changed to <em class="parameter"><code>value</code></em>.
 608 </p>
 609 <div class="variablelist"><table border="0">
 610 <col align="left" valign="top">
 611 <tbody>
 612 <tr>
 613 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 614 <td>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>
 615 </td>
 616 </tr>
 617 <tr>
 618 <td><p><span class="term"><em class="parameter"><code>variable</code></em> :</span></p></td>
 619 <td>The name of the variable to notify</td>
 620 </tr>
 621 <tr>
 622 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 623 <td>The value of the variable</td>
 624 </tr>
 625 </tbody>
 626 </table></div>
 627 </div>
 628 <hr>
 629 <div class="refsect2">
 630 <a name="gupnp-service-freeze-notify"></a><h3>gupnp_service_freeze_notify ()</h3>
 631 <pre class="programlisting"><span class="returnvalue">void</span>                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>
 632 <p>
 633 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>
 634 is called.
 635 </p>
 636 <div class="variablelist"><table border="0">
 637 <col align="left" valign="top">
 638 <tbody><tr>
 639 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 640 <td>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>
 641 </td>
 642 </tr></tbody>
 643 </table></div>
 644 </div>
 645 <hr>
 646 <div class="refsect2">
 647 <a name="gupnp-service-thaw-notify"></a><h3>gupnp_service_thaw_notify ()</h3>
 648 <pre class="programlisting"><span class="returnvalue">void</span>                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>
 649 <p>
 650 Sends out any pending notifications, and stops queuing of new ones.
 651 </p>
 652 <div class="variablelist"><table border="0">
 653 <col align="left" valign="top">
 654 <tbody><tr>
 655 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 656 <td>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>
 657 </td>
 658 </tr></tbody>
 659 </table></div>
 660 </div>
 661 <hr>
 662 <div class="refsect2">
 663 <a name="gupnp-service-signals-autoconnect"></a><h3>gupnp_service_signals_autoconnect ()</h3>
 664 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
 665                                                          <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>,
 666                                                          <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>
 667 <p>
 668 A convenience function that attempts to connect all possible
 669 <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
 670 appropriate callbacks for the service <em class="parameter"><code>service</code></em>. It uses service introspection
 671 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
 672 <a href="http://developer.gnome.org/gtk2/GtkBuilder.html#gtk-builder-connect-signals"><code class="function">gtk_builder_connect_signals()</code></a> except that it attempts to guess the names of
 673 the signal handlers on its own.
 674 </p>
 675 <p>
 676 For this function to do its magic, the application must name the callback
 677 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
 678 off the action names and either prepend "on_" or append "_cb" to them. Same
 679 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
 680 be prepended to the variable name. For example, callback function for
 681 <code class="varname">GetSystemUpdateID</code> action should be either named as
 682 "get_system_update_id_cb" or "on_get_system_update_id" and callback function
 683 for the query of "SystemUpdateID" state variable should be named
 684 <code class="function">query_system_update_id_cb</code> or
 685 <code class="function">on_query_system_update_id</code>.
 686 </p>
 687 <p>
 688 </p>
 689 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 690 <h3 class="title">Note</h3>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
 691 on the platform or introspection is not available for <em class="parameter"><code>service</code></em>.</div>
 692 <p>
 693 </p>
 694 <p>
 695 </p>
 696 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 697 <h3 class="title">Warning</h3>This function can not and therefore does not guarantee that the
 698 resulting signal connections will be correct as it depends heavily on a
 699 particular naming schemes described above.</div>
 700 <p>
 701 </p>
 702 <div class="variablelist"><table border="0">
 703 <col align="left" valign="top">
 704 <tbody>
 705 <tr>
 706 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 707 <td>A <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>
 708 </td>
 709 </tr>
 710 <tr>
 711 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 712 <td>the data to pass to each of the callbacks</td>
 713 </tr>
 714 <tr>
 715 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 716 <td>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>
 717 </td>
 718 </tr>
 719 </tbody>
 720 </table></div>
 721 </div>
 722 </div>
 723 <div class="refsect1">
 724 <a name="GUPnPService.property-details"></a><h2>Property Details</h2>
 725 <div class="refsect2">
 726 <a name="GUPnPService--root-device"></a><h3>The <code class="literal">"root-device"</code> property</h3>
 727 <pre class="programlisting">  "root-device"              <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>*      : Read / Write / Construct Only</pre>
 728 <p>
 729 The containing <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>.
 730 </p>
 731 </div>
 732 </div>
 733 <div class="refsect1">
 734 <a name="GUPnPService.signal-details"></a><h2>Signal Details</h2>
 735 <div class="refsect2">
 736 <a name="GUPnPService-action-invoked"></a><h3>The <code class="literal">"action-invoked"</code> signal</h3>
 737 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a>       *service,
 738                                                         <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a> *action,
 739                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
 740 <p>
 741 Emitted whenever an action is invoked. Handler should process
 742 <em class="parameter"><code>action</code></em> 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
 743 <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>.
 744 </p>
 745 <div class="variablelist"><table border="0">
 746 <col align="left" valign="top">
 747 <tbody>
 748 <tr>
 749 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 750 <td>The <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> that received the signal</td>
 751 </tr>
 752 <tr>
 753 <td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
 754 <td>The invoked <a class="link" href="GUPnPService.html#GUPnPServiceAction"><span class="type">GUPnPServiceAction</span></a>
 755 </td>
 756 </tr>
 757 <tr>
 758 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 759 <td>user data set when the signal handler was connected.</td>
 760 </tr>
 761 </tbody>
 762 </table></div>
 763 </div>
 764 <hr>
 765 <div class="refsect2">
 766 <a name="GUPnPService-notify-failed"></a><h3>The <code class="literal">"notify-failed"</code> signal</h3>
 767 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service,
 768                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      callback_url,
 769                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      reason,
 770                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 771 <p>
 772 Emitted whenever notification of a client fails.
 773 </p>
 774 <div class="variablelist"><table border="0">
 775 <col align="left" valign="top">
 776 <tbody>
 777 <tr>
 778 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 779 <td>The <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> that received the signal</td>
 780 </tr>
 781 <tr>
 782 <td><p><span class="term"><em class="parameter"><code>callback_url</code></em> :</span></p></td>
 783 <td>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. <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>
 784 </td>
 785 </tr>
 786 <tr>
 787 <td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
 788 <td>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. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GError]</span>
 789 </td>
 790 </tr>
 791 <tr>
 792 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 793 <td>user data set when the signal handler was connected.</td>
 794 </tr>
 795 </tbody>
 796 </table></div>
 797 </div>
 798 <hr>
 799 <div class="refsect2">
 800 <a name="GUPnPService-query-variable"></a><h3>The <code class="literal">"query-variable"</code> signal</h3>
 801 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> *service,
 802                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *variable,
 803                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      value,
 804                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
 805 <p>
 806 Emitted whenever <em class="parameter"><code>service</code></em> needs to know the value of <em class="parameter"><code>variable</code></em>.
 807 Handler should fill <em class="parameter"><code>value</code></em> with the value of <em class="parameter"><code>variable</code></em>.
 808 </p>
 809 <div class="variablelist"><table border="0">
 810 <col align="left" valign="top">
 811 <tbody>
 812 <tr>
 813 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
 814 <td>The <a class="link" href="GUPnPService.html" title="GUPnPService"><span class="type">GUPnPService</span></a> that received the signal</td>
 815 </tr>
 816 <tr>
 817 <td><p><span class="term"><em class="parameter"><code>variable</code></em> :</span></p></td>
 818 <td>The variable that is being queried</td>
 819 </tr>
 820 <tr>
 821 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 822 <td>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. <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>
 823 </td>
 824 </tr>
 825 <tr>
 826 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 827 <td>user data set when the signal handler was connected.</td>
 828 </tr>
 829 </tbody>
 830 </table></div>
 831 </div>
 832 </div>
 833 </div>
 834 <div class="footer">
 835 <hr>
 836           Generated by GTK-Doc V1.18</div>
 837 </body>
 838 </html>