doc/xml/gnome-vfs-ssl.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-ssl">
   2 <refmeta>
   3 <refentrytitle>gnome-vfs-ssl</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>gnome-vfs-ssl</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-ssl-enabled">gnome_vfs_ssl_enabled</link>           (void);
  19 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-ssl-create">gnome_vfs_ssl_create</link>         (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> **handle_return,
  20                                              const <link linkend="char">char</link> *host,
  21                                              unsigned <link linkend="int">int</link> port);
  22 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-ssl-create-from-fd">gnome_vfs_ssl_create_from_fd</link> (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> **handle_return,
  23                                              <link linkend="gint">gint</link> fd);
  24 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-ssl-read">gnome_vfs_ssl_read</link>           (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl,
  25                                              <link linkend="gpointer">gpointer</link> buffer,
  26                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> bytes,
  27                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> *bytes_read);
  28 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-ssl-write">gnome_vfs_ssl_write</link>          (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl,
  29                                              <link linkend="gconstpointer">gconstpointer</link> buffer,
  30                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> bytes,
  31                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> *bytes_written);
  32 <link linkend="void">void</link>        <link linkend="gnome-vfs-ssl-destroy">gnome_vfs_ssl_destroy</link>           (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl);
  33 <link linkend="GnomeVFSSocket">GnomeVFSSocket</link>* <link linkend="gnome-vfs-ssl-to-socket">gnome_vfs_ssl_to_socket</link>     (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl);
  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-ssl-enabled"/>gnome_vfs_ssl_enabled ()</title>
  56 <indexterm><primary>gnome_vfs_ssl_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_ssl_enabled           (void);</programlisting>
  57 <para>
  58 Checks whether GnomeVFS was compiled with SSL support.</para>
  59 <para>
  60
  61 </para><variablelist role="params">
  62 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if GnomeVFS was compiled with SSL support,
  63 otherwise <literal>FALSE</literal>.
  64 </simpara></listitem></varlistentry>
  65 </variablelist></refsect2>
  66 <refsect2>
  67 <title><anchor id="gnome-vfs-ssl-create"/>gnome_vfs_ssl_create ()</title>
  68 <indexterm><primary>gnome_vfs_ssl_create</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_ssl_create         (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> **handle_return,
  69                                              const <link linkend="char">char</link> *host,
  70                                              unsigned <link linkend="int">int</link> port);</programlisting>
  71 <para>
  72 Creates an SSL socket connection at <parameter>handle_return</parameter> to <parameter>host</parameter> using
  73 port <parameter>port</parameter>.</para>
  74 <para>
  75
  76 </para><variablelist role="params">
  77 <varlistentry><term><parameter>handle_return</parameter>&nbsp;:</term>
  78 <listitem><simpara> pointer to a GnmoeVFSSSL struct, which will
  79 contain an allocated GnomeVFSSSL object on return.
  80 </simpara></listitem></varlistentry>
  81 <varlistentry><term><parameter>host</parameter>&nbsp;:</term>
  82 <listitem><simpara> string indicating the host to establish an SSL connection with
  83 </simpara></listitem></varlistentry>
  84 <varlistentry><term><parameter>port</parameter>&nbsp;:</term>
  85 <listitem><simpara> the port number to connect to
  86 </simpara></listitem></varlistentry>
  87 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation
  88 </simpara></listitem></varlistentry>
  89 </variablelist></refsect2>
  90 <refsect2>
  91 <title><anchor id="gnome-vfs-ssl-create-from-fd"/>gnome_vfs_ssl_create_from_fd ()</title>
  92 <indexterm><primary>gnome_vfs_ssl_create_from_fd</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_ssl_create_from_fd (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> **handle_return,
  93                                              <link linkend="gint">gint</link> fd);</programlisting>
  94 <para>
  95 Try to establish an SSL connection over the file descriptor <parameter>fd</parameter>.</para>
  96 <para>
  97
  98 </para><variablelist role="params">
  99 <varlistentry><term><parameter>handle_return</parameter>&nbsp;:</term>
 100 <listitem><simpara> pointer to a GnmoeVFSSSL struct, which will
 101 contain an allocated GnomeVFSSSL object on return.
 102 </simpara></listitem></varlistentry>
 103 <varlistentry><term><parameter>fd</parameter>&nbsp;:</term>
 104 <listitem><simpara> file descriptior to try and establish an SSL connection over
 105 </simpara></listitem></varlistentry>
 106 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GnomeVFSResult indicating the success of the operation
 107 </simpara></listitem></varlistentry>
 108 </variablelist></refsect2>
 109 <refsect2>
 110 <title><anchor id="gnome-vfs-ssl-read"/>gnome_vfs_ssl_read ()</title>
 111 <indexterm><primary>gnome_vfs_ssl_read</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_ssl_read           (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl,
 112                                              <link linkend="gpointer">gpointer</link> buffer,
 113                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> bytes,
 114                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> *bytes_read);</programlisting>
 115 <para>
 116 Read <parameter>bytes</parameter> bytes of data from the SSL socket <parameter>ssl</parameter> into <parameter>buffer</parameter>.</para>
 117 <para>
 118
 119 </para><variablelist role="params">
 120 <varlistentry><term><parameter>ssl</parameter>&nbsp;:</term>
 121 <listitem><simpara> SSL socket to read data from
 122 </simpara></listitem></varlistentry>
 123 <varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
 124 <listitem><simpara> allocated buffer of at least <parameter>bytes</parameter> bytes to be read into
 125 </simpara></listitem></varlistentry>
 126 <varlistentry><term><parameter>bytes</parameter>&nbsp;:</term>
 127 <listitem><simpara> number of bytes to read from <parameter>ssl</parameter> into <parameter>buffer</parameter>
 128 </simpara></listitem></varlistentry>
 129 <varlistentry><term><parameter>bytes_read</parameter>&nbsp;:</term>
 130 <listitem><simpara> pointer to a GnomeVFSFileSize, will contain
 131 the number of bytes actually read from the socket on return.
 132 </simpara></listitem></varlistentry>
 133 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation
 134 </simpara></listitem></varlistentry>
 135 </variablelist></refsect2>
 136 <refsect2>
 137 <title><anchor id="gnome-vfs-ssl-write"/>gnome_vfs_ssl_write ()</title>
 138 <indexterm><primary>gnome_vfs_ssl_write</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_ssl_write          (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl,
 139                                              <link linkend="gconstpointer">gconstpointer</link> buffer,
 140                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> bytes,
 141                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> *bytes_written);</programlisting>
 142 <para>
 143 Write <parameter>bytes</parameter> bytes of data from <parameter>buffer</parameter> to <parameter>ssl</parameter>.</para>
 144 <para>
 145
 146 </para><variablelist role="params">
 147 <varlistentry><term><parameter>ssl</parameter>&nbsp;:</term>
 148 <listitem><simpara> SSL socket to write data to
 149 </simpara></listitem></varlistentry>
 150 <varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
 151 <listitem><simpara> data to write to the socket
 152 </simpara></listitem></varlistentry>
 153 <varlistentry><term><parameter>bytes</parameter>&nbsp;:</term>
 154 <listitem><simpara> number of bytes from <parameter>buffer</parameter> to write to <parameter>ssl</parameter>
 155 </simpara></listitem></varlistentry>
 156 <varlistentry><term><parameter>bytes_written</parameter>&nbsp;:</term>
 157 <listitem><simpara> pointer to a GnomeVFSFileSize, will contain
 158 the number of bytes actually written to the socket on return.
 159 </simpara></listitem></varlistentry>
 160 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GnomeVFSResult indicating the success of the operation
 161 </simpara></listitem></varlistentry>
 162 </variablelist></refsect2>
 163 <refsect2>
 164 <title><anchor id="gnome-vfs-ssl-destroy"/>gnome_vfs_ssl_destroy ()</title>
 165 <indexterm><primary>gnome_vfs_ssl_destroy</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_ssl_destroy           (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl);</programlisting>
 166 <para>
 167 Free resources used by <parameter>ssl</parameter> and close the connection.</para>
 168 <para>
 169
 170 </para><variablelist role="params">
 171 <varlistentry><term><parameter>ssl</parameter>&nbsp;:</term>
 172 <listitem><simpara> SSL socket to be closed and destroyed
 173 </simpara></listitem></varlistentry>
 174 </variablelist></refsect2>
 175 <refsect2>
 176 <title><anchor id="gnome-vfs-ssl-to-socket"/>gnome_vfs_ssl_to_socket ()</title>
 177 <indexterm><primary>gnome_vfs_ssl_to_socket</primary></indexterm><programlisting><link linkend="GnomeVFSSocket">GnomeVFSSocket</link>* gnome_vfs_ssl_to_socket     (<link linkend="GnomeVFSSSL">GnomeVFSSSL</link> *ssl);</programlisting>
 178 <para>
 179 Wrapper an SSL socket inside a standard GnomeVFSSocket.</para>
 180 <para>
 181
 182 </para><variablelist role="params">
 183 <varlistentry><term><parameter>ssl</parameter>&nbsp;:</term>
 184 <listitem><simpara> SSL socket to convert into a standard socket
 185 </simpara></listitem></varlistentry>
 186 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated GnomeVFSSocket corresponding to <parameter>ssl</parameter>.
 187 </simpara></listitem></varlistentry>
 188 </variablelist></refsect2>
 189
 190 </refsect1>
 191
 192
 193
 194
 195 </refentry>