doc/html/gnome-vfs-20-gnome-vfs-inet-connection.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gnome-vfs-inet-connection</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.0"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
   2         .synopsis, .classsynopsis {
   3             background: #eeeeee;
   4             border: solid 1px #aaaaaa;
   5             padding: 0.5em;
   6         }
   7         .programlisting {
   8             background: #eeeeff;
   9             border: solid 1px #aaaaff;
  10             padding: 0.5em;
  11         }
  12         .variablelist {
  13             padding: 4px;
  14             margin-left: 3em;
  15         }
  16         .navigation {
  17             background: #ffeeee;
  18             border: solid 1px #ffaaaa;
  19             margin-top: 0.5em;
  20             margin-bottom: 0.5em;
  21         }
  22         .navigation a {
  23             color: #770000;
  24         }
  25         .navigation a:visited {
  26             color: #550000;
  27         }
  28         .navigation .title {
  29             font-size: 200%;
  30         }
  31       </style><link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library"><link rel="up" href="ch08.html" title="Other Stuff"><link rel="previous" href="gnome-vfs-20-gnome-vfs-standard-callbacks.html" title="gnome-vfs-standard-callbacks"><link rel="next" href="gnome-vfs-20-gnome-vfs-module-callback.html" title="gnome-vfs-module-callback"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gnome-vfs-20-gnome-vfs-standard-callbacks.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch08.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th><td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-module-callback.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="gnome-vfs-20-gnome-vfs-inet-connection"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">gnome-vfs-inet-connection</span></h2><p>gnome-vfs-inet-connection &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  32
  33
  34
  35 <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-inet-connection.html#gnome-vfs-inet-connection-create">gnome_vfs_inet_connection_create</a>
  36                                             (GnomeVFSInetConnection **connection_return,
  37                                              const <a
  38 href="../glib/glib-Basic-Types.html#gchar"
  39 >gchar</a> *host_name,
  40                                              <a
  41 href="../glib/glib-Basic-Types.html#guint"
  42 >guint</a> host_port,
  43                                              GnomeVFSCancellation *cancellation);
  44 void        <a href="gnome-vfs-20-gnome-vfs-inet-connection.html#gnome-vfs-inet-connection-destroy">gnome_vfs_inet_connection_destroy</a>
  45                                             (GnomeVFSInetConnection *connection,
  46                                              GnomeVFSCancellation *cancellation);
  47 void        <a href="gnome-vfs-20-gnome-vfs-inet-connection.html#gnome-vfs-inet-connection-free">gnome_vfs_inet_connection_free</a>  (GnomeVFSInetConnection *connection,
  48                                              GnomeVFSCancellation *cancellation);
  49 GnomeVFSSocket* <a href="gnome-vfs-20-gnome-vfs-inet-connection.html#gnome-vfs-inet-connection-to-socket">gnome_vfs_inet_connection_to_socket</a>
  50                                             (GnomeVFSInetConnection *connection);
  51 GnomeVFSSocketBuffer* <a href="gnome-vfs-20-gnome-vfs-inet-connection.html#gnome-vfs-inet-connection-to-socket-buffer">gnome_vfs_inet_connection_to_socket_buffer</a>
  52                                             (GnomeVFSInetConnection *connection);
  53 int         <a href="gnome-vfs-20-gnome-vfs-inet-connection.html#gnome-vfs-inet-connection-get-fd">gnome_vfs_inet_connection_get_fd</a>
  54                                             (GnomeVFSInetConnection *connection);
  55 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  56
  57 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="gnome-vfs-inet-connection-create"></a>gnome_vfs_inet_connection_create ()</h3><a class="indexterm" name="id2998877"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_inet_connection_create
  58                                             (GnomeVFSInetConnection **connection_return,
  59                                              const <a
  60 href="../glib/glib-Basic-Types.html#gchar"
  61 >gchar</a> *host_name,
  62                                              <a
  63 href="../glib/glib-Basic-Types.html#guint"
  64 >guint</a> host_port,
  65                                              GnomeVFSCancellation *cancellation);</pre><p>
  66 Creates a connection at <i class="parameter"><tt>handle_return</tt></i> to <i class="parameter"><tt>host_name</tt></i> using
  67 port <i class="parameter"><tt>port</tt></i>.</p><p>
  68
  69 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>connection_return</tt></i> :</span></td><td> pointer to a GnomeVFSInetConnection, which will
  70 contain an allocated GnomeVFSInetConnection object on return.
  71 </td></tr><tr><td><span class="term"><i class="parameter"><tt>host_name</tt></i> :</span></td><td> string indicating the host to establish an internet connection with
  72 </td></tr><tr><td><span class="term"><i class="parameter"><tt>host_port</tt></i> :</span></td><td> the port number to connect to
  73 </td></tr><tr><td><span class="term"><i class="parameter"><tt>cancellation</tt></i> :</span></td><td> handle allowing cancellation of the operation
  74 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> GnomeVFSResult indicating the success of the operation
  75 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-inet-connection-destroy"></a>gnome_vfs_inet_connection_destroy ()</h3><a class="indexterm" name="id2999070"></a><pre class="programlisting">void        gnome_vfs_inet_connection_destroy
  76                                             (GnomeVFSInetConnection *connection,
  77                                              GnomeVFSCancellation *cancellation);</pre><p>
  78 Closes/Destroys <i class="parameter"><tt>connection</tt></i>.</p><p>
  79
  80 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>connection</tt></i> :</span></td><td> connection to destroy
  81 </td></tr><tr><td><span class="term"><i class="parameter"><tt>cancellation</tt></i> :</span></td><td> handle for cancelling the operation
  82 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-inet-connection-free"></a>gnome_vfs_inet_connection_free ()</h3><a class="indexterm" name="id2999181"></a><pre class="programlisting">void        gnome_vfs_inet_connection_free  (GnomeVFSInetConnection *connection,
  83                                              GnomeVFSCancellation *cancellation);</pre><p>
  84
  85 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>connection</tt></i> :</span></td><td>
  86 </td></tr><tr><td><span class="term"><i class="parameter"><tt>cancellation</tt></i> :</span></td><td>
  87
  88
  89 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-inet-connection-to-socket"></a>gnome_vfs_inet_connection_to_socket ()</h3><a class="indexterm" name="id2999278"></a><pre class="programlisting">GnomeVFSSocket* gnome_vfs_inet_connection_to_socket
  90                                             (GnomeVFSInetConnection *connection);</pre><p>
  91 Wrapper <i class="parameter"><tt>connection</tt></i> inside a standard GnomeVFSSocket for convenience.</p><p>
  92
  93 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>connection</tt></i> :</span></td><td> connection to convert to wrapper in a GnomeVFSSocket
  94 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a newly created GnomeVFSSocket around <i class="parameter"><tt>connection</tt></i>.
  95 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-inet-connection-to-socket-buffer"></a>gnome_vfs_inet_connection_to_socket_buffer ()</h3><a class="indexterm" name="id2999385"></a><pre class="programlisting">GnomeVFSSocketBuffer* gnome_vfs_inet_connection_to_socket_buffer
  96                                             (GnomeVFSInetConnection *connection);</pre><p>
  97 Wrapper <i class="parameter"><tt>connection</tt></i> inside a standard GnomeVFSSocketBuffer for convenience.</p><p>
  98
  99 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>connection</tt></i> :</span></td><td> connection to convert to wrapper in a GnomeVFSSocketBuffer
 100 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a newly created GnomeVFSSocketBuffer around <i class="parameter"><tt>connection</tt></i>.
 101 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-inet-connection-get-fd"></a>gnome_vfs_inet_connection_get_fd ()</h3><a class="indexterm" name="id2999490"></a><pre class="programlisting">int         gnome_vfs_inet_connection_get_fd
 102                                             (GnomeVFSInetConnection *connection);</pre><p>
 103 Retrieve the UNIX file descriptor corresponding to <i class="parameter"><tt>connection</tt></i>.</p><p>
 104
 105 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>connection</tt></i> :</span></td><td> connection to get the file descriptor from
 106 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> file descriptor
 107 </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gnome-vfs-20-gnome-vfs-standard-callbacks.html"><b>&lt;&lt; gnome-vfs-standard-callbacks</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-20-gnome-vfs-module-callback.html"><b>gnome-vfs-module-callback &gt;&gt;</b></a></td></tr></table></body></html>