struct SoupConnection

struct SoupConnection;

soup_connection_new ()

SoupConnection* soup_connection_new         (const char *propname1,
                                             ...);

Creates an HTTP connection. You must set at least one of SOUP_CONNECTION_ORIGIN_URI or SOUP_CONNECTION_PROXY_URI. If you set an origin server URI but no proxy URI, this will be a direct connection. If you set a proxy URI and an https origin server URI, this will be a tunnel. Otherwise it will be an http proxy connection.

You must call soup_connection_connect_async() or soup_connection_connect_sync() to connect it after creating it.

SoupConnectionCallback ()

void        (*SoupConnectionCallback)       (SoupConnection *conn,
                                             guint status,
                                             gpointer data);

The callback function passed to soup_connection_connect_async().

soup_connection_connect_async ()

void        soup_connection_connect_async   (SoupConnection *conn,
                                             SoupConnectionCallback callback,
                                             gpointer user_data);

Asynchronously connects conn.

soup_connection_connect_sync ()

guint       soup_connection_connect_sync    (SoupConnection *conn);

Synchronously connects conn.

soup_connection_disconnect ()

void        soup_connection_disconnect      (SoupConnection *conn);

Disconnects conn's socket and emits a disconnected signal. After calling this, conn will be essentially useless.

soup_connection_is_in_use ()

gboolean    soup_connection_is_in_use       (SoupConnection *conn);

Tests whether or not conn is in use.

soup_connection_last_used ()

time_t      soup_connection_last_used       (SoupConnection *conn);

Returns the last time a response was received on conn.

soup_connection_send_request ()

void        soup_connection_send_request    (SoupConnection *conn,
                                             SoupMessage *req);

Sends req on conn. This is a low-level function, intended for use by SoupSession.

soup_connection_authenticate ()

void        soup_connection_authenticate    (SoupConnection *conn,
                                             SoupMessage *msg,
                                             const char *auth_type,
                                             const char *auth_realm,
                                             char **username,
                                             char **password);

Emits the authenticate signal on conn. For use by SoupConnection subclasses.

soup_connection_reauthenticate ()

void        soup_connection_reauthenticate  (SoupConnection *conn,
                                             SoupMessage *msg,
                                             const char *auth_type,
                                             const char *auth_realm,
                                             char **username,
                                             char **password);

Emits the reauthenticate signal on conn. For use by SoupConnection subclasses.

soup_connection_release ()

void        soup_connection_release         (SoupConnection *conn);

Marks conn as not "in use". This can be used to cancel the effect of a soup_connection_reserve(). It is not necessary to call this after soup_connection_send_request().

soup_connection_reserve ()

void        soup_connection_reserve         (SoupConnection *conn);

Marks conn as "in use" despite not actually having a message on it. This is used by SoupSession to keep it from accidentally trying to queue two messages on the same connection from different threads at the same time.

SOUP_CONNECTION_ORIGIN_URI

#define SOUP_CONNECTION_ORIGIN_URI      "origin-uri"

An alias for the "origin-uri" property.

SOUP_CONNECTION_PROXY_URI

#define SOUP_CONNECTION_PROXY_URI       "proxy-uri"

An alias for the "proxy-uri" property.

SOUP_CONNECTION_SSL_CREDENTIALS

#define SOUP_CONNECTION_SSL_CREDENTIALS "ssl-creds"

An alias for the "ssl-creds" property.

SOUP_CONNECTION_MESSAGE_FILTER

#define SOUP_CONNECTION_MESSAGE_FILTER  "message-filter"

An alias for the "message-filter" property.

SOUP_CONNECTION_ASYNC_CONTEXT

#define SOUP_CONNECTION_ASYNC_CONTEXT   "async-context"

An alias for the "async-context" property.

SOUP_CONNECTION_TIMEOUT

#define SOUP_CONNECTION_TIMEOUT		"timeout"

An alias for the "timeout" property.

The "async-context" property

  "async-context"        gpointer              : Read / Write / Construct Only

GMainContext to dispatch this connection's async I/O in.

The "message-filter" property

  "message-filter"       gpointer              : Read / Write

Message filter object for this connection.

The "origin-uri" property

  "origin-uri"           gpointer              : Read / Write / Construct Only

The HTTP origin server to use for this connection.

The "proxy-uri" property

  "proxy-uri"            gpointer              : Read / Write / Construct Only

The HTTP Proxy to use for this connection.

The "ssl-creds" property

  "ssl-creds"            gpointer              : Read / Write / Construct Only

Opaque SSL credentials for this connection.

The "timeout" property

  "timeout"              guint                 : Read / Write

Value in seconds to timeout a blocking I/O.

Default value: 0

The "authenticate" signal

void        user_function                  (SoupConnection *conn,
                                            SoupMessage    *msg,
                                            gchar          *auth_type,
                                            gchar          *auth_realm,
                                            gpointer        username,
                                            gpointer        password,
                                            gpointer        user_data)       : Run first

Emitted when the connection requires authentication. (SoupConnectionNTLM makes use of this.)

The "connect-result" signal

void        user_function                  (SoupConnection *conn,
                                            gint            status,
                                            gpointer        user_data)      : Run first

Emitted when a connection attempt succeeds or fails. This is used internally by soup_connection_connect_async().

The "disconnected" signal

void        user_function                  (SoupConnection *conn,
                                            gpointer        user_data)      : Run first

Emitted when the connection's socket is disconnected, for whatever reason.

The "reauthenticate" signal

void        user_function                  (SoupConnection *conn,
                                            SoupMessage    *msg,
                                            gchar          *auth_type,
                                            gchar          *auth_realm,
                                            gpointer        username,
                                            gpointer        password,
                                            gpointer        user_data)       : Run first

Emitted when the authentication data acquired by a previous authenticate or reauthenticate signal fails.