8e966ff212b34c617a2f9dd5be5708026ee13717
[profile/ivi/GSSDP.git] / doc / html / GSSDPResourceGroup.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>GSSDPResourceGroup</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GSSDP Reference Manual">
8 <link rel="up" href="ch01.html" title="GSSDP">
9 <link rel="prev" href="GSSDPResourceBrowser.html" title="GSSDPResourceBrowser">
10 <link rel="next" href="gssdp-Error-codes.html" title="Error codes">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="GSSDPResourceBrowser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.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">GSSDP Reference Manual</th>
21 <td><a accesskey="n" href="gssdp-Error-codes.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="#GSSDPResourceGroup.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GSSDPResourceGroup.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GSSDPResourceGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#GSSDPResourceGroup.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="GSSDPResourceGroup"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="GSSDPResourceGroup.top_of_page"></a>GSSDPResourceGroup</span></h2>
38 <p>GSSDPResourceGroup — Class for controlling resource announcement.</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="GSSDPResourceGroup.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">struct              <a class="link" href="GSSDPResourceGroup.html#GSSDPResourceGroup-struct" title="struct GSSDPResourceGroup">GSSDPResourceGroup</a>;
45 <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="returnvalue">GSSDPResourceGroup</span></a> * <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-new" title="gssdp_resource_group_new ()">gssdp_resource_group_new</a>           (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);
46 <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="returnvalue">GSSDPClient</span></a> *       <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-get-client" title="gssdp_resource_group_get_client ()">gssdp_resource_group_get_client</a>     (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);
47 <span class="returnvalue">void</span>                <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-set-max-age" title="gssdp_resource_group_set_max_age ()">gssdp_resource_group_set_max_age</a>    (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
48                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_age</code></em>);
49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-get-max-age" title="gssdp_resource_group_get_max_age ()">gssdp_resource_group_get_max_age</a>    (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);
50 <span class="returnvalue">void</span>                <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-set-available" title="gssdp_resource_group_set_available ()">gssdp_resource_group_set_available</a>  (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
51                                                          <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>);
52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-get-available" title="gssdp_resource_group_get_available ()">gssdp_resource_group_get_available</a>  (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);
53 <span class="returnvalue">void</span>                <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-set-message-delay" title="gssdp_resource_group_set_message_delay ()">gssdp_resource_group_set_message_delay</a>
54                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
55                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> message_delay</code></em>);
56 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-get-message-delay" title="gssdp_resource_group_get_message_delay ()">gssdp_resource_group_get_message_delay</a>
57                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);
58 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-add-resource" title="gssdp_resource_group_add_resource ()">gssdp_resource_group_add_resource</a>   (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
59                                                          <em class="parameter"><code>const <span class="type">char</span> *target</code></em>,
60                                                          <em class="parameter"><code>const <span class="type">char</span> *usn</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> *locations</code></em>);
62 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-add-resource-simple" title="gssdp_resource_group_add_resource_simple ()">gssdp_resource_group_add_resource_simple</a>
63                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
64                                                          <em class="parameter"><code>const <span class="type">char</span> *target</code></em>,
65                                                          <em class="parameter"><code>const <span class="type">char</span> *usn</code></em>,
66                                                          <em class="parameter"><code>const <span class="type">char</span> *location</code></em>);
67 <span class="returnvalue">void</span>                <a class="link" href="GSSDPResourceGroup.html#gssdp-resource-group-remove-resource" title="gssdp_resource_group_remove_resource ()">gssdp_resource_group_remove_resource</a>
68                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
69                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> resource_id</code></em>);
70 </pre>
71 </div>
72 <div class="refsect1">
73 <a name="GSSDPResourceGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
74 <pre class="synopsis">
75   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
76    +----GSSDPResourceGroup
77 </pre>
78 </div>
79 <div class="refsect1">
80 <a name="GSSDPResourceGroup.properties"></a><h2>Properties</h2>
81 <pre class="synopsis">
82   "<a class="link" href="GSSDPResourceGroup.html#GSSDPResourceGroup--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
83   "<a class="link" href="GSSDPResourceGroup.html#GSSDPResourceGroup--client" title='The "client" property'>client</a>"                   <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>*          : Read / Write / Construct Only
84   "<a class="link" href="GSSDPResourceGroup.html#GSSDPResourceGroup--max-age" title='The "max-age" property'>max-age</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
85   "<a class="link" href="GSSDPResourceGroup.html#GSSDPResourceGroup--message-delay" title='The "message-delay" property'>message-delay</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
86 </pre>
87 </div>
88 <div class="refsect1">
89 <a name="GSSDPResourceGroup.description"></a><h2>Description</h2>
90 <p>
91 A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> is a group of SSDP resources whose availability can
92 be controlled as one. This is useful when one needs to announce a single
93 service as multiple SSDP resources (UPnP does this for example).
94 </p>
95 </div>
96 <div class="refsect1">
97 <a name="GSSDPResourceGroup.details"></a><h2>Details</h2>
98 <div class="refsect2">
99 <a name="GSSDPResourceGroup-struct"></a><h3>struct GSSDPResourceGroup</h3>
100 <pre class="programlisting">struct GSSDPResourceGroup;</pre>
101 <p>
102 </p>
103 </div>
104 <hr>
105 <div class="refsect2">
106 <a name="gssdp-resource-group-new"></a><h3>gssdp_resource_group_new ()</h3>
107 <pre class="programlisting"><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="returnvalue">GSSDPResourceGroup</span></a> * gssdp_resource_group_new           (<em class="parameter"><code><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> *client</code></em>);</pre>
108 <div class="variablelist"><table border="0">
109 <col align="left" valign="top">
110 <tbody>
111 <tr>
112 <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
113 <td>The <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> to associate with</td>
114 </tr>
115 <tr>
116 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
117 <td>A new <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> object.</td>
118 </tr>
119 </tbody>
120 </table></div>
121 </div>
122 <hr>
123 <div class="refsect2">
124 <a name="gssdp-resource-group-get-client"></a><h3>gssdp_resource_group_get_client ()</h3>
125 <pre class="programlisting"><a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="returnvalue">GSSDPClient</span></a> *       gssdp_resource_group_get_client     (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);</pre>
126 <div class="variablelist"><table border="0">
127 <col align="left" valign="top">
128 <tbody>
129 <tr>
130 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
131 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
132 </td>
133 </tr>
134 <tr>
135 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
136 <td>The <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> <em class="parameter"><code>resource_group</code></em> is associated with. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
137 </td>
138 </tr>
139 </tbody>
140 </table></div>
141 </div>
142 <hr>
143 <div class="refsect2">
144 <a name="gssdp-resource-group-set-max-age"></a><h3>gssdp_resource_group_set_max_age ()</h3>
145 <pre class="programlisting"><span class="returnvalue">void</span>                gssdp_resource_group_set_max_age    (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
146                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_age</code></em>);</pre>
147 <p>
148 Sets the number of seconds advertisements are valid to <em class="parameter"><code>max_age</code></em>.
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>resource_group</code></em> :</span></p></td>
155 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
156 </td>
157 </tr>
158 <tr>
159 <td><p><span class="term"><em class="parameter"><code>max_age</code></em> :</span></p></td>
160 <td>The number of seconds advertisements are valid</td>
161 </tr>
162 </tbody>
163 </table></div>
164 </div>
165 <hr>
166 <div class="refsect2">
167 <a name="gssdp-resource-group-get-max-age"></a><h3>gssdp_resource_group_get_max_age ()</h3>
168 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gssdp_resource_group_get_max_age    (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);</pre>
169 <div class="variablelist"><table border="0">
170 <col align="left" valign="top">
171 <tbody>
172 <tr>
173 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
174 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
175 </td>
176 </tr>
177 <tr>
178 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
179 <td>The number of seconds advertisements are valid.</td>
180 </tr>
181 </tbody>
182 </table></div>
183 </div>
184 <hr>
185 <div class="refsect2">
186 <a name="gssdp-resource-group-set-available"></a><h3>gssdp_resource_group_set_available ()</h3>
187 <pre class="programlisting"><span class="returnvalue">void</span>                gssdp_resource_group_set_available  (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
188                                                          <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>
189 <p>
190 Sets <em class="parameter"><code>resource_group</code></em>s availability to <em class="parameter"><code>available</code></em>. Changing
191 <em class="parameter"><code>resource_group</code></em>s availability causes it to announce its new state
192 to listening SSDP clients.
193 </p>
194 <div class="variablelist"><table border="0">
195 <col align="left" valign="top">
196 <tbody>
197 <tr>
198 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
199 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
200 </td>
201 </tr>
202 <tr>
203 <td><p><span class="term"><em class="parameter"><code>available</code></em> :</span></p></td>
204 <td>TRUE if <em class="parameter"><code>resource_group</code></em> should be available (advertised)</td>
205 </tr>
206 </tbody>
207 </table></div>
208 </div>
209 <hr>
210 <div class="refsect2">
211 <a name="gssdp-resource-group-get-available"></a><h3>gssdp_resource_group_get_available ()</h3>
212 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gssdp_resource_group_get_available  (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);</pre>
213 <div class="variablelist"><table border="0">
214 <col align="left" valign="top">
215 <tbody>
216 <tr>
217 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
218 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
219 </td>
220 </tr>
221 <tr>
222 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
223 <td>TRUE if <em class="parameter"><code>resource_group</code></em> is available (advertised).</td>
224 </tr>
225 </tbody>
226 </table></div>
227 </div>
228 <hr>
229 <div class="refsect2">
230 <a name="gssdp-resource-group-set-message-delay"></a><h3>gssdp_resource_group_set_message_delay ()</h3>
231 <pre class="programlisting"><span class="returnvalue">void</span>                gssdp_resource_group_set_message_delay
232                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
233                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> message_delay</code></em>);</pre>
234 <p>
235 Sets the minimum time between each SSDP message.
236 </p>
237 <div class="variablelist"><table border="0">
238 <col align="left" valign="top">
239 <tbody>
240 <tr>
241 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
242 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
243 </td>
244 </tr>
245 <tr>
246 <td><p><span class="term"><em class="parameter"><code>message_delay</code></em> :</span></p></td>
247 <td>The message delay in ms.</td>
248 </tr>
249 </tbody>
250 </table></div>
251 </div>
252 <hr>
253 <div class="refsect2">
254 <a name="gssdp-resource-group-get-message-delay"></a><h3>gssdp_resource_group_get_message_delay ()</h3>
255 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gssdp_resource_group_get_message_delay
256                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>);</pre>
257 <div class="variablelist"><table border="0">
258 <col align="left" valign="top">
259 <tbody>
260 <tr>
261 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
262 <td>A <a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a>
263 </td>
264 </tr>
265 <tr>
266 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
267 <td>the minimum time between each SSDP message in ms.</td>
268 </tr>
269 </tbody>
270 </table></div>
271 </div>
272 <hr>
273 <div class="refsect2">
274 <a name="gssdp-resource-group-add-resource"></a><h3>gssdp_resource_group_add_resource ()</h3>
275 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gssdp_resource_group_add_resource   (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
276                                                          <em class="parameter"><code>const <span class="type">char</span> *target</code></em>,
277                                                          <em class="parameter"><code>const <span class="type">char</span> *usn</code></em>,
278                                                          <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> *locations</code></em>);</pre>
279 <p>
280 Adds a resource with target <em class="parameter"><code>target</code></em>, USN <em class="parameter"><code>usn</code></em>, and locations <em class="parameter"><code>locations</code></em>
281 to <em class="parameter"><code>resource_group</code></em>.
282 </p>
283 <div class="variablelist"><table border="0">
284 <col align="left" valign="top">
285 <tbody>
286 <tr>
287 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
288 <td>An <em class="parameter"><code>GSSDPResourceGroup</code></em>
289 </td>
290 </tr>
291 <tr>
292 <td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
293 <td>The resource's target</td>
294 </tr>
295 <tr>
296 <td><p><span class="term"><em class="parameter"><code>usn</code></em> :</span></p></td>
297 <td>The resource's USN</td>
298 </tr>
299 <tr>
300 <td><p><span class="term"><em class="parameter"><code>locations</code></em> :</span></p></td>
301 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of the resource's locations. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
302 </td>
303 </tr>
304 <tr>
305 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
306 <td>The ID of the added resource.</td>
307 </tr>
308 </tbody>
309 </table></div>
310 </div>
311 <hr>
312 <div class="refsect2">
313 <a name="gssdp-resource-group-add-resource-simple"></a><h3>gssdp_resource_group_add_resource_simple ()</h3>
314 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gssdp_resource_group_add_resource_simple
315                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
316                                                          <em class="parameter"><code>const <span class="type">char</span> *target</code></em>,
317                                                          <em class="parameter"><code>const <span class="type">char</span> *usn</code></em>,
318                                                          <em class="parameter"><code>const <span class="type">char</span> *location</code></em>);</pre>
319 <p>
320 Adds a resource with target <em class="parameter"><code>target</code></em>, USN <em class="parameter"><code>usn</code></em>, and location <em class="parameter"><code>location</code></em>
321 to <em class="parameter"><code>resource_group</code></em>.
322 </p>
323 <div class="variablelist"><table border="0">
324 <col align="left" valign="top">
325 <tbody>
326 <tr>
327 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
328 <td>An <em class="parameter"><code>GSSDPResourceGroup</code></em>
329 </td>
330 </tr>
331 <tr>
332 <td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
333 <td>The resource's target</td>
334 </tr>
335 <tr>
336 <td><p><span class="term"><em class="parameter"><code>usn</code></em> :</span></p></td>
337 <td>The resource's USN</td>
338 </tr>
339 <tr>
340 <td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
341 <td>The resource's location</td>
342 </tr>
343 <tr>
344 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
345 <td>The ID of the added resource.</td>
346 </tr>
347 </tbody>
348 </table></div>
349 </div>
350 <hr>
351 <div class="refsect2">
352 <a name="gssdp-resource-group-remove-resource"></a><h3>gssdp_resource_group_remove_resource ()</h3>
353 <pre class="programlisting"><span class="returnvalue">void</span>                gssdp_resource_group_remove_resource
354                                                         (<em class="parameter"><code><a class="link" href="GSSDPResourceGroup.html" title="GSSDPResourceGroup"><span class="type">GSSDPResourceGroup</span></a> *resource_group</code></em>,
355                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> resource_id</code></em>);</pre>
356 <p>
357 Removes the resource with ID <em class="parameter"><code>resource_id</code></em> from <em class="parameter"><code>resource_group</code></em>.
358 </p>
359 <div class="variablelist"><table border="0">
360 <col align="left" valign="top">
361 <tbody>
362 <tr>
363 <td><p><span class="term"><em class="parameter"><code>resource_group</code></em> :</span></p></td>
364 <td>An <em class="parameter"><code>GSSDPResourceGroup</code></em>
365 </td>
366 </tr>
367 <tr>
368 <td><p><span class="term"><em class="parameter"><code>resource_id</code></em> :</span></p></td>
369 <td>The ID of the resource to remove</td>
370 </tr>
371 </tbody>
372 </table></div>
373 </div>
374 </div>
375 <div class="refsect1">
376 <a name="GSSDPResourceGroup.property-details"></a><h2>Property Details</h2>
377 <div class="refsect2">
378 <a name="GSSDPResourceGroup--available"></a><h3>The <code class="literal">"available"</code> property</h3>
379 <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>
380 <p>
381 Whether this group of resources is available or not.
382 </p>
383 <p>Default value: FALSE</p>
384 </div>
385 <hr>
386 <div class="refsect2">
387 <a name="GSSDPResourceGroup--client"></a><h3>The <code class="literal">"client"</code> property</h3>
388 <pre class="programlisting">  "client"                   <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a>*          : Read / Write / Construct Only</pre>
389 <p>
390 The <a class="link" href="GSSDPClient.html" title="GSSDPClient"><span class="type">GSSDPClient</span></a> to use.
391 </p>
392 </div>
393 <hr>
394 <div class="refsect2">
395 <a name="GSSDPResourceGroup--max-age"></a><h3>The <code class="literal">"max-age"</code> property</h3>
396 <pre class="programlisting">  "max-age"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
397 <p>
398 The number of seconds our advertisements are valid.
399 </p>
400 <p>Default value: 1800</p>
401 </div>
402 <hr>
403 <div class="refsect2">
404 <a name="GSSDPResourceGroup--message-delay"></a><h3>The <code class="literal">"message-delay"</code> property</h3>
405 <pre class="programlisting">  "message-delay"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
406 <p>
407 The minimum number of milliseconds between SSDP messages.
408 The default is 120 based on DLNA specification.
409 </p>
410 <p>Default value: 120</p>
411 </div>
412 </div>
413 </div>
414 <div class="footer">
415 <hr>
416           Generated by GTK-Doc V1.18</div>
417 </body>
418 </html>