← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« 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: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gnome-vfs-inet-connection.xml
1
 
<refentry id="gnome-vfs-20-gnome-vfs-inet-connection">
 
1
<refentry id="gnome-vfs-2.0-gnome-vfs-inet-connection">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-inet-connection.top_of_page">Internet connection</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-2.0-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>
10
10
<refpurpose>Simple TCP/IP connection functions.</refpurpose>
11
11
</refnamediv>
12
12
 
13
 
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-inet-connection.synopsis" role="synopsis">
 
13
<refsynopsisdiv id="gnome-vfs-2.0-gnome-vfs-inet-connection.synopsis" role="synopsis">
14
14
<title role="synopsis.title">Synopsis</title>
15
15
 
16
16
<synopsis>
46
46
 
47
47
 
48
48
 
49
 
<refsect1 id="gnome-vfs-20-gnome-vfs-inet-connection.description" role="desc">
 
49
<refsect1 id="gnome-vfs-2.0-gnome-vfs-inet-connection.description" role="desc">
50
50
<title role="desc.title">Description</title>
 
51
 
51
52
<para>
52
53
A <link linkend="GnomeVFSInetConnection"><type>GnomeVFSInetConnection</type></link> represents a TCP/IP connection. You can either use
53
54
<link linkend="gnome-vfs-inet-connection-create"><type>gnome_vfs_inet_connection_create</type></link> which will use the <link linkend="gnome-vfs-resolve"><type>gnome_vfs_resolve</type></link> DNS
59
60
</para>
60
61
</refsect1>
61
62
 
62
 
<refsect1 id="gnome-vfs-20-gnome-vfs-inet-connection.details" role="details">
 
63
<refsect1 id="gnome-vfs-2.0-gnome-vfs-inet-connection.details" role="details">
63
64
<title role="details.title">Details</title>
64
65
<refsect2 id="GnomeVFSInetConnection" role="typedef">
65
66
<title>GnomeVFSInetConnection</title>
66
 
<indexterm zone="GnomeVFSInetConnection"><primary sortas="GnomeVFSInetConnection">GnomeVFSInetConnection</primary></indexterm><programlisting>typedef struct GnomeVFSInetConnection GnomeVFSInetConnection;
 
67
<indexterm zone="GnomeVFSInetConnection"><primary>GnomeVFSInetConnection</primary></indexterm>
 
68
<programlisting>typedef struct GnomeVFSInetConnection GnomeVFSInetConnection;
67
69
</programlisting>
68
70
<para>
69
71
</para></refsect2>
70
72
<refsect2 id="gnome-vfs-inet-connection-create" role="function">
71
73
<title>gnome_vfs_inet_connection_create ()</title>
72
 
<indexterm zone="gnome-vfs-inet-connection-create"><primary sortas="gnome_vfs_inet_connection_create">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
<indexterm zone="gnome-vfs-inet-connection-create"><primary>gnome_vfs_inet_connection_create</primary></indexterm>
 
75
<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
73
76
                                                         const <link linkend="gchar">gchar</link> *host_name,
74
77
                                                         <link linkend="guint">guint</link> host_port,
75
78
                                                         <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
96
99
</variablelist></refsect2>
97
100
<refsect2 id="gnome-vfs-inet-connection-destroy" role="function">
98
101
<title>gnome_vfs_inet_connection_destroy ()</title>
99
 
<indexterm zone="gnome-vfs-inet-connection-destroy"><primary sortas="gnome_vfs_inet_connection_destroy">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
<indexterm zone="gnome-vfs-inet-connection-destroy"><primary>gnome_vfs_inet_connection_destroy</primary></indexterm>
 
103
<programlisting><link linkend="void">void</link>                gnome_vfs_inet_connection_destroy   (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
100
104
                                                         <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
101
105
<para>
102
106
Closes/Destroys <parameter>connection</parameter>.</para>
111
115
</variablelist></refsect2>
112
116
<refsect2 id="gnome-vfs-inet-connection-free" role="function">
113
117
<title>gnome_vfs_inet_connection_free ()</title>
114
 
<indexterm zone="gnome-vfs-inet-connection-free"><primary sortas="gnome_vfs_inet_connection_free">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
<indexterm zone="gnome-vfs-inet-connection-free"><primary>gnome_vfs_inet_connection_free</primary></indexterm>
 
119
<programlisting><link linkend="void">void</link>                gnome_vfs_inet_connection_free      (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
115
120
                                                         <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
116
121
<para>
117
122
Frees <parameter>connection</parameter> without closing the socket.</para>
126
131
</variablelist></refsect2>
127
132
<refsect2 id="gnome-vfs-inet-connection-to-socket" role="function">
128
133
<title>gnome_vfs_inet_connection_to_socket ()</title>
129
 
<indexterm zone="gnome-vfs-inet-connection-to-socket"><primary sortas="gnome_vfs_inet_connection_to_socket">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
<indexterm zone="gnome-vfs-inet-connection-to-socket"><primary>gnome_vfs_inet_connection_to_socket</primary></indexterm>
 
135
<programlisting><link linkend="GnomeVFSSocket">GnomeVFSSocket</link> *    gnome_vfs_inet_connection_to_socket (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
130
136
<para>
131
137
Wrap <parameter>connection</parameter> inside a standard <link linkend="GnomeVFSSocket"><type>GnomeVFSSocket</type></link> for convenience.</para>
132
138
<para>
133
139
</para><variablelist role="params">
134
140
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
135
 
<listitem><simpara> connection to be wrapped into a <link linkend="GnomeVFSSocket"><type>GnomeVFSSocket</type></link>.
 
141
<listitem><simpara> connection to be wrapped into a <link linkend="GnomeVFSSocket."><type>GnomeVFSSocket.</type></link>
136
142
</simpara></listitem></varlistentry>
137
143
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly created <link linkend="GnomeVFSSocket"><type>GnomeVFSSocket</type></link> around <parameter>connection</parameter>.
138
144
</simpara></listitem></varlistentry>
139
145
</variablelist></refsect2>
140
146
<refsect2 id="gnome-vfs-inet-connection-to-socket-buffer" role="function">
141
147
<title>gnome_vfs_inet_connection_to_socket_buffer ()</title>
142
 
<indexterm zone="gnome-vfs-inet-connection-to-socket-buffer"><primary sortas="gnome_vfs_inet_connection_to_socket_buffer">gnome_vfs_inet_connection_to_socket_buffer</primary></indexterm><programlisting><link linkend="GnomeVFSSocketBuffer">GnomeVFSSocketBuffer</link> * gnome_vfs_inet_connection_to_socket_buffer
 
148
<indexterm zone="gnome-vfs-inet-connection-to-socket-buffer"><primary>gnome_vfs_inet_connection_to_socket_buffer</primary></indexterm>
 
149
<programlisting><link linkend="GnomeVFSSocketBuffer">GnomeVFSSocketBuffer</link> * gnome_vfs_inet_connection_to_socket_buffer
143
150
                                                        (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
144
151
<para>
145
152
Wrap <parameter>connection</parameter> inside a standard <link linkend="GnomeVFSSocketBuffer"><type>GnomeVFSSocketBuffer</type></link> for convenience.</para>
146
153
<para>
147
154
</para><variablelist role="params">
148
155
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
149
 
<listitem><simpara> connection to be wrapped into a <link linkend="GnomeVFSSocketBuffer"><type>GnomeVFSSocketBuffer</type></link>.
 
156
<listitem><simpara> connection to be wrapped into a <link linkend="GnomeVFSSocketBuffer."><type>GnomeVFSSocketBuffer.</type></link>
150
157
</simpara></listitem></varlistentry>
151
158
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly created <link linkend="GnomeVFSSocketBuffer"><type>GnomeVFSSocketBuffer</type></link> around <parameter>connection</parameter>.
152
159
</simpara></listitem></varlistentry>
153
160
</variablelist></refsect2>
154
161
<refsect2 id="gnome-vfs-inet-connection-get-fd" role="function">
155
162
<title>gnome_vfs_inet_connection_get_fd ()</title>
156
 
<indexterm zone="gnome-vfs-inet-connection-get-fd"><primary sortas="gnome_vfs_inet_connection_get_fd">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
<indexterm zone="gnome-vfs-inet-connection-get-fd"><primary>gnome_vfs_inet_connection_get_fd</primary></indexterm>
 
164
<programlisting><link linkend="int">int</link>                 gnome_vfs_inet_connection_get_fd    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
157
165
<para>
158
166
Retrieve the UNIX file descriptor corresponding to <parameter>connection</parameter>.</para>
159
167
<para>
166
174
</variablelist></refsect2>
167
175
<refsect2 id="gnome-vfs-inet-connection-create-from-address" role="function" condition="since:2.8">
168
176
<title>gnome_vfs_inet_connection_create_from_address ()</title>
169
 
<indexterm zone="gnome-vfs-inet-connection-create-from-address" role="2.8"><primary sortas="gnome_vfs_inet_connection_create_from_address">gnome_vfs_inet_connection_create_from_address</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create_from_address
 
177
<indexterm zone="gnome-vfs-inet-connection-create-from-address" role="2.8"><primary>gnome_vfs_inet_connection_create_from_address</primary></indexterm>
 
178
<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_inet_connection_create_from_address
170
179
                                                        (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
171
180
                                                         <link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *address,
172
181
                                                         <link linkend="guint">guint</link> host_port,
181
190
contain an allocated <link linkend="GnomeVFSInetConnection"><type>GnomeVFSInetConnection</type></link> object on return.
182
191
</simpara></listitem></varlistentry>
183
192
<varlistentry><term><parameter>address</parameter>&#160;:</term>
184
 
<listitem><simpara> a valid <link linkend="GnomeVFSAddress"><type>GnomeVFSAddress</type></link>.
 
193
<listitem><simpara> a valid <link linkend="GnomeVFSAddress."><type>GnomeVFSAddress.</type></link>
185
194
</simpara></listitem></varlistentry>
186
195
<varlistentry><term><parameter>host_port</parameter>&#160;:</term>
187
196
<listitem><simpara> port number to connect to.
195
204
</variablelist><para role="since">Since 2.8</para></refsect2>
196
205
<refsect2 id="gnome-vfs-inet-connection-get-address" role="function">
197
206
<title>gnome_vfs_inet_connection_get_address ()</title>
198
 
<indexterm zone="gnome-vfs-inet-connection-get-address"><primary sortas="gnome_vfs_inet_connection_get_address">gnome_vfs_inet_connection_get_address</primary></indexterm><programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *   gnome_vfs_inet_connection_get_address
 
207
<indexterm zone="gnome-vfs-inet-connection-get-address"><primary>gnome_vfs_inet_connection_get_address</primary></indexterm>
 
208
<programlisting><link linkend="GnomeVFSAddress">GnomeVFSAddress</link> *   gnome_vfs_inet_connection_get_address
199
209
                                                        (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
200
210
<para>
201
211
Retrieve the address of the other side of a connected <parameter>connection</parameter>.</para>
211
221
</variablelist></refsect2>
212
222
<refsect2 id="gnome-vfs-inet-connection-get-ip" role="function" condition="since:2.8">
213
223
<title>gnome_vfs_inet_connection_get_ip ()</title>
214
 
<indexterm zone="gnome-vfs-inet-connection-get-ip" role="2.8"><primary sortas="gnome_vfs_inet_connection_get_ip">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>
 
224
<indexterm zone="gnome-vfs-inet-connection-get-ip" role="2.8"><primary>gnome_vfs_inet_connection_get_ip</primary></indexterm>
 
225
<programlisting><link linkend="char">char</link> *              gnome_vfs_inet_connection_get_ip    (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
215
226
<para>
216
227
Retrieve the ip address of the other side of a connected <parameter>connection</parameter>.</para>
217
228
<para>