← 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-inet-connection.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-inet-connection.xml
1
1
<refentry id="gnome-vfs-20-gnome-vfs-inet-connection">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">Internet connection</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-inet-connection.top_of_page">Internet connection</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-inet-connection.synopsis" role="synopsis">
15
15
<title role="synopsis.title">Synopsis</title>
16
16
 
17
17
<synopsis>
18
 
 
19
 
 
20
 
 
21
18
typedef             <link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link>;
22
19
<link linkend="GnomeVFSResult">GnomeVFSResult</link>      <link linkend="gnome-vfs-inet-connection-create">gnome_vfs_inet_connection_create</link>    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
23
20
                                                         const <link linkend="gchar">gchar</link> *host_name,
50
47
 
51
48
 
52
49
 
53
 
<refsect1 role="desc">
 
50
<refsect1 id="gnome-vfs-20-gnome-vfs-inet-connection.description" role="desc">
54
51
<title role="desc.title">Description</title>
55
52
<para>
56
53
A <link linkend="GnomeVFSInetConnection"><type>GnomeVFSInetConnection</type></link> represents a TCP/IP connection. You can either use
65
62
</para>
66
63
</refsect1>
67
64
 
68
 
<refsect1 role="details">
 
65
<refsect1 id="gnome-vfs-20-gnome-vfs-inet-connection.details" role="details">
69
66
<title role="details.title">Details</title>
70
 
<refsect2>
71
 
<title><anchor id="GnomeVFSInetConnection" role="typedef"/>GnomeVFSInetConnection</title>
72
 
<indexterm><primary>GnomeVFSInetConnection</primary></indexterm><programlisting>typedef struct GnomeVFSInetConnection GnomeVFSInetConnection;
 
67
<refsect2 id="GnomeVFSInetConnection" role="typedef">
 
68
<title>GnomeVFSInetConnection</title>
 
69
<indexterm zone="GnomeVFSInetConnection"><primary>GnomeVFSInetConnection</primary></indexterm><programlisting>typedef struct GnomeVFSInetConnection GnomeVFSInetConnection;
73
70
</programlisting>
74
71
<para>
75
72
 
76
73
</para></refsect2>
77
 
<refsect2>
78
 
<title><anchor id="gnome-vfs-inet-connection-create" role="function"/>gnome_vfs_inet_connection_create ()</title>
79
 
<indexterm><primary>gnome_vfs_inet_connection_create</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
 
74
<refsect2 id="gnome-vfs-inet-connection-create" role="function">
 
75
<title>gnome_vfs_inet_connection_create ()</title>
 
76
<indexterm zone="gnome-vfs-inet-connection-create"><primary>gnome_vfs_inet_connection_create</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
80
77
                                                         const <link linkend="gchar">gchar</link> *host_name,
81
78
                                                         <link linkend="guint">guint</link> host_port,
82
79
                                                         <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
102
99
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="GnomeVFSResult"><type>GnomeVFSResult</type></link> indicating the success of the operation.
103
100
</simpara></listitem></varlistentry>
104
101
</variablelist></refsect2>
105
 
<refsect2>
106
 
<title><anchor id="gnome-vfs-inet-connection-destroy" role="function"/>gnome_vfs_inet_connection_destroy ()</title>
107
 
<indexterm><primary>gnome_vfs_inet_connection_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_inet_connection_destroy   (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
 
102
<refsect2 id="gnome-vfs-inet-connection-destroy" role="function">
 
103
<title>gnome_vfs_inet_connection_destroy ()</title>
 
104
<indexterm zone="gnome-vfs-inet-connection-destroy"><primary>gnome_vfs_inet_connection_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_inet_connection_destroy   (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
108
105
                                                         <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
109
106
<para>
110
107
Closes/Destroys <parameter>connection</parameter>.</para>
118
115
<listitem><simpara> handle for cancelling the operation.
119
116
</simpara></listitem></varlistentry>
120
117
</variablelist></refsect2>
121
 
<refsect2>
122
 
<title><anchor id="gnome-vfs-inet-connection-free" role="function"/>gnome_vfs_inet_connection_free ()</title>
123
 
<indexterm><primary>gnome_vfs_inet_connection_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_inet_connection_free      (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
 
118
<refsect2 id="gnome-vfs-inet-connection-free" role="function">
 
119
<title>gnome_vfs_inet_connection_free ()</title>
 
120
<indexterm zone="gnome-vfs-inet-connection-free"><primary>gnome_vfs_inet_connection_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_inet_connection_free      (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
124
121
                                                         <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
125
122
<para>
126
123
Frees <parameter>connection</parameter> without closing the socket.</para>
134
131
<listitem><simpara> handle for cancelling the operation.
135
132
</simpara></listitem></varlistentry>
136
133
</variablelist></refsect2>
137
 
<refsect2>
138
 
<title><anchor id="gnome-vfs-inet-connection-to-socket" role="function"/>gnome_vfs_inet_connection_to_socket ()</title>
139
 
<indexterm><primary>gnome_vfs_inet_connection_to_socket</primary></indexterm><programlisting><link linkend="GnomeVFSSocket">GnomeVFSSocket</link>*     gnome_vfs_inet_connection_to_socket (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
 
134
<refsect2 id="gnome-vfs-inet-connection-to-socket" role="function">
 
135
<title>gnome_vfs_inet_connection_to_socket ()</title>
 
136
<indexterm zone="gnome-vfs-inet-connection-to-socket"><primary>gnome_vfs_inet_connection_to_socket</primary></indexterm><programlisting><link linkend="GnomeVFSSocket">GnomeVFSSocket</link>*     gnome_vfs_inet_connection_to_socket (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
140
137
<para>
141
138
Wrap <parameter>connection</parameter> inside a standard <link linkend="GnomeVFSSocket"><type>GnomeVFSSocket</type></link> for convenience.</para>
142
139
<para>
148
145
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly created <link linkend="GnomeVFSSocket"><type>GnomeVFSSocket</type></link> around <parameter>connection</parameter>.
149
146
</simpara></listitem></varlistentry>
150
147
</variablelist></refsect2>
151
 
<refsect2>
152
 
<title><anchor id="gnome-vfs-inet-connection-to-socket-buffer" role="function"/>gnome_vfs_inet_connection_to_socket_buffer ()</title>
153
 
<indexterm><primary>gnome_vfs_inet_connection_to_socket_buffer</primary></indexterm><programlisting><link linkend="GnomeVFSSocketBuffer">GnomeVFSSocketBuffer</link>* gnome_vfs_inet_connection_to_socket_buffer
 
148
<refsect2 id="gnome-vfs-inet-connection-to-socket-buffer" role="function">
 
149
<title>gnome_vfs_inet_connection_to_socket_buffer ()</title>
 
150
<indexterm zone="gnome-vfs-inet-connection-to-socket-buffer"><primary>gnome_vfs_inet_connection_to_socket_buffer</primary></indexterm><programlisting><link linkend="GnomeVFSSocketBuffer">GnomeVFSSocketBuffer</link>* gnome_vfs_inet_connection_to_socket_buffer
154
151
                                                        (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
155
152
<para>
156
153
Wrap <parameter>connection</parameter> inside a standard <link linkend="GnomeVFSSocketBuffer"><type>GnomeVFSSocketBuffer</type></link> for convenience.</para>
163
160
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly created <link linkend="GnomeVFSSocketBuffer"><type>GnomeVFSSocketBuffer</type></link> around <parameter>connection</parameter>.
164
161
</simpara></listitem></varlistentry>
165
162
</variablelist></refsect2>
166
 
<refsect2>
167
 
<title><anchor id="gnome-vfs-inet-connection-get-fd" role="function"/>gnome_vfs_inet_connection_get_fd ()</title>
168
 
<indexterm><primary>gnome_vfs_inet_connection_get_fd</primary></indexterm><programlisting><link linkend="int">int</link>                 gnome_vfs_inet_connection_get_fd    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
 
163
<refsect2 id="gnome-vfs-inet-connection-get-fd" role="function">
 
164
<title>gnome_vfs_inet_connection_get_fd ()</title>
 
165
<indexterm zone="gnome-vfs-inet-connection-get-fd"><primary>gnome_vfs_inet_connection_get_fd</primary></indexterm><programlisting><link linkend="int">int</link>                 gnome_vfs_inet_connection_get_fd    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
169
166
<para>
170
167
Retrieve the UNIX file descriptor corresponding to <parameter>connection</parameter>.</para>
171
168
<para>
177
174
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> file descriptor.
178
175
</simpara></listitem></varlistentry>
179
176
</variablelist></refsect2>
180
 
<refsect2>
181
 
<title><anchor id="gnome-vfs-inet-connection-create-from-address" role="function" condition="since:2.8"/>gnome_vfs_inet_connection_create_from_address ()</title>
182
 
<indexterm role="2.8"><primary>gnome_vfs_inet_connection_create_from_address</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create_from_address
 
177
<refsect2 id="gnome-vfs-inet-connection-create-from-address" role="function" condition="since:2.8">
 
178
<title>gnome_vfs_inet_connection_create_from_address ()</title>
 
179
<indexterm zone="gnome-vfs-inet-connection-create-from-address" role="2.8"><primary>gnome_vfs_inet_connection_create_from_address</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create_from_address
183
180
                                                        (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
184
181
                                                         <link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address,
185
182
                                                         <link linkend="guint">guint</link> host_port,
208
205
</simpara></listitem></varlistentry>
209
206
</variablelist><para role="since">Since  2.8
210
207
</para></refsect2>
211
 
<refsect2>
212
 
<title><anchor id="gnome-vfs-inet-connection-get-address" role="function"/>gnome_vfs_inet_connection_get_address ()</title>
213
 
<indexterm><primary>gnome_vfs_inet_connection_get_address</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link>*    gnome_vfs_inet_connection_get_address
 
208
<refsect2 id="gnome-vfs-inet-connection-get-address" role="function">
 
209
<title>gnome_vfs_inet_connection_get_address ()</title>
 
210
<indexterm zone="gnome-vfs-inet-connection-get-address"><primary>gnome_vfs_inet_connection_get_address</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link>*    gnome_vfs_inet_connection_get_address
214
211
                                                        (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
215
212
<para>
216
213
Retrieve the address of the other side of a connected <parameter>connection</parameter>.</para>
225
222
Since 2.8
226
223
</simpara></listitem></varlistentry>
227
224
</variablelist></refsect2>
228
 
<refsect2>
229
 
<title><anchor id="gnome-vfs-inet-connection-get-ip" role="function" condition="since:2.8"/>gnome_vfs_inet_connection_get_ip ()</title>
230
 
<indexterm role="2.8"><primary>gnome_vfs_inet_connection_get_ip</primary></indexterm><programlisting><link linkend="char">char</link>*               gnome_vfs_inet_connection_get_ip    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
 
225
<refsect2 id="gnome-vfs-inet-connection-get-ip" role="function" condition="since:2.8">
 
226
<title>gnome_vfs_inet_connection_get_ip ()</title>
 
227
<indexterm zone="gnome-vfs-inet-connection-get-ip" role="2.8"><primary>gnome_vfs_inet_connection_get_ip</primary></indexterm><programlisting><link linkend="char">char</link>*               gnome_vfs_inet_connection_get_ip    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
231
228
<para>
232
229
Retrieve the ip address of the other side of a connected <parameter>connection</parameter>.</para>
233
230
<para>