|  |  |  | GnomeVFS - Filesystem Abstraction library |  | 
|---|---|---|---|---|
| Top | Description | ||||
| SSL support functionsSSL support functions — Functions to send and receive encrypted data over a socket. | 
typedef GnomeVFSSSL; gboolean gnome_vfs_ssl_enabled (void); GnomeVFSResult gnome_vfs_ssl_create (GnomeVFSSSL **handle_return,const char *host,unsigned int port,GnomeVFSCancellation *cancellation); GnomeVFSResult gnome_vfs_ssl_create_from_fd (GnomeVFSSSL **handle_return,gint fd,GnomeVFSCancellation *cancellation); GnomeVFSResult gnome_vfs_ssl_read (GnomeVFSSSL *ssl,gpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_read,GnomeVFSCancellation *cancellation); GnomeVFSResult gnome_vfs_ssl_write (GnomeVFSSSL *ssl,gconstpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_written,GnomeVFSCancellation *cancellation); void gnome_vfs_ssl_destroy (GnomeVFSSSL *ssl,GnomeVFSCancellation *cancellation); GnomeVFSSocket * gnome_vfs_ssl_to_socket (GnomeVFSSSL *ssl); GnomeVFSResult gnome_vfs_ssl_set_timeout (GnomeVFSSSL *ssl,GTimeVal *timeout,GnomeVFSCancellation *cancellation);
gboolean            gnome_vfs_ssl_enabled               (void);
Checks whether gnome-vfs was compiled with SSL support.
| Returns : | TRUEif gnome-vfs was compiled with SSL support,
otherwiseFALSE. | 
GnomeVFSResult gnome_vfs_ssl_create (GnomeVFSSSL **handle_return,const char *host,unsigned int port,GnomeVFSCancellation *cancellation);
Creates an SSL socket connection at handle_return to host using
port port.
| 
 | pointer to a GnomeVFSSSL struct, which will contain an allocated GnomeVFSSSL object on return. | 
| 
 | string indicating the hostname to establish an SSL connection with. | 
| 
 | port number to connect to. | 
| 
 | handle allowing cancellation of the operation. | 
| Returns : | GnomeVFSResult indicating the success of the operation. | 
GnomeVFSResult gnome_vfs_ssl_create_from_fd (GnomeVFSSSL **handle_return,gint fd,GnomeVFSCancellation *cancellation);
Try to establish an SSL connection over the file descriptor fd.
| 
 | pointer to a GnomeVFSSSL struct, which will contain an allocated GnomeVFSSSL object on return. | 
| 
 | file descriptior to try and establish an SSL connection over. | 
| 
 | handle allowing cancellation of the operation. | 
| Returns : | a GnomeVFSResult indicating the success of the operation. | 
GnomeVFSResult gnome_vfs_ssl_read (GnomeVFSSSL *ssl,gpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_read,GnomeVFSCancellation *cancellation);
Read bytes bytes of data from the SSL socket ssl into buffer.
| 
 | SSL socket to read data from. | 
| 
 | allocated buffer of at least bytesbytes to write into. | 
| 
 | number of bytes to read from sslintobuffer. | 
| 
 | pointer to a GnomeVFSFileSize, will contain
the number of bytes actually read from the socket sslon return. | 
| 
 | handle allowing cancellation of the operation. | 
| Returns : | GnomeVFSResult indicating the success of the operation. | 
GnomeVFSResult gnome_vfs_ssl_write (GnomeVFSSSL *ssl,gconstpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_written,GnomeVFSCancellation *cancellation);
Write bytes bytes of data from buffer to ssl.
| 
 | SSL socket to write data to. | 
| 
 | data to write to the socket. | 
| 
 | number of bytes to write from buffertossl. | 
| 
 | pointer to a GnomeVFSFileSize, will contain the number of bytes actually written to the socket on return. | 
| 
 | handle allowing cancellation of the operation. | 
| Returns : | GnomeVFSResult indicating the success of the operation. | 
void gnome_vfs_ssl_destroy (GnomeVFSSSL *ssl,GnomeVFSCancellation *cancellation);
Free resources used by ssl and close the connection.
| 
 | SSL socket to be closed and destroyed. | 
| 
 | handle allowing cancellation of the operation. | 
GnomeVFSSocket *    gnome_vfs_ssl_to_socket             (GnomeVFSSSL *ssl);
Wrap an SSL socket inside a standard GnomeVFSSocket.
| 
 | SSL socket to convert into a standard socket. | 
| Returns : | a newly allocated GnomeVFSSocket corresponding to ssl. | 
GnomeVFSResult gnome_vfs_ssl_set_timeout (GnomeVFSSSL *ssl,GTimeVal *timeout,GnomeVFSCancellation *cancellation);
Set a timeout of timeout. If timeout is NULL following operations
will block indefinitely).
Note if you set timeout to 0 (means tv_sec and tv_usec are both 0)
every following operation will return immediately. (This can be used
for polling.)
| 
 | SSL socket to set the timeout of. | 
| 
 | the timeout. | 
| 
 | optional cancellation object. | 
| Returns : | GnomeVFSResult indicating the success of the operation. | 
Since 2.8