## gnome-vfs-inet-connection

gnome-vfs-inet-connection —

## Synopsis

    GnomeVFSResult gnome_vfs_inet_connection_create
                                                (GnomeVFSInetConnection **connection_return,
                                                 const gchar *host_name,
                                                 guint host_port,
                                                 GnomeVFSCancellation *cancellation);
    void        gnome_vfs_inet_connection_destroy
                                                (GnomeVFSInetConnection *connection,
                                                 GnomeVFSCancellation *cancellation);
    void        gnome_vfs_inet_connection_free  (GnomeVFSInetConnection *connection,
                                                 GnomeVFSCancellation *cancellation);
    GnomeVFSSocket* gnome_vfs_inet_connection_to_socket
                                                (GnomeVFSInetConnection *connection);
    GnomeVFSSocketBuffer* gnome_vfs_inet_connection_to_socket_buffer
                                                (GnomeVFSInetConnection *connection);
    int         gnome_vfs_inet_connection_get_fd
                                                (GnomeVFSInetConnection *connection);

## Description

## Details

### gnome_vfs_inet_connection_create ()

    GnomeVFSResult gnome_vfs_inet_connection_create
                                                (GnomeVFSInetConnection **connection_return,
                                                 const gchar *host_name,
                                                 guint host_port,
                                                 GnomeVFSCancellation *cancellation);

Creates a connection at `handle_return` to `host_name` using port `port`.

`connection_return` : | pointer to a GnomeVFSInetConnection, which will contain an allocated GnomeVFSInetConnection object on return.
`host_name` : | string indicating the host to establish an internet connection with
`host_port` : | the port number to connect to
`cancellation` : | handle allowing cancellation of the operation
Returns : | GnomeVFSResult indicating the success of the operation

### gnome_vfs_inet_connection_destroy ()

    void        gnome_vfs_inet_connection_destroy
                                                (GnomeVFSInetConnection *connection,
                                                 GnomeVFSCancellation *cancellation);

Closes/Destroys `connection`.

`connection` : | connection to destroy
`cancellation` : | handle for cancelling the operation

### gnome_vfs_inet_connection_free ()

    void        gnome_vfs_inet_connection_free  (GnomeVFSInetConnection *connection,
                                                 GnomeVFSCancellation *cancellation);

`connection` : |
`cancellation` : |

### gnome_vfs_inet_connection_to_socket ()

    GnomeVFSSocket* gnome_vfs_inet_connection_to_socket
                                                (GnomeVFSInetConnection *connection);

Wrapper `connection` inside a standard GnomeVFSSocket for convenience.

`connection` : | connection to convert to wrapper in a GnomeVFSSocket
Returns : | a newly created GnomeVFSSocket around `connection`.

### gnome_vfs_inet_connection_to_socket_buffer ()

    GnomeVFSSocketBuffer* gnome_vfs_inet_connection_to_socket_buffer
                                                (GnomeVFSInetConnection *connection);

Wrapper `connection` inside a standard GnomeVFSSocketBuffer for convenience.

`connection` : | connection to convert to wrapper in a GnomeVFSSocketBuffer
Returns : | a newly created GnomeVFSSocketBuffer around `connection`.

### gnome_vfs_inet_connection_get_fd ()

    int         gnome_vfs_inet_connection_get_fd
                                                (GnomeVFSInetConnection *connection);

Retrieve the UNIX file descriptor corresponding to `connection`.

`connection` : | connection to get the file descriptor from
Returns : | file descriptor