![]() |
![]() |
![]() |
libsoup Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
SoupConnection * soup_connection_new (const char *propname1
,...
); void (*SoupConnectionCallback) (SoupConnection *conn
,guint status
,gpointer data
); void soup_connection_connect_async (SoupConnection *conn
,SoupConnectionCallback callback
,gpointer user_data
); guint soup_connection_connect_sync (SoupConnection *conn
); void soup_connection_disconnect (SoupConnection *conn
); gboolean soup_connection_is_in_use (SoupConnection *conn
); time_t soup_connection_last_used (SoupConnection *conn
); void soup_connection_send_request (SoupConnection *conn
,SoupMessage *req
); void soup_connection_authenticate (SoupConnection *conn
,SoupMessage *msg
,const char *auth_type
,const char *auth_realm
,char **username
,char **password
); void soup_connection_reauthenticate (SoupConnection *conn
,SoupMessage *msg
,const char *auth_type
,const char *auth_realm
,char **username
,char **password
); void soup_connection_release (SoupConnection *conn
); void soup_connection_reserve (SoupConnection *conn
); #define SOUP_CONNECTION_ORIGIN_URI #define SOUP_CONNECTION_PROXY_URI #define SOUP_CONNECTION_SSL_CREDENTIALS #define SOUP_CONNECTION_MESSAGE_FILTER #define SOUP_CONNECTION_ASYNC_CONTEXT #define SOUP_CONNECTION_TIMEOUT
SoupConnection represents a single connection to an HTTP server (possibly via a proxy). Connection objects are created and destroyed automatically by SoupSession.
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.
|
name of first property to set |
|
value of propname1 , followed by additional property/value pairs |
Returns : |
the new connection (not yet ready for use). |
void (*SoupConnectionCallback) (SoupConnection *conn
,guint status
,gpointer data
);
The callback function passed to soup_connection_connect_async()
.
|
the SoupConnection |
|
an HTTP status code indicating success or failure |
|
the data passed to soup_connection_connect_async()
|
void soup_connection_connect_async (SoupConnection *conn
,SoupConnectionCallback callback
,gpointer user_data
);
Asynchronously connects conn
.
|
the connection |
|
callback to call when the connection succeeds or fails |
|
data for callback
|
guint soup_connection_connect_sync (SoupConnection *conn
);
Synchronously connects conn
.
|
the connection |
Returns : |
the soup status |
void soup_connection_disconnect (SoupConnection *conn
);
Disconnects conn
's socket and emits a disconnected
signal.
After calling this, conn
will be essentially useless.
|
a connection |
gboolean soup_connection_is_in_use (SoupConnection *conn
);
Tests whether or not conn
is in use.
|
a connection |
Returns : |
TRUE if there is currently a request being processed
on conn . |
time_t soup_connection_last_used (SoupConnection *conn
);
Returns the last time a response was received on conn
.
|
a SoupConnection. |
Returns : |
the last time a response was received on conn , or 0
if conn has not been used yet. |
void soup_connection_send_request (SoupConnection *conn
,SoupMessage *req
);
Sends req
on conn
. This is a low-level function, intended for use
by SoupSession.
|
a SoupConnection |
|
a SoupMessage |
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.
|
a SoupConnection |
|
the message to authenticate |
|
type of authentication to use |
|
authentication realm |
|
on successful return, will contain the username to authenticate with |
|
on successful return, will contain the password to authenticate with |
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.
|
a SoupConnection |
|
the message to authenticate |
|
type of authentication to use |
|
authentication realm |
|
on successful return, will contain the username to authenticate with |
|
on successful return, will contain the password to authenticate with |
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()
.
|
a SoupConnection |
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.
|
a SoupConnection |
#define SOUP_CONNECTION_ORIGIN_URI "origin-uri"
An alias for the "origin-uri" property.
#define SOUP_CONNECTION_PROXY_URI "proxy-uri"
An alias for the "proxy-uri" property.
#define SOUP_CONNECTION_SSL_CREDENTIALS "ssl-creds"
An alias for the "ssl-creds" property.
#define SOUP_CONNECTION_MESSAGE_FILTER "message-filter"
An alias for the "message-filter" property.
#define SOUP_CONNECTION_ASYNC_CONTEXT "async-context"
An alias for the "async-context" property.