← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-daap-mdns.xml

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-daap-mdns.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-rb-daap-mdns">
 
5
<refmeta>
 
6
<refentrytitle>rb-daap-mdns</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-daap-mdns</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
typedef     <link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link>;
 
22
enum        <link linkend="RBDAAPmDNSBrowserStatus">RBDAAPmDNSBrowserStatus</link>;
 
23
<link linkend="void">void</link>        (<link linkend="RBDAAPmDNSBrowserCallback">*RBDAAPmDNSBrowserCallback</link>)    (<link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link> browser,
 
24
                                             <link linkend="RBDAAPmDNSBrowserStatus">RBDAAPmDNSBrowserStatus</link> status,
 
25
                                             const <link linkend="gchar">gchar</link> *service_name,
 
26
                                             <link linkend="gpointer">gpointer</link> user_data);
 
27
<link linkend="gboolean">gboolean</link>    <link linkend="rb-daap-mdns-browse">rb_daap_mdns_browse</link>             (<link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link> *browser,
 
28
                                             <link linkend="RBDAAPmDNSBrowserCallback">RBDAAPmDNSBrowserCallback</link> callback,
 
29
                                             <link linkend="gpointer">gpointer</link> data);
 
30
<link linkend="void">void</link>        <link linkend="rb-daap-mdns-browse-cancel">rb_daap_mdns_browse_cancel</link>      (<link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link> browser);
 
31
typedef     <link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link>;
 
32
enum        <link linkend="RBDAAPmDNSResolverStatus">RBDAAPmDNSResolverStatus</link>;
 
33
<link linkend="void">void</link>        (<link linkend="RBDAAPmDNSResolverCallback">*RBDAAPmDNSResolverCallback</link>)   (<link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link> resolver,
 
34
                                             <link linkend="RBDAAPmDNSResolverStatus">RBDAAPmDNSResolverStatus</link> status,
 
35
                                             const <link linkend="gchar">gchar</link> *service_name,
 
36
                                             <link linkend="gchar">gchar</link> *name,
 
37
                                             <link linkend="gchar">gchar</link> *host,
 
38
                                             <link linkend="guint">guint</link> port,
 
39
                                             <link linkend="gboolean">gboolean</link> password_protected,
 
40
                                             <link linkend="gpointer">gpointer</link> user_data);
 
41
<link linkend="gboolean">gboolean</link>    <link linkend="rb-daap-mdns-resolve">rb_daap_mdns_resolve</link>            (<link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link> *resolver,
 
42
                                             const <link linkend="gchar">gchar</link> *name,
 
43
                                             <link linkend="RBDAAPmDNSResolverCallback">RBDAAPmDNSResolverCallback</link> callback,
 
44
                                             <link linkend="gpointer">gpointer</link> data);
 
45
<link linkend="void">void</link>        <link linkend="rb-daap-mdns-resolve-cancel">rb_daap_mdns_resolve_cancel</link>     (<link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link> resolver);
 
46
typedef     <link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link>;
 
47
enum        <link linkend="RBDAAPmDNSPublisherStatus">RBDAAPmDNSPublisherStatus</link>;
 
48
<link linkend="gchar">gchar</link>*      (<link linkend="RBDAAPmDNSPublisherCallback">*RBDAAPmDNSPublisherCallback</link>)  (<link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link> publisher,
 
49
                                             <link linkend="RBDAAPmDNSPublisherStatus">RBDAAPmDNSPublisherStatus</link> status,
 
50
                                             <link linkend="gpointer">gpointer</link> user_data);
 
51
<link linkend="gboolean">gboolean</link>    <link linkend="rb-daap-mdns-publish">rb_daap_mdns_publish</link>            (<link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link> *publisher,
 
52
                                             const <link linkend="gchar">gchar</link> *name,
 
53
                                             <link linkend="guint">guint</link> port,
 
54
                                             <link linkend="RBDAAPmDNSPublisherCallback">RBDAAPmDNSPublisherCallback</link> callback,
 
55
                                             <link linkend="gpointer">gpointer</link> user_data);
 
56
<link linkend="void">void</link>        <link linkend="rb-daap-mdns-publish-cancel">rb_daap_mdns_publish_cancel</link>     (<link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link> publisher);
 
57
</synopsis>
 
58
</refsynopsisdiv>
 
59
 
 
60
 
 
61
 
 
62
 
 
63
 
 
64
 
 
65
 
 
66
 
 
67
 
 
68
<refsect1>
 
69
<title>Description</title>
 
70
<para>
 
71
 
 
72
</para>
 
73
</refsect1>
 
74
 
 
75
<refsect1>
 
76
<title>Details</title>
 
77
<refsect2>
 
78
<title><anchor id="RBDAAPmDNSBrowser"/>RBDAAPmDNSBrowser</title>
 
79
<indexterm><primary>RBDAAPmDNSBrowser</primary></indexterm><programlisting>typedef gpointer RBDAAPmDNSBrowser;
 
80
</programlisting>
 
81
<para>
 
82
 
 
83
</para></refsect2>
 
84
<refsect2>
 
85
<title><anchor id="RBDAAPmDNSBrowserStatus"/>enum RBDAAPmDNSBrowserStatus</title>
 
86
<indexterm><primary>RBDAAPmDNSBrowserStatus</primary></indexterm><programlisting>typedef enum {
 
87
        RB_DAAP_MDNS_BROWSER_ADD_SERVICE = 1,
 
88
        RB_DAAP_MDNS_BROWSER_REMOVE_SERVICE
 
89
} RBDAAPmDNSBrowserStatus;
 
90
</programlisting>
 
91
<para>
 
92
 
 
93
</para></refsect2>
 
94
<refsect2>
 
95
<title><anchor id="RBDAAPmDNSBrowserCallback"/>RBDAAPmDNSBrowserCallback ()</title>
 
96
<indexterm><primary>RBDAAPmDNSBrowserCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*RBDAAPmDNSBrowserCallback)    (<link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link> browser,
 
97
                                             <link linkend="RBDAAPmDNSBrowserStatus">RBDAAPmDNSBrowserStatus</link> status,
 
98
                                             const <link linkend="gchar">gchar</link> *service_name,
 
99
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
100
<para>
 
101
 
 
102
</para><variablelist role="params">
 
103
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
104
<listitem><simpara>
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
 
107
<listitem><simpara>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><parameter>service_name</parameter>&nbsp;:</term>
 
110
<listitem><simpara>
 
111
</simpara></listitem></varlistentry>
 
112
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
113
<listitem><simpara>
 
114
 
 
115
 
 
116
</simpara></listitem></varlistentry>
 
117
</variablelist></refsect2>
 
118
<refsect2>
 
119
<title><anchor id="rb-daap-mdns-browse"/>rb_daap_mdns_browse ()</title>
 
120
<indexterm><primary>rb_daap_mdns_browse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_daap_mdns_browse             (<link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link> *browser,
 
121
                                             <link linkend="RBDAAPmDNSBrowserCallback">RBDAAPmDNSBrowserCallback</link> callback,
 
122
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
123
<para>
 
124
 
 
125
</para><variablelist role="params">
 
126
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
127
<listitem><simpara>
 
128
</simpara></listitem></varlistentry>
 
129
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
130
<listitem><simpara>
 
131
</simpara></listitem></varlistentry>
 
132
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
133
<listitem><simpara>
 
134
</simpara></listitem></varlistentry>
 
135
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
136
 
 
137
 
 
138
</simpara></listitem></varlistentry>
 
139
</variablelist></refsect2>
 
140
<refsect2>
 
141
<title><anchor id="rb-daap-mdns-browse-cancel"/>rb_daap_mdns_browse_cancel ()</title>
 
142
<indexterm><primary>rb_daap_mdns_browse_cancel</primary></indexterm><programlisting><link linkend="void">void</link>        rb_daap_mdns_browse_cancel      (<link linkend="RBDAAPmDNSBrowser">RBDAAPmDNSBrowser</link> browser);</programlisting>
 
143
<para>
 
144
 
 
145
</para><variablelist role="params">
 
146
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
147
<listitem><simpara>
 
148
 
 
149
 
 
150
</simpara></listitem></varlistentry>
 
151
</variablelist></refsect2>
 
152
<refsect2>
 
153
<title><anchor id="RBDAAPmDNSResolver"/>RBDAAPmDNSResolver</title>
 
154
<indexterm><primary>RBDAAPmDNSResolver</primary></indexterm><programlisting>typedef gpointer RBDAAPmDNSResolver;
 
155
</programlisting>
 
156
<para>
 
157
 
 
158
</para></refsect2>
 
159
<refsect2>
 
160
<title><anchor id="RBDAAPmDNSResolverStatus"/>enum RBDAAPmDNSResolverStatus</title>
 
161
<indexterm><primary>RBDAAPmDNSResolverStatus</primary></indexterm><programlisting>typedef enum {
 
162
        RB_DAAP_MDNS_RESOLVER_FOUND = 1,
 
163
        RB_DAAP_MDNS_RESOLVER_TIMEOUT
 
164
} RBDAAPmDNSResolverStatus;
 
165
</programlisting>
 
166
<para>
 
167
 
 
168
</para></refsect2>
 
169
<refsect2>
 
170
<title><anchor id="RBDAAPmDNSResolverCallback"/>RBDAAPmDNSResolverCallback ()</title>
 
171
<indexterm><primary>RBDAAPmDNSResolverCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*RBDAAPmDNSResolverCallback)   (<link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link> resolver,
 
172
                                             <link linkend="RBDAAPmDNSResolverStatus">RBDAAPmDNSResolverStatus</link> status,
 
173
                                             const <link linkend="gchar">gchar</link> *service_name,
 
174
                                             <link linkend="gchar">gchar</link> *name,
 
175
                                             <link linkend="gchar">gchar</link> *host,
 
176
                                             <link linkend="guint">guint</link> port,
 
177
                                             <link linkend="gboolean">gboolean</link> password_protected,
 
178
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
179
<para>
 
180
 
 
181
</para><variablelist role="params">
 
182
<varlistentry><term><parameter>resolver</parameter>&nbsp;:</term>
 
183
<listitem><simpara>
 
184
</simpara></listitem></varlistentry>
 
185
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
 
186
<listitem><simpara>
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><parameter>service_name</parameter>&nbsp;:</term>
 
189
<listitem><simpara>
 
190
</simpara></listitem></varlistentry>
 
191
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
192
<listitem><simpara>
 
193
</simpara></listitem></varlistentry>
 
194
<varlistentry><term><parameter>host</parameter>&nbsp;:</term>
 
195
<listitem><simpara>
 
196
</simpara></listitem></varlistentry>
 
197
<varlistentry><term><parameter>port</parameter>&nbsp;:</term>
 
198
<listitem><simpara>
 
199
</simpara></listitem></varlistentry>
 
200
<varlistentry><term><parameter>password_protected</parameter>&nbsp;:</term>
 
201
<listitem><simpara>
 
202
</simpara></listitem></varlistentry>
 
203
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
204
<listitem><simpara>
 
205
 
 
206
 
 
207
</simpara></listitem></varlistentry>
 
208
</variablelist></refsect2>
 
209
<refsect2>
 
210
<title><anchor id="rb-daap-mdns-resolve"/>rb_daap_mdns_resolve ()</title>
 
211
<indexterm><primary>rb_daap_mdns_resolve</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_daap_mdns_resolve            (<link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link> *resolver,
 
212
                                             const <link linkend="gchar">gchar</link> *name,
 
213
                                             <link linkend="RBDAAPmDNSResolverCallback">RBDAAPmDNSResolverCallback</link> callback,
 
214
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
215
<para>
 
216
 
 
217
</para><variablelist role="params">
 
218
<varlistentry><term><parameter>resolver</parameter>&nbsp;:</term>
 
219
<listitem><simpara>
 
220
</simpara></listitem></varlistentry>
 
221
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
222
<listitem><simpara>
 
223
</simpara></listitem></varlistentry>
 
224
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
225
<listitem><simpara>
 
226
</simpara></listitem></varlistentry>
 
227
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
228
<listitem><simpara>
 
229
</simpara></listitem></varlistentry>
 
230
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
231
 
 
232
 
 
233
</simpara></listitem></varlistentry>
 
234
</variablelist></refsect2>
 
235
<refsect2>
 
236
<title><anchor id="rb-daap-mdns-resolve-cancel"/>rb_daap_mdns_resolve_cancel ()</title>
 
237
<indexterm><primary>rb_daap_mdns_resolve_cancel</primary></indexterm><programlisting><link linkend="void">void</link>        rb_daap_mdns_resolve_cancel     (<link linkend="RBDAAPmDNSResolver">RBDAAPmDNSResolver</link> resolver);</programlisting>
 
238
<para>
 
239
 
 
240
</para><variablelist role="params">
 
241
<varlistentry><term><parameter>resolver</parameter>&nbsp;:</term>
 
242
<listitem><simpara>
 
243
 
 
244
 
 
245
</simpara></listitem></varlistentry>
 
246
</variablelist></refsect2>
 
247
<refsect2>
 
248
<title><anchor id="RBDAAPmDNSPublisher"/>RBDAAPmDNSPublisher</title>
 
249
<indexterm><primary>RBDAAPmDNSPublisher</primary></indexterm><programlisting>typedef gpointer RBDAAPmDNSPublisher;
 
250
</programlisting>
 
251
<para>
 
252
 
 
253
</para></refsect2>
 
254
<refsect2>
 
255
<title><anchor id="RBDAAPmDNSPublisherStatus"/>enum RBDAAPmDNSPublisherStatus</title>
 
256
<indexterm><primary>RBDAAPmDNSPublisherStatus</primary></indexterm><programlisting>typedef enum {
 
257
        RB_DAAP_MDNS_PUBLISHER_STARTED = 1,
 
258
        RB_DAAP_MDNS_PUBLISHER_COLLISION
 
259
} RBDAAPmDNSPublisherStatus;
 
260
</programlisting>
 
261
<para>
 
262
 
 
263
</para></refsect2>
 
264
<refsect2>
 
265
<title><anchor id="RBDAAPmDNSPublisherCallback"/>RBDAAPmDNSPublisherCallback ()</title>
 
266
<indexterm><primary>RBDAAPmDNSPublisherCallback</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      (*RBDAAPmDNSPublisherCallback)  (<link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link> publisher,
 
267
                                             <link linkend="RBDAAPmDNSPublisherStatus">RBDAAPmDNSPublisherStatus</link> status,
 
268
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
269
<para>
 
270
 
 
271
</para><variablelist role="params">
 
272
<varlistentry><term><parameter>publisher</parameter>&nbsp;:</term>
 
273
<listitem><simpara>
 
274
</simpara></listitem></varlistentry>
 
275
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
 
276
<listitem><simpara>
 
277
</simpara></listitem></varlistentry>
 
278
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
279
<listitem><simpara>
 
280
</simpara></listitem></varlistentry>
 
281
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
282
 
 
283
 
 
284
</simpara></listitem></varlistentry>
 
285
</variablelist></refsect2>
 
286
<refsect2>
 
287
<title><anchor id="rb-daap-mdns-publish"/>rb_daap_mdns_publish ()</title>
 
288
<indexterm><primary>rb_daap_mdns_publish</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_daap_mdns_publish            (<link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link> *publisher,
 
289
                                             const <link linkend="gchar">gchar</link> *name,
 
290
                                             <link linkend="guint">guint</link> port,
 
291
                                             <link linkend="RBDAAPmDNSPublisherCallback">RBDAAPmDNSPublisherCallback</link> callback,
 
292
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
293
<para>
 
294
 
 
295
</para><variablelist role="params">
 
296
<varlistentry><term><parameter>publisher</parameter>&nbsp;:</term>
 
297
<listitem><simpara>
 
298
</simpara></listitem></varlistentry>
 
299
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
300
<listitem><simpara>
 
301
</simpara></listitem></varlistentry>
 
302
<varlistentry><term><parameter>port</parameter>&nbsp;:</term>
 
303
<listitem><simpara>
 
304
</simpara></listitem></varlistentry>
 
305
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
306
<listitem><simpara>
 
307
</simpara></listitem></varlistentry>
 
308
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
309
<listitem><simpara>
 
310
</simpara></listitem></varlistentry>
 
311
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
312
 
 
313
 
 
314
</simpara></listitem></varlistentry>
 
315
</variablelist></refsect2>
 
316
<refsect2>
 
317
<title><anchor id="rb-daap-mdns-publish-cancel"/>rb_daap_mdns_publish_cancel ()</title>
 
318
<indexterm><primary>rb_daap_mdns_publish_cancel</primary></indexterm><programlisting><link linkend="void">void</link>        rb_daap_mdns_publish_cancel     (<link linkend="RBDAAPmDNSPublisher">RBDAAPmDNSPublisher</link> publisher);</programlisting>
 
319
<para>
 
320
 
 
321
</para><variablelist role="params">
 
322
<varlistentry><term><parameter>publisher</parameter>&nbsp;:</term>
 
323
<listitem><simpara>
 
324
 
 
325
 
 
326
</simpara></listitem></varlistentry>
 
327
</variablelist></refsect2>
 
328
 
 
329
</refsect1>
 
330
 
 
331
 
 
332
 
 
333
 
 
334
</refentry>