doc/xml/gnome-vfs-inet-connection.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-inet-connection">
   2 <refmeta>
   3 <refentrytitle>gnome-vfs-inet-connection</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>gnome-vfs-inet-connection</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-inet-connection-create">gnome_vfs_inet_connection_create</link>
  19                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
  20                                              const <link linkend="gchar">gchar</link> *host_name,
  21                                              <link linkend="guint">guint</link> host_port,
  22                                              <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);
  23 <link linkend="void">void</link>        <link linkend="gnome-vfs-inet-connection-destroy">gnome_vfs_inet_connection_destroy</link>
  24                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
  25                                              <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);
  26 <link linkend="void">void</link>        <link linkend="gnome-vfs-inet-connection-free">gnome_vfs_inet_connection_free</link>  (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
  27                                              <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);
  28 <link linkend="GnomeVFSSocket">GnomeVFSSocket</link>* <link linkend="gnome-vfs-inet-connection-to-socket">gnome_vfs_inet_connection_to_socket</link>
  29                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);
  30 <link linkend="GnomeVFSSocketBuffer">GnomeVFSSocketBuffer</link>* <link linkend="gnome-vfs-inet-connection-to-socket-buffer">gnome_vfs_inet_connection_to_socket_buffer</link>
  31                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);
  32 <link linkend="int">int</link>         <link linkend="gnome-vfs-inet-connection-get-fd">gnome_vfs_inet_connection_get_fd</link>
  33                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);
  34 </synopsis>
  35 </refsynopsisdiv>
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45 <refsect1>
  46 <title>Description</title>
  47 <para>
  48
  49 </para>
  50 </refsect1>
  51
  52 <refsect1>
  53 <title>Details</title>
  54 <refsect2>
  55 <title><anchor id="gnome-vfs-inet-connection-create"/>gnome_vfs_inet_connection_create ()</title>
  56 <indexterm><primary>gnome_vfs_inet_connection_create</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_inet_connection_create
  57                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> **connection_return,
  58                                              const <link linkend="gchar">gchar</link> *host_name,
  59                                              <link linkend="guint">guint</link> host_port,
  60                                              <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
  61 <para>
  62 Creates a connection at <parameter>handle_return</parameter> to <parameter>host_name</parameter> using
  63 port <parameter>port</parameter>.</para>
  64 <para>
  65
  66 </para><variablelist role="params">
  67 <varlistentry><term><parameter>connection_return</parameter>&nbsp;:</term>
  68 <listitem><simpara> pointer to a GnomeVFSInetConnection, which will
  69 contain an allocated GnomeVFSInetConnection object on return.
  70 </simpara></listitem></varlistentry>
  71 <varlistentry><term><parameter>host_name</parameter>&nbsp;:</term>
  72 <listitem><simpara> string indicating the host to establish an internet connection with
  73 </simpara></listitem></varlistentry>
  74 <varlistentry><term><parameter>host_port</parameter>&nbsp;:</term>
  75 <listitem><simpara> the port number to connect to
  76 </simpara></listitem></varlistentry>
  77 <varlistentry><term><parameter>cancellation</parameter>&nbsp;:</term>
  78 <listitem><simpara> handle allowing cancellation of the operation
  79 </simpara></listitem></varlistentry>
  80 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation
  81 </simpara></listitem></varlistentry>
  82 </variablelist></refsect2>
  83 <refsect2>
  84 <title><anchor id="gnome-vfs-inet-connection-destroy"/>gnome_vfs_inet_connection_destroy ()</title>
  85 <indexterm><primary>gnome_vfs_inet_connection_destroy</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_inet_connection_destroy
  86                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection,
  87                                              <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
  88 <para>
  89 Closes/Destroys <parameter>connection</parameter>.</para>
  90 <para>
  91
  92 </para><variablelist role="params">
  93 <varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
  94 <listitem><simpara> connection to destroy
  95 </simpara></listitem></varlistentry>
  96 <varlistentry><term><parameter>cancellation</parameter>&nbsp;:</term>
  97 <listitem><simpara> handle for cancelling the operation
  98 </simpara></listitem></varlistentry>
  99 </variablelist></refsect2>
 100 <refsect2>
 101 <title><anchor id="gnome-vfs-inet-connection-free"/>gnome_vfs_inet_connection_free ()</title>
 102 <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,
 103                                              <link linkend="GnomeVFSCancellation">GnomeVFSCancellation</link> *cancellation);</programlisting>
 104 <para>
 105
 106 </para><variablelist role="params">
 107 <varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
 108 <listitem><simpara>
 109 </simpara></listitem></varlistentry>
 110 <varlistentry><term><parameter>cancellation</parameter>&nbsp;:</term>
 111 <listitem><simpara>
 112
 113
 114 </simpara></listitem></varlistentry>
 115 </variablelist></refsect2>
 116 <refsect2>
 117 <title><anchor id="gnome-vfs-inet-connection-to-socket"/>gnome_vfs_inet_connection_to_socket ()</title>
 118 <indexterm><primary>gnome_vfs_inet_connection_to_socket</primary></indexterm><programlisting><link linkend="GnomeVFSSocket">GnomeVFSSocket</link>* gnome_vfs_inet_connection_to_socket
 119                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
 120 <para>
 121 Wrapper <parameter>connection</parameter> inside a standard GnomeVFSSocket for convenience.</para>
 122 <para>
 123
 124 </para><variablelist role="params">
 125 <varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
 126 <listitem><simpara> connection to convert to wrapper in a GnomeVFSSocket
 127 </simpara></listitem></varlistentry>
 128 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly created GnomeVFSSocket around <parameter>connection</parameter>.
 129 </simpara></listitem></varlistentry>
 130 </variablelist></refsect2>
 131 <refsect2>
 132 <title><anchor id="gnome-vfs-inet-connection-to-socket-buffer"/>gnome_vfs_inet_connection_to_socket_buffer ()</title>
 133 <indexterm><primary>gnome_vfs_inet_connection_to_socket_buffer</primary></indexterm><programlisting><link linkend="GnomeVFSSocketBuffer">GnomeVFSSocketBuffer</link>* gnome_vfs_inet_connection_to_socket_buffer
 134                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
 135 <para>
 136 Wrapper <parameter>connection</parameter> inside a standard GnomeVFSSocketBuffer for convenience.</para>
 137 <para>
 138
 139 </para><variablelist role="params">
 140 <varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
 141 <listitem><simpara> connection to convert to wrapper in a GnomeVFSSocketBuffer
 142 </simpara></listitem></varlistentry>
 143 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly created GnomeVFSSocketBuffer around <parameter>connection</parameter>.
 144 </simpara></listitem></varlistentry>
 145 </variablelist></refsect2>
 146 <refsect2>
 147 <title><anchor id="gnome-vfs-inet-connection-get-fd"/>gnome_vfs_inet_connection_get_fd ()</title>
 148 <indexterm><primary>gnome_vfs_inet_connection_get_fd</primary></indexterm><programlisting><link linkend="int">int</link>         gnome_vfs_inet_connection_get_fd
 149                                             (<link linkend="GnomeVFSInetConnection">GnomeVFSInetConnection</link> *connection);</programlisting>
 150 <para>
 151 Retrieve the UNIX file descriptor corresponding to <parameter>connection</parameter>.</para>
 152 <para>
 153
 154 </para><variablelist role="params">
 155 <varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
 156 <listitem><simpara> connection to get the file descriptor from
 157 </simpara></listitem></varlistentry>
 158 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> file descriptor
 159 </simpara></listitem></varlistentry>
 160 </variablelist></refsect2>
 161
 162 </refsect1>
 163
 164
 165
 166
 167 </refentry>