1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GUPnPRootDevice</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="GUPnPDevice.html" title="GUPnPDevice">
10 <link rel="next" href="GUPnPService.html" title="GUPnPService">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="GUPnPDevice.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="GUPnPService.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GUPnPRootDevice.synopsis" class="shortcut">Top</a>
26 <a href="#GUPnPRootDevice.description" class="shortcut">Description</a>
28 <a href="#GUPnPRootDevice.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#GUPnPRootDevice.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="GUPnPRootDevice"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="GUPnPRootDevice.top_of_page"></a>GUPnPRootDevice</span></h2>
38 <p>GUPnPRootDevice — Class for root device implementations.</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="GUPnPRootDevice.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">struct <a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice-struct" title="struct GUPnPRootDevice">GUPnPRootDevice</a>;
45 <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="returnvalue">GUPnPRootDevice</span></a> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-new" title="gupnp_root_device_new ()">gupnp_root_device_new</a> (<em class="parameter"><code><a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> *context</code></em>,
46 <em class="parameter"><code>const <span class="type">char</span> *description_path</code></em>,
47 <em class="parameter"><code>const <span class="type">char</span> *description_dir</code></em>);
48 <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="returnvalue">GUPnPRootDevice</span></a> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-new-full" title="gupnp_root_device_new_full ()">gupnp_root_device_new_full</a> (<em class="parameter"><code><a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> *context</code></em>,
49 <em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
50 <em class="parameter"><code><a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a> *description_doc</code></em>,
51 <em class="parameter"><code>const <span class="type">char</span> *description_path</code></em>,
52 <em class="parameter"><code>const <span class="type">char</span> *description_dir</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-set-available" title="gupnp_root_device_set_available ()">gupnp_root_device_set_available</a> (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>,
54 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> available</code></em>);
55 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-available" title="gupnp_root_device_get_available ()">gupnp_root_device_get_available</a> (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
56 const <span class="returnvalue">char</span> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-relative-location" title="gupnp_root_device_get_relative_location ()">gupnp_root_device_get_relative_location</a>
57 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
58 const <span class="returnvalue">char</span> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-description-dir" title="gupnp_root_device_get_description_dir ()">gupnp_root_device_get_description_dir</a>
59 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
60 const <span class="returnvalue">char</span> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-description-path" title="gupnp_root_device_get_description_path ()">gupnp_root_device_get_description_path</a>
61 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
62 <a href="../gssdp/GSSDPResourceGroup.html"><span class="returnvalue">GSSDPResourceGroup</span></a> * <a class="link" href="GUPnPRootDevice.html#gupnp-root-device-get-ssdp-resource-group" title="gupnp_root_device_get_ssdp_resource_group ()">gupnp_root_device_get_ssdp_resource_group</a>
63 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);
66 <div class="refsect1">
67 <a name="GUPnPRootDevice.object-hierarchy"></a><h2>Object Hierarchy</h2>
68 <pre class="synopsis">
69 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
70 +----<a class="link" href="GUPnPDeviceInfo.html" title="GUPnPDeviceInfo">GUPnPDeviceInfo</a>
71 +----<a class="link" href="GUPnPDevice.html" title="GUPnPDevice">GUPnPDevice</a>
75 <div class="refsect1">
76 <a name="GUPnPRootDevice.properties"></a><h2>Properties</h2>
77 <pre class="synopsis">
78 "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--available" title='The "available" property'>available</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
79 "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-dir" title='The "description-dir" property'>description-dir</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
80 "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-doc" title='The "description-doc" property'>description-doc</a>" <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a>* : Write / Construct Only
81 "<a class="link" href="GUPnPRootDevice.html#GUPnPRootDevice--description-path" title='The "description-path" property'>description-path</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
84 <div class="refsect1">
85 <a name="GUPnPRootDevice.description"></a><h2>Description</h2>
87 <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> allows for implementing root devices.
90 <div class="refsect1">
91 <a name="GUPnPRootDevice.details"></a><h2>Details</h2>
92 <div class="refsect2">
93 <a name="GUPnPRootDevice-struct"></a><h3>struct GUPnPRootDevice</h3>
94 <pre class="programlisting">struct GUPnPRootDevice;</pre>
96 This struct contains private data only, and should be accessed using the
101 <div class="refsect2">
102 <a name="gupnp-root-device-new"></a><h3>gupnp_root_device_new ()</h3>
103 <pre class="programlisting"><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="returnvalue">GUPnPRootDevice</span></a> * gupnp_root_device_new (<em class="parameter"><code><a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> *context</code></em>,
104 <em class="parameter"><code>const <span class="type">char</span> *description_path</code></em>,
105 <em class="parameter"><code>const <span class="type">char</span> *description_dir</code></em>);</pre>
107 Create a new <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> object, automatically loading and parsing
108 device description document from <em class="parameter"><code>description_path</code></em>.
110 <div class="variablelist"><table border="0">
111 <col align="left" valign="top">
114 <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
115 <td>The <a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a>
119 <td><p><span class="term"><em class="parameter"><code>description_path</code></em> :</span></p></td>
120 <td>Path to device description document. This could either
121 be an absolute path or path relative to <em class="parameter"><code>description_dir</code></em>.</td>
124 <td><p><span class="term"><em class="parameter"><code>description_dir</code></em> :</span></p></td>
125 <td>Path to directory where description documents are provided.</td>
128 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
129 <td>A new <em class="parameter"><code>GUPnPRootDevice</code></em> object.</td>
135 <div class="refsect2">
136 <a name="gupnp-root-device-new-full"></a><h3>gupnp_root_device_new_full ()</h3>
137 <pre class="programlisting"><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="returnvalue">GUPnPRootDevice</span></a> * gupnp_root_device_new_full (<em class="parameter"><code><a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a> *context</code></em>,
138 <em class="parameter"><code><a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a> *factory</code></em>,
139 <em class="parameter"><code><a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a> *description_doc</code></em>,
140 <em class="parameter"><code>const <span class="type">char</span> *description_path</code></em>,
141 <em class="parameter"><code>const <span class="type">char</span> *description_dir</code></em>);</pre>
143 Create a new <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>, automatically loading and parsing
144 device description document from <em class="parameter"><code>description_path</code></em> if <em class="parameter"><code>description_doc</code></em> is
145 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
147 <div class="variablelist"><table border="0">
148 <col align="left" valign="top">
151 <td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
152 <td>A <a class="link" href="GUPnPContext.html" title="GUPnPContext"><span class="type">GUPnPContext</span></a>
156 <td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
157 <td>A <a class="link" href="GUPnPResourceFactory.html" title="GUPnPResourceFactory"><span class="type">GUPnPResourceFactory</span></a>
161 <td><p><span class="term"><em class="parameter"><code>description_doc</code></em> :</span></p></td>
162 <td>Device description document, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
166 <td><p><span class="term"><em class="parameter"><code>description_path</code></em> :</span></p></td>
167 <td>Path to device description document. This could either
168 be an absolute path or path relative to <em class="parameter"><code>description_dir</code></em>.</td>
171 <td><p><span class="term"><em class="parameter"><code>description_dir</code></em> :</span></p></td>
172 <td>Path to directory where description documents are provided.</td>
175 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
176 <td>A new <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> object.</td>
182 <div class="refsect2">
183 <a name="gupnp-root-device-set-available"></a><h3>gupnp_root_device_set_available ()</h3>
184 <pre class="programlisting"><span class="returnvalue">void</span> gupnp_root_device_set_available (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>,
185 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> available</code></em>);</pre>
187 Controls whether or not <em class="parameter"><code>root_device</code></em> is available (announcing
190 <div class="variablelist"><table border="0">
191 <col align="left" valign="top">
194 <td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
195 <td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
199 <td><p><span class="term"><em class="parameter"><code>available</code></em> :</span></p></td>
201 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>root_device</code></em> should be available</td>
207 <div class="refsect2">
208 <a name="gupnp-root-device-get-available"></a><h3>gupnp_root_device_get_available ()</h3>
209 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gupnp_root_device_get_available (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
211 Get whether or not <em class="parameter"><code>root_device</code></em> is available (announcing its presence).
213 <div class="variablelist"><table border="0">
214 <col align="left" valign="top">
217 <td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
218 <td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
222 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
224 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>root_device</code></em> is available, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
230 <div class="refsect2">
231 <a name="gupnp-root-device-get-relative-location"></a><h3>gupnp_root_device_get_relative_location ()</h3>
232 <pre class="programlisting">const <span class="returnvalue">char</span> * gupnp_root_device_get_relative_location
233 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
235 Get the relative location of <em class="parameter"><code>root_device</code></em>.
237 <div class="variablelist"><table border="0">
238 <col align="left" valign="top">
241 <td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
242 <td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
246 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
247 <td>The relative location of <em class="parameter"><code>root_device</code></em>.</td>
253 <div class="refsect2">
254 <a name="gupnp-root-device-get-description-dir"></a><h3>gupnp_root_device_get_description_dir ()</h3>
255 <pre class="programlisting">const <span class="returnvalue">char</span> * gupnp_root_device_get_description_dir
256 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
258 Get the path to the directory containing description documents related to
259 <em class="parameter"><code>root_device</code></em>.
261 <div class="variablelist"><table border="0">
262 <col align="left" valign="top">
265 <td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
266 <td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
270 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
271 <td>The path to description document directory of <em class="parameter"><code>root_device</code></em>.</td>
277 <div class="refsect2">
278 <a name="gupnp-root-device-get-description-path"></a><h3>gupnp_root_device_get_description_path ()</h3>
279 <pre class="programlisting">const <span class="returnvalue">char</span> * gupnp_root_device_get_description_path
280 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
282 Get the path to the device description document of <em class="parameter"><code>root_device</code></em>.
284 <div class="variablelist"><table border="0">
285 <col align="left" valign="top">
288 <td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
289 <td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
293 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
294 <td>The path to device description document of <em class="parameter"><code>root_device</code></em>.</td>
300 <div class="refsect2">
301 <a name="gupnp-root-device-get-ssdp-resource-group"></a><h3>gupnp_root_device_get_ssdp_resource_group ()</h3>
302 <pre class="programlisting"><a href="../gssdp/GSSDPResourceGroup.html"><span class="returnvalue">GSSDPResourceGroup</span></a> * gupnp_root_device_get_ssdp_resource_group
303 (<em class="parameter"><code><a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a> *root_device</code></em>);</pre>
305 Get the <a href="../gssdp/GSSDPResourceGroup.html"><span class="type">GSSDPResourceGroup</span></a> used by <em class="parameter"><code>root_device</code></em>.
307 <div class="variablelist"><table border="0">
308 <col align="left" valign="top">
311 <td><p><span class="term"><em class="parameter"><code>root_device</code></em> :</span></p></td>
312 <td>A <a class="link" href="GUPnPRootDevice.html" title="GUPnPRootDevice"><span class="type">GUPnPRootDevice</span></a>
316 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
317 <td>The <a href="../gssdp/GSSDPResourceGroup.html"><span class="type">GSSDPResourceGroup</span></a> of <em class="parameter"><code>root_device</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
324 <div class="refsect1">
325 <a name="GUPnPRootDevice.property-details"></a><h2>Property Details</h2>
326 <div class="refsect2">
327 <a name="GUPnPRootDevice--available"></a><h3>The <code class="literal">"available"</code> property</h3>
328 <pre class="programlisting"> "available" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
330 TRUE if this device is available.
332 <p>Default value: FALSE</p>
335 <div class="refsect2">
336 <a name="GUPnPRootDevice--description-dir"></a><h3>The <code class="literal">"description-dir"</code> property</h3>
337 <pre class="programlisting"> "description-dir" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
339 The path to directory where description documents are provided.
341 <p>Default value: NULL</p>
344 <div class="refsect2">
345 <a name="GUPnPRootDevice--description-doc"></a><h3>The <code class="literal">"description-doc"</code> property</h3>
346 <pre class="programlisting"> "description-doc" <a class="link" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc"><span class="type">GUPnPXMLDoc</span></a>* : Write / Construct Only</pre>
348 Device description document. Constructor property.
352 <div class="refsect2">
353 <a name="GUPnPRootDevice--description-path"></a><h3>The <code class="literal">"description-path"</code> property</h3>
354 <pre class="programlisting"> "description-path" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
356 The path to device description document. This could either be an
357 absolute path or path relative to GUPnPRootDevice:description-dir.
359 <p>Default value: NULL</p>
365 Generated by GTK-Doc V1.18</div>