← Back to branch summary

~adam-stokes/ubuntu/quantal/gnome-vfs/lp977940-multiarch

« back to all changes in this revision

Viewing changes to doc/xml/gnome-vfs-dns-sd.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-08-05 10:31:15 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080805103115-5vkex0yk6qq619x5
Tags: 1:2.23.0-0ubuntu1
* New upstream version:
  - Sync xdgmime with GIO
* debian/patches/90_from_svn_no_range_for_youtube.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gnome-vfs-dns-sd.xml
1
1
<refentry id="gnome-vfs-20-gnome-vfs-dns-sd">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">Zeroconf networking support</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-dns-sd.top_of_page">Zeroconf networking support</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
6
6
</refmeta>
11
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
12
</refnamediv>
13
13
 
14
 
<refsynopsisdiv role="synopsis">
 
14
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-dns-sd.synopsis" role="synopsis">
15
15
<title role="synopsis.title">Synopsis</title>
16
16
 
17
17
<synopsis>
18
 
 
19
 
 
20
 
 
21
18
<link linkend="void">void</link>                (<link linkend="GnomeVFSDNSSDResolveCallback">*GnomeVFSDNSSDResolveCallback</link>)     (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> *handle,
22
19
                                                         <link linkend="GnomeVFSResult">GnomeVFSResult</link> result,
23
20
                                                         const <link linkend="GnomeVFSDNSSDService">GnomeVFSDNSSDService</link> *service,
82
79
 
83
80
 
84
81
 
85
 
<refsect1 role="desc">
 
82
<refsect1 id="gnome-vfs-20-gnome-vfs-dns-sd.description" role="desc">
86
83
<title role="desc.title">Description</title>
87
84
<para>
88
85
 
89
86
</para>
90
87
</refsect1>
91
88
 
92
 
<refsect1 role="details">
 
89
<refsect1 id="gnome-vfs-20-gnome-vfs-dns-sd.details" role="details">
93
90
<title role="details.title">Details</title>
94
 
<refsect2>
95
 
<title><anchor id="GnomeVFSDNSSDResolveCallback" role="function"/>GnomeVFSDNSSDResolveCallback ()</title>
96
 
<indexterm><primary>GnomeVFSDNSSDResolveCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSDNSSDResolveCallback)     (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> *handle,
 
91
<refsect2 id="GnomeVFSDNSSDResolveCallback" role="function">
 
92
<title>GnomeVFSDNSSDResolveCallback ()</title>
 
93
<indexterm zone="GnomeVFSDNSSDResolveCallback"><primary>GnomeVFSDNSSDResolveCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSDNSSDResolveCallback)     (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> *handle,
97
94
                                                         <link linkend="GnomeVFSResult">GnomeVFSResult</link> result,
98
95
                                                         const <link linkend="GnomeVFSDNSSDService">GnomeVFSDNSSDService</link> *service,
99
96
                                                         const <link linkend="char">char</link> *host,
146
143
<listitem><simpara> user data defined when the callback was established
147
144
</simpara></listitem></varlistentry>
148
145
</variablelist></refsect2>
149
 
<refsect2>
150
 
<title><anchor id="GnomeVFSDNSSDServiceStatus" role="enum"/>enum GnomeVFSDNSSDServiceStatus</title>
151
 
<indexterm><primary>GnomeVFSDNSSDServiceStatus</primary></indexterm><programlisting>typedef enum {
 
146
<refsect2 id="GnomeVFSDNSSDServiceStatus" role="enum">
 
147
<title>enum GnomeVFSDNSSDServiceStatus</title>
 
148
<indexterm zone="GnomeVFSDNSSDServiceStatus"><primary>GnomeVFSDNSSDServiceStatus</primary></indexterm><programlisting>typedef enum {
152
149
        GNOME_VFS_DNS_SD_SERVICE_ADDED,
153
150
        GNOME_VFS_DNS_SD_SERVICE_REMOVED
154
151
} GnomeVFSDNSSDServiceStatus;
156
153
<para>
157
154
 
158
155
</para></refsect2>
159
 
<refsect2>
160
 
<title><anchor id="GnomeVFSDNSSDService" role="struct"/>GnomeVFSDNSSDService</title>
161
 
<indexterm><primary>GnomeVFSDNSSDService</primary></indexterm><programlisting>typedef struct {
 
156
<refsect2 id="GnomeVFSDNSSDService" role="struct">
 
157
<title>GnomeVFSDNSSDService</title>
 
158
<indexterm zone="GnomeVFSDNSSDService"><primary>GnomeVFSDNSSDService</primary></indexterm><programlisting>typedef struct {
162
159
        char *name;
163
160
        char *type;
164
161
        char *domain;
167
164
<para>
168
165
 
169
166
</para></refsect2>
170
 
<refsect2>
171
 
<title><anchor id="GnomeVFSDNSSDBrowseCallback" role="function"/>GnomeVFSDNSSDBrowseCallback ()</title>
172
 
<indexterm><primary>GnomeVFSDNSSDBrowseCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSDNSSDBrowseCallback)      (<link linkend="GnomeVFSDNSSDBrowseHandle">GnomeVFSDNSSDBrowseHandle</link> *handle,
 
167
<refsect2 id="GnomeVFSDNSSDBrowseCallback" role="function">
 
168
<title>GnomeVFSDNSSDBrowseCallback ()</title>
 
169
<indexterm zone="GnomeVFSDNSSDBrowseCallback"><primary>GnomeVFSDNSSDBrowseCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSDNSSDBrowseCallback)      (<link linkend="GnomeVFSDNSSDBrowseHandle">GnomeVFSDNSSDBrowseHandle</link> *handle,
173
170
                                                         <link linkend="GnomeVFSDNSSDServiceStatus">GnomeVFSDNSSDServiceStatus</link> status,
174
171
                                                         const <link linkend="GnomeVFSDNSSDService">GnomeVFSDNSSDService</link> *service,
175
172
                                                         <link linkend="gpointer">gpointer</link> callback_data);</programlisting>
192
189
<listitem><simpara> user data defined when the callback was established
193
190
</simpara></listitem></varlistentry>
194
191
</variablelist></refsect2>
195
 
<refsect2>
196
 
<title><anchor id="gnome-vfs-dns-sd-browse" role="function"/>gnome_vfs_dns_sd_browse ()</title>
197
 
<indexterm><primary>gnome_vfs_dns_sd_browse</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_browse             (<link linkend="GnomeVFSDNSSDBrowseHandle">GnomeVFSDNSSDBrowseHandle</link> **handle,
 
192
<refsect2 id="gnome-vfs-dns-sd-browse" role="function">
 
193
<title>gnome_vfs_dns_sd_browse ()</title>
 
194
<indexterm zone="gnome-vfs-dns-sd-browse"><primary>gnome_vfs_dns_sd_browse</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_browse             (<link linkend="GnomeVFSDNSSDBrowseHandle">GnomeVFSDNSSDBrowseHandle</link> **handle,
198
195
                                                         const <link linkend="char">char</link> *domain,
199
196
                                                         const <link linkend="char">char</link> *type,
200
197
                                                         <link linkend="GnomeVFSDNSSDBrowseCallback">GnomeVFSDNSSDBrowseCallback</link> callback,
237
234
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
238
235
</simpara></listitem></varlistentry>
239
236
</variablelist></refsect2>
240
 
<refsect2>
241
 
<title><anchor id="gnome-vfs-dns-sd-stop-browse" role="function"/>gnome_vfs_dns_sd_stop_browse ()</title>
242
 
<indexterm><primary>gnome_vfs_dns_sd_stop_browse</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_stop_browse        (<link linkend="GnomeVFSDNSSDBrowseHandle">GnomeVFSDNSSDBrowseHandle</link> *handle);</programlisting>
 
237
<refsect2 id="gnome-vfs-dns-sd-stop-browse" role="function">
 
238
<title>gnome_vfs_dns_sd_stop_browse ()</title>
 
239
<indexterm zone="gnome-vfs-dns-sd-stop-browse"><primary>gnome_vfs_dns_sd_stop_browse</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_stop_browse        (<link linkend="GnomeVFSDNSSDBrowseHandle">GnomeVFSDNSSDBrowseHandle</link> *handle);</programlisting>
243
240
<para>
244
241
Stops browsing a domain started with <link linkend="gnome-vfs-dns-sd-browse"><function>gnome_vfs_dns_sd_browse()</function></link>.</para>
245
242
<para>
251
248
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
252
249
</simpara></listitem></varlistentry>
253
250
</variablelist></refsect2>
254
 
<refsect2>
255
 
<title><anchor id="gnome-vfs-dns-sd-resolve" role="function"/>gnome_vfs_dns_sd_resolve ()</title>
256
 
<indexterm><primary>gnome_vfs_dns_sd_resolve</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_resolve            (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> **handle,
 
251
<refsect2 id="gnome-vfs-dns-sd-resolve" role="function">
 
252
<title>gnome_vfs_dns_sd_resolve ()</title>
 
253
<indexterm zone="gnome-vfs-dns-sd-resolve"><primary>gnome_vfs_dns_sd_resolve</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_resolve            (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> **handle,
257
254
                                                         const <link linkend="char">char</link> *name,
258
255
                                                         const <link linkend="char">char</link> *type,
259
256
                                                         const <link linkend="char">char</link> *domain,
304
301
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
305
302
</simpara></listitem></varlistentry>
306
303
</variablelist></refsect2>
307
 
<refsect2>
308
 
<title><anchor id="gnome-vfs-dns-sd-cancel-resolve" role="function"/>gnome_vfs_dns_sd_cancel_resolve ()</title>
309
 
<indexterm><primary>gnome_vfs_dns_sd_cancel_resolve</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_cancel_resolve     (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> *handle);</programlisting>
 
304
<refsect2 id="gnome-vfs-dns-sd-cancel-resolve" role="function">
 
305
<title>gnome_vfs_dns_sd_cancel_resolve ()</title>
 
306
<indexterm zone="gnome-vfs-dns-sd-cancel-resolve"><primary>gnome_vfs_dns_sd_cancel_resolve</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_cancel_resolve     (<link linkend="GnomeVFSDNSSDResolveHandle">GnomeVFSDNSSDResolveHandle</link> *handle);</programlisting>
310
307
<para>
311
308
Cancels resolving a service started with <link linkend="gnome-vfs-dns-sd-resolve"><function>gnome_vfs_dns_sd_resolve()</function></link>.</para>
312
309
<para>
318
315
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
319
316
</simpara></listitem></varlistentry>
320
317
</variablelist></refsect2>
321
 
<refsect2>
322
 
<title><anchor id="gnome-vfs-dns-sd-browse-sync" role="function"/>gnome_vfs_dns_sd_browse_sync ()</title>
323
 
<indexterm><primary>gnome_vfs_dns_sd_browse_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_browse_sync        (const <link linkend="char">char</link> *domain,
 
318
<refsect2 id="gnome-vfs-dns-sd-browse-sync" role="function">
 
319
<title>gnome_vfs_dns_sd_browse_sync ()</title>
 
320
<indexterm zone="gnome-vfs-dns-sd-browse-sync"><primary>gnome_vfs_dns_sd_browse_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_browse_sync        (const <link linkend="char">char</link> *domain,
324
321
                                                         const <link linkend="char">char</link> *type,
325
322
                                                         <link linkend="int">int</link> timeout_msec,
326
323
                                                         <link linkend="int">int</link> *n_services,
361
358
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
362
359
</simpara></listitem></varlistentry>
363
360
</variablelist></refsect2>
364
 
<refsect2>
365
 
<title><anchor id="gnome-vfs-dns-sd-resolve-sync" role="function"/>gnome_vfs_dns_sd_resolve_sync ()</title>
366
 
<indexterm><primary>gnome_vfs_dns_sd_resolve_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_resolve_sync       (const <link linkend="char">char</link> *name,
 
361
<refsect2 id="gnome-vfs-dns-sd-resolve-sync" role="function">
 
362
<title>gnome_vfs_dns_sd_resolve_sync ()</title>
 
363
<indexterm zone="gnome-vfs-dns-sd-resolve-sync"><primary>gnome_vfs_dns_sd_resolve_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_resolve_sync       (const <link linkend="char">char</link> *name,
367
364
                                                         const <link linkend="char">char</link> *type,
368
365
                                                         const <link linkend="char">char</link> *domain,
369
366
                                                         <link linkend="int">int</link> timeout_msec,
413
410
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
414
411
</simpara></listitem></varlistentry>
415
412
</variablelist></refsect2>
416
 
<refsect2>
417
 
<title><anchor id="gnome-vfs-dns-sd-service-list-free" role="function"/>gnome_vfs_dns_sd_service_list_free ()</title>
418
 
<indexterm><primary>gnome_vfs_dns_sd_service_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_dns_sd_service_list_free  (<link linkend="GnomeVFSDNSSDService">GnomeVFSDNSSDService</link> *services,
 
413
<refsect2 id="gnome-vfs-dns-sd-service-list-free" role="function">
 
414
<title>gnome_vfs_dns_sd_service_list_free ()</title>
 
415
<indexterm zone="gnome-vfs-dns-sd-service-list-free"><primary>gnome_vfs_dns_sd_service_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_dns_sd_service_list_free  (<link linkend="GnomeVFSDNSSDService">GnomeVFSDNSSDService</link> *services,
419
416
                                                         <link linkend="int">int</link> n_services);</programlisting>
420
417
<para>
421
418
Frees a list of services as returned by <link linkend="gnome-vfs-dns-sd-browse-sync"><function>gnome_vfs_dns_sd_browse_sync()</function></link>.</para>
429
426
<listitem><simpara> the number of services to free.
430
427
</simpara></listitem></varlistentry>
431
428
</variablelist></refsect2>
432
 
<refsect2>
433
 
<title><anchor id="gnome-vfs-dns-sd-list-browse-domains-sync" role="function"/>gnome_vfs_dns_sd_list_browse_domains_sync ()</title>
434
 
<indexterm><primary>gnome_vfs_dns_sd_list_browse_domains_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_list_browse_domains_sync
 
429
<refsect2 id="gnome-vfs-dns-sd-list-browse-domains-sync" role="function">
 
430
<title>gnome_vfs_dns_sd_list_browse_domains_sync ()</title>
 
431
<indexterm zone="gnome-vfs-dns-sd-list-browse-domains-sync"><primary>gnome_vfs_dns_sd_list_browse_domains_sync</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_dns_sd_list_browse_domains_sync
435
432
                                                        (const <link linkend="char">char</link> *domain,
436
433
                                                         <link linkend="int">int</link> timeout_msec,
437
434
                                                         <link linkend="GList">GList</link> **domains);</programlisting>
454
451
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
455
452
</simpara></listitem></varlistentry>
456
453
</variablelist></refsect2>
457
 
<refsect2>
458
 
<title><anchor id="gnome-vfs-get-default-browse-domains" role="function"/>gnome_vfs_get_default_browse_domains ()</title>
459
 
<indexterm><primary>gnome_vfs_get_default_browse_domains</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_get_default_browse_domains
 
454
<refsect2 id="gnome-vfs-get-default-browse-domains" role="function">
 
455
<title>gnome_vfs_get_default_browse_domains ()</title>
 
456
<indexterm zone="gnome-vfs-get-default-browse-domains"><primary>gnome_vfs_get_default_browse_domains</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_get_default_browse_domains
460
457
                                                        (void);</programlisting>
461
458
<para>
462
459
Returns a list of domain names that is useful to