doc/html/GUPnPResourceFactory.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>GUPnPResourceFactory</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-utility.html" title="Utility Functions">
   9 <link rel="prev" href="GUPnPContextManager.html" title="GUPnPContextManager">
  10 <link rel="next" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc">
  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="GUPnPContextManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="api-utility.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="GUPnPXMLDoc.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="#GUPnPResourceFactory.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPResourceFactory.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPResourceFactory.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GUPnPResourceFactory"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GUPnPResourceFactory.top_of_page"></a>GUPnPResourceFactory</span></h2>
  36 <p>GUPnPResourceFactory — Class for resource and resource proxy object creation.</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GUPnPResourceFactory.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">                    <a class="link" href="GUPnPResourceFactory.html#GUPnPResourceFactory-struct" title="GUPnPResourceFactory">GUPnPResourceFactory</a>;
  43 <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="returnvalue">GUPnPResourceFactory</span></a> * <a class="link" href="GUPnPResourceFactory.html#gupnp-resource-factory-new" title="gupnp_resource_factory_new ()">gupnp_resource_factory_new</a>       (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="returnvalue">GUPnPResourceFactory</span></a> * <a class="link" href="GUPnPResourceFactory.html#gupnp-resource-factory-get-default" title="gupnp_resource_factory_get_default ()">gupnp_resource_factory_get_default</a>
  45                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="GUPnPResourceFactory.html#gupnp-resource-factory-register-resource-type" title="gupnp_resource_factory_register_resource_type ()">gupnp_resource_factory_register_resource_type</a>
  47                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
  48                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>,
  49                                                          <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>);
  50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GUPnPResourceFactory.html#gupnp-resource-factory-unregister-resource-type" title="gupnp_resource_factory_unregister_resource_type ()">gupnp_resource_factory_unregister_resource_type</a>
  51                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
  52                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>);
  53 <span class="returnvalue">void</span>                <a class="link" href="GUPnPResourceFactory.html#gupnp-resource-factory-register-resource-proxy-type" title="gupnp_resource_factory_register_resource_proxy_type ()">gupnp_resource_factory_register_resource_proxy_type</a>
  54                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
  55                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>,
  56                                                          <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>);
  57 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GUPnPResourceFactory.html#gupnp-resource-factory-unregister-resource-proxy-type" title="gupnp_resource_factory_unregister_resource_proxy_type ()">gupnp_resource_factory_unregister_resource_proxy_type</a>
  58                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
  59                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>);
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GUPnPResourceFactory.object-hierarchy"></a><h2>Object Hierarchy</h2>
  64 <pre class="synopsis">
  65   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  66    +----GUPnPResourceFactory
  67 </pre>
  68 </div>
  69 <div class="refsect1">
  70 <a name="GUPnPResourceFactory.description"></a><h2>Description</h2>
  71 <p>
  72 <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> objects are used by <a class="link" href="GUPnPControlPoint.html" title="GUPnPControlPoint"><span class="type">GUPnPControlPoint</span></a>,
  73 <a class="link" href="GUPnPDeviceProxy.html" title="GUPnPDeviceProxy"><span class="type">GUPnPDeviceProxy</span></a> and <a class="link" href="GUPnPDevice.html" title="GUPnPDevice"><span class="type">GUPnPDevice</span></a> to create resource proxy and resource
  74 objects. Register UPnP type - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> pairs to have resource or resource proxy
  75 objects created with the specified <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> whenever an object for a resource
  76 of the specified UPnP type is requested. The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>s need
  77 to be derived from the relevant resource or resource proxy type (e.g.
  78 a device proxy type needs to be derived from <a class="link" href="GUPnPDeviceProxy.html" title="GUPnPDeviceProxy"><span class="type">GUPnPDeviceProxy</span></a>).
  79 </p>
  80 <p>
  81 </p>
  82 </div>
  83 <div class="refsect1">
  84 <a name="GUPnPResourceFactory.details"></a><h2>Details</h2>
  85 <div class="refsect2">
  86 <a name="GUPnPResourceFactory-struct"></a><h3>GUPnPResourceFactory</h3>
  87 <pre class="programlisting">typedef struct _GUPnPResourceFactory GUPnPResourceFactory;</pre>
  88 <p>
  89 This struct contains private data only, and should be accessed using the
  90 functions below.
  91 </p>
  92 <p>
  93 </p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="gupnp-resource-factory-new"></a><h3>gupnp_resource_factory_new ()</h3>
  98 <pre class="programlisting"><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="returnvalue">GUPnPResourceFactory</span></a> * gupnp_resource_factory_new       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  99 <p>
 100 Create a new <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> object.
 101 </p>
 102 <p>
 103 </p>
 104 <div class="variablelist"><table border="0">
 105 <col align="left" valign="top">
 106 <tbody><tr>
 107 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 108 <td> A <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> object.
 109 </td>
 110 </tr></tbody>
 111 </table></div>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="gupnp-resource-factory-get-default"></a><h3>gupnp_resource_factory_get_default ()</h3>
 116 <pre class="programlisting"><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="returnvalue">GUPnPResourceFactory</span></a> * gupnp_resource_factory_get_default
 117                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 118 <p>
 119 Get the default singleton <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> object.
 120 </p>
 121 <p>
 122 </p>
 123 <div class="variablelist"><table border="0">
 124 <col align="left" valign="top">
 125 <tbody><tr>
 126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 127 <td> A <em class="parameter"><code>GUPnPResourceFactory</code></em> object.
 128 </td>
 129 </tr></tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="gupnp-resource-factory-register-resource-type"></a><h3>gupnp_resource_factory_register_resource_type ()</h3>
 135 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_resource_factory_register_resource_type
 136                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
 137                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>,
 138                                                          <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>
 139 <p>
 140 Registers the GType <em class="parameter"><code>type</code></em> for the resource of UPnP type <em class="parameter"><code>upnp_type</code></em>. After
 141 this call, the factory <em class="parameter"><code>factory</code></em> will create object of GType <em class="parameter"><code>type</code></em> each time
 142 it is asked to create a resource object for UPnP type <em class="parameter"><code>upnp_type</code></em>.
 143 </p>
 144 <p>
 145 Note: GType <em class="parameter"><code>type</code></em> must be a derived type of <span class="type">GUPNP_TYPE_DEVICE</span> if resource is
 146 a device or <span class="type">GUPNP_TYPE_SERVICE</span> if its a service.
 147 </p>
 148 <p>
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
 155 <td>A <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a>.
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>upnp_type</code></em> :</span></p></td>
 160 <td>The UPnP type name of the resource.
 161 </td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 165 <td>The requested GType assignment for the resource.
 166 </td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 <hr>
 172 <div class="refsect2">
 173 <a name="gupnp-resource-factory-unregister-resource-type"></a><h3>gupnp_resource_factory_unregister_resource_type ()</h3>
 174 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gupnp_resource_factory_unregister_resource_type
 175                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
 176                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>);</pre>
 177 <p>
 178 Unregisters the GType assignment for the resource of UPnP type <em class="parameter"><code>upnp_type</code></em>.
 179 </p>
 180 <p>
 181 </p>
 182 <div class="variablelist"><table border="0">
 183 <col align="left" valign="top">
 184 <tbody>
 185 <tr>
 186 <td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
 187 <td>A <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a>.
 188 </td>
 189 </tr>
 190 <tr>
 191 <td><p><span class="term"><em class="parameter"><code>upnp_type</code></em> :</span></p></td>
 192 <td>The UPnP type name of the resource.
 193 </td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 197 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if GType assignment was removed successfully, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 198 otherwise.
 199 </td>
 200 </tr>
 201 </tbody>
 202 </table></div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="gupnp-resource-factory-register-resource-proxy-type"></a><h3>gupnp_resource_factory_register_resource_proxy_type ()</h3>
 207 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_resource_factory_register_resource_proxy_type
 208                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
 209                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>,
 210                                                          <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>
 211 <p>
 212 Registers the GType <em class="parameter"><code>type</code></em> for the proxy of resource of UPnP type <em class="parameter"><code>upnp_type</code></em>.
 213 After this call, the factory <em class="parameter"><code>factory</code></em> will create object of GType <em class="parameter"><code>type</code></em> each
 214 time it is asked to create a resource proxy object for UPnP type <em class="parameter"><code>upnp_type</code></em>.
 215 </p>
 216 <p>
 217 Note: GType <em class="parameter"><code>type</code></em> must be a derived type of <span class="type">GUPNP_TYPE_DEVICE_PROXY</span> if
 218 resource is a device or <span class="type">GUPNP_TYPE_SERVICE_PROXY</span> if its a service.
 219 </p>
 220 <p>
 221 </p>
 222 <div class="variablelist"><table border="0">
 223 <col align="left" valign="top">
 224 <tbody>
 225 <tr>
 226 <td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
 227 <td>A <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a>.
 228 </td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><em class="parameter"><code>upnp_type</code></em> :</span></p></td>
 232 <td>The UPnP type name of the resource.
 233 </td>
 234 </tr>
 235 <tr>
 236 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 237 <td>The requested GType assignment for the resource proxy.
 238 </td>
 239 </tr>
 240 </tbody>
 241 </table></div>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="gupnp-resource-factory-unregister-resource-proxy-type"></a><h3>gupnp_resource_factory_unregister_resource_proxy_type ()</h3>
 246 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gupnp_resource_factory_unregister_resource_proxy_type
 247                                                         (<em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
 248                                                          <em class="parameter"><code>const <span class="type">char</span> *upnp_type</code></em>);</pre>
 249 <p>
 250 Unregisters the GType assignment for the proxy of resource of UPnP type
 251 <em class="parameter"><code>upnp_type</code></em>.
 252 </p>
 253 <p>
 254 </p>
 255 <div class="variablelist"><table border="0">
 256 <col align="left" valign="top">
 257 <tbody>
 258 <tr>
 259 <td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
 260 <td>A <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a>.
 261 </td>
 262 </tr>
 263 <tr>
 264 <td><p><span class="term"><em class="parameter"><code>upnp_type</code></em> :</span></p></td>
 265 <td>The UPnP type name of the resource.
 266 </td>
 267 </tr>
 268 <tr>
 269 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 270 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if GType assignment was removed successfully, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 271 otherwise.
 272 </td>
 273 </tr>
 274 </tbody>
 275 </table></div>
 276 </div>
 277 </div>
 278 </div>
 279 <div class="footer">
 280 <hr>
 281           Generated by GTK-Doc V1.15.1</div>
 282 </body>
 283 </html>