61
<refsect1 role="details">
82
<refsect1 id="GUPnPControlPoint.details" role="details">
62
83
<title role="details.title">Details</title>
64
<title><anchor id="GUPnPControlPoint" role="struct"/>GUPnPControlPoint</title>
65
<indexterm><primary>GUPnPControlPoint</primary></indexterm><programlisting>typedef struct {
66
GSSDPResourceBrowser parent;
68
GUPnPControlPointPrivate *priv;
75
<title><anchor id="gupnp-control-point-new" role="function"/>gupnp_control_point_new ()</title>
76
<indexterm><primary>gupnp_control_point_new</primary></indexterm><programlisting><link linkend="GUPnPControlPoint">GUPnPControlPoint</link>* gupnp_control_point_new (<link linkend="GUPnPContext">GUPnPContext</link> *context,
77
const <link linkend="char">char</link> *target);</programlisting>
82
</para><variablelist role="params">
83
<varlistentry><term><parameter>context</parameter> :</term>
84
<listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
85
</simpara></listitem></varlistentry>
86
<varlistentry><term><parameter>target</parameter> :</term>
87
<listitem><simpara> The search target
88
</simpara></listitem></varlistentry>
89
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> object.
90
</simpara></listitem></varlistentry>
91
</variablelist></refsect2>
93
<title><anchor id="gupnp-control-point-get-context" role="function"/>gupnp_control_point_get_context ()</title>
94
<indexterm><primary>gupnp_control_point_get_context</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>* gupnp_control_point_get_context (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
99
</para><variablelist role="params">
100
<varlistentry><term><parameter>control_point</parameter> :</term>
101
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
102
</simpara></listitem></varlistentry>
103
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GUPnPContext"><type>GUPnPContext</type></link> associated with <parameter>control_point</parameter>.
104
</simpara></listitem></varlistentry>
105
</variablelist></refsect2>
107
<title><anchor id="gupnp-control-point-list-device-proxies" role="function"/>gupnp_control_point_list_device_proxies ()</title>
108
<indexterm><primary>gupnp_control_point_list_device_proxies</primary></indexterm><programlisting>const <link linkend="GList">GList</link>* gupnp_control_point_list_device_proxies
109
(<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
114
</para><variablelist role="params">
115
<varlistentry><term><parameter>control_point</parameter> :</term>
116
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
117
</simpara></listitem></varlistentry>
118
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of discovered <link linkend="GUPnPDeviceProxy"><type>GUPnPDeviceProxy</type></link> objects. Do not
119
free the list nor its elements.
120
</simpara></listitem></varlistentry>
121
</variablelist></refsect2>
123
<title><anchor id="gupnp-control-point-list-service-proxies" role="function"/>gupnp_control_point_list_service_proxies ()</title>
124
<indexterm><primary>gupnp_control_point_list_service_proxies</primary></indexterm><programlisting>const <link linkend="GList">GList</link>* gupnp_control_point_list_service_proxies
125
(<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
130
</para><variablelist role="params">
131
<varlistentry><term><parameter>control_point</parameter> :</term>
132
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
133
</simpara></listitem></varlistentry>
134
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of discovered <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> objects. Do not
135
free the list nor its elements.
136
</simpara></listitem></varlistentry>
137
</variablelist></refsect2>
84
<refsect2 id="GUPnPControlPoint-struct" role="struct">
85
<title>GUPnPControlPoint</title>
86
<indexterm zone="GUPnPControlPoint-struct"><primary>GUPnPControlPoint</primary></indexterm><programlisting>typedef struct _GUPnPControlPoint GUPnPControlPoint;</programlisting>
88
This struct contains private data only, and should be accessed using the
89
functions below.</para>
93
<refsect2 id="gupnp-control-point-new" role="function">
94
<title>gupnp_control_point_new ()</title>
95
<indexterm zone="gupnp-control-point-new"><primary>gupnp_control_point_new</primary></indexterm><programlisting><link linkend="GUPnPControlPoint">GUPnPControlPoint</link>* gupnp_control_point_new (<link linkend="GUPnPContext">GUPnPContext</link> *context,
96
const <link linkend="char">char</link> *target);</programlisting>
98
Create a new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> with the specified <parameter>context</parameter> and <parameter>target</parameter>.
101
<parameter>target</parameter> should be a service or device name, such as
102
<literal>urn:schemas-upnp-org:service:WANIPConnection:1</literal> or
103
<literal>urn:schemas-upnp-org:device:MediaRenderer:1</literal>.</para>
106
</para><variablelist role="params">
107
<varlistentry><term><parameter>context</parameter> :</term>
108
<listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
109
</simpara></listitem></varlistentry>
110
<varlistentry><term><parameter>target</parameter> :</term>
111
<listitem><simpara> The search target
112
</simpara></listitem></varlistentry>
113
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> object.
114
</simpara></listitem></varlistentry>
115
</variablelist></refsect2>
116
<refsect2 id="gupnp-control-point-new-full" role="function">
117
<title>gupnp_control_point_new_full ()</title>
118
<indexterm zone="gupnp-control-point-new-full"><primary>gupnp_control_point_new_full</primary></indexterm><programlisting><link linkend="GUPnPControlPoint">GUPnPControlPoint</link>* gupnp_control_point_new_full (<link linkend="GUPnPContext">GUPnPContext</link> *context,
119
<link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
120
const <link linkend="char">char</link> *target);</programlisting>
122
Create a new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> with the specified <parameter>context</parameter>, <parameter>factory</parameter> and
123
<parameter>target</parameter>.
126
<parameter>target</parameter> should be a service or device name, such as
127
<literal>urn:schemas-upnp-org:service:WANIPConnection:1</literal> or
128
<literal>urn:schemas-upnp-org:device:MediaRenderer:1</literal>.</para>
131
</para><variablelist role="params">
132
<varlistentry><term><parameter>context</parameter> :</term>
133
<listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
134
</simpara></listitem></varlistentry>
135
<varlistentry><term><parameter>factory</parameter> :</term>
136
<listitem><simpara> A <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link>
137
</simpara></listitem></varlistentry>
138
<varlistentry><term><parameter>target</parameter> :</term>
139
<listitem><simpara> The search target
140
</simpara></listitem></varlistentry>
141
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> object.
142
</simpara></listitem></varlistentry>
143
</variablelist></refsect2>
144
<refsect2 id="gupnp-control-point-get-resource-factory" role="function">
145
<title>gupnp_control_point_get_resource_factory ()</title>
146
<indexterm zone="gupnp-control-point-get-resource-factory"><primary>gupnp_control_point_get_resource_factory</primary></indexterm><programlisting><link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>* gupnp_control_point_get_resource_factory
147
(<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
149
Get the <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link> used by the <parameter>control_point</parameter>.</para>
152
</para><variablelist role="params">
153
<varlistentry><term><parameter>control_point</parameter> :</term>
154
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
155
</simpara></listitem></varlistentry>
156
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link>.
157
</simpara></listitem></varlistentry>
158
</variablelist></refsect2>
159
<refsect2 id="gupnp-control-point-get-context" role="function">
160
<title>gupnp_control_point_get_context ()</title>
161
<indexterm zone="gupnp-control-point-get-context"><primary>gupnp_control_point_get_context</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>* gupnp_control_point_get_context (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
163
Get the <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> associated with <parameter>control_point</parameter>.</para>
166
</para><variablelist role="params">
167
<varlistentry><term><parameter>control_point</parameter> :</term>
168
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
169
</simpara></listitem></varlistentry>
170
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GUPnPContext"><type>GUPnPContext</type></link>.
171
</simpara></listitem></varlistentry>
172
</variablelist></refsect2>
173
<refsect2 id="gupnp-control-point-list-device-proxies" role="function">
174
<title>gupnp_control_point_list_device_proxies ()</title>
175
<indexterm zone="gupnp-control-point-list-device-proxies"><primary>gupnp_control_point_list_device_proxies</primary></indexterm><programlisting>const <link linkend="GList">GList</link>* gupnp_control_point_list_device_proxies
176
(<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
178
Get the <link linkend="GList"><type>GList</type></link> of discovered <link linkend="GUPnPDeviceProxy"><type>GUPnPDeviceProxy</type></link> objects. Do not free the list
179
nor its elements.</para>
182
</para><variablelist role="params">
183
<varlistentry><term><parameter>control_point</parameter> :</term>
184
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
185
</simpara></listitem></varlistentry>
186
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of <link linkend="GUPnPDeviceProxy"><type>GUPnPDeviceProxy</type></link> objects.
187
</simpara></listitem></varlistentry>
188
</variablelist></refsect2>
189
<refsect2 id="gupnp-control-point-list-service-proxies" role="function">
190
<title>gupnp_control_point_list_service_proxies ()</title>
191
<indexterm zone="gupnp-control-point-list-service-proxies"><primary>gupnp_control_point_list_service_proxies</primary></indexterm><programlisting>const <link linkend="GList">GList</link>* gupnp_control_point_list_service_proxies
192
(<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point);</programlisting>
194
Get the <link linkend="GList"><type>GList</type></link> of discovered <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> objects. Do not free the list
195
nor its elements.</para>
198
</para><variablelist role="params">
199
<varlistentry><term><parameter>control_point</parameter> :</term>
200
<listitem><simpara> A <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link>
201
</simpara></listitem></varlistentry>
202
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> objects.
203
</simpara></listitem></varlistentry>
204
</variablelist></refsect2>
207
<refsect1 id="GUPnPControlPoint.property-details" role="property_details">
208
<title role="property_details.title">Property Details</title>
209
<refsect2 id="GUPnPControlPoint--resource-factory"><title>The <literal>"resource-factory"</literal> property</title>
210
<indexterm zone="GUPnPControlPoint--resource-factory"><primary>GUPnPControlPoint:resource-factory</primary></indexterm><programlisting> "resource-factory" <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>* : Read / Write / Construct Only</programlisting>
212
The resource factory to use. Set to NULL for default factory.</para>
219
<refsect1 id="GUPnPControlPoint.signal-details" role="signals">
220
<title role="signals.title">Signal Details</title>
221
<refsect2 id="GUPnPControlPoint-device-proxy-available"><title>The <literal>"device-proxy-available"</literal> signal</title>
222
<indexterm zone="GUPnPControlPoint-device-proxy-available"><primary>GUPnPControlPoint::device-proxy-available</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point,
223
<link linkend="GUPnPDeviceProxy">GUPnPDeviceProxy</link> *proxy,
224
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
226
The ::device-proxy-available signal is emitted whenever a new
227
device has become available.</para>
230
</para><variablelist role="params">
231
<varlistentry><term><parameter>control_point</parameter> :</term>
232
<listitem><simpara> The <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> that received the signal
233
</simpara></listitem></varlistentry>
234
<varlistentry><term><parameter>proxy</parameter> :</term>
235
<listitem><simpara> The now available <link linkend="GUPnPDeviceProxy"><type>GUPnPDeviceProxy</type></link>
236
</simpara></listitem></varlistentry>
237
<varlistentry><term><parameter>user_data</parameter> :</term>
238
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
239
</variablelist></refsect2><refsect2 id="GUPnPControlPoint-device-proxy-unavailable"><title>The <literal>"device-proxy-unavailable"</literal> signal</title>
240
<indexterm zone="GUPnPControlPoint-device-proxy-unavailable"><primary>GUPnPControlPoint::device-proxy-unavailable</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point,
241
<link linkend="GUPnPDeviceProxy">GUPnPDeviceProxy</link> *proxy,
242
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
244
The ::device-proxy-unavailable signal is emitted whenever a
245
device is not available any more.</para>
248
</para><variablelist role="params">
249
<varlistentry><term><parameter>control_point</parameter> :</term>
250
<listitem><simpara> The <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> that received the signal
251
</simpara></listitem></varlistentry>
252
<varlistentry><term><parameter>proxy</parameter> :</term>
253
<listitem><simpara> The now unavailable <link linkend="GUPnPDeviceProxy"><type>GUPnPDeviceProxy</type></link>
254
</simpara></listitem></varlistentry>
255
<varlistentry><term><parameter>user_data</parameter> :</term>
256
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
257
</variablelist></refsect2><refsect2 id="GUPnPControlPoint-service-proxy-available"><title>The <literal>"service-proxy-available"</literal> signal</title>
258
<indexterm zone="GUPnPControlPoint-service-proxy-available"><primary>GUPnPControlPoint::service-proxy-available</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point,
259
<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
260
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
262
The ::service-proxy-available signal is emitted whenever a new
263
service has become available.</para>
266
</para><variablelist role="params">
267
<varlistentry><term><parameter>control_point</parameter> :</term>
268
<listitem><simpara> The <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> that received the signal
269
</simpara></listitem></varlistentry>
270
<varlistentry><term><parameter>proxy</parameter> :</term>
271
<listitem><simpara> The now available <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link>
272
</simpara></listitem></varlistentry>
273
<varlistentry><term><parameter>user_data</parameter> :</term>
274
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
275
</variablelist></refsect2><refsect2 id="GUPnPControlPoint-service-proxy-unavailable"><title>The <literal>"service-proxy-unavailable"</literal> signal</title>
276
<indexterm zone="GUPnPControlPoint-service-proxy-unavailable"><primary>GUPnPControlPoint::service-proxy-unavailable</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GUPnPControlPoint">GUPnPControlPoint</link> *control_point,
277
<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
278
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
280
The ::service-proxy-unavailable signal is emitted whenever a
281
service is not available any more.</para>
284
</para><variablelist role="params">
285
<varlistentry><term><parameter>control_point</parameter> :</term>
286
<listitem><simpara> The <link linkend="GUPnPControlPoint"><type>GUPnPControlPoint</type></link> that received the signal
287
</simpara></listitem></varlistentry>
288
<varlistentry><term><parameter>proxy</parameter> :</term>
289
<listitem><simpara> The now unavailable <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link>
290
</simpara></listitem></varlistentry>
291
<varlistentry><term><parameter>user_data</parameter> :</term>
292
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
293
</variablelist></refsect2>