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