| libsoup Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
#include <libsoup/soup.h>
SoupRequest;
GInputStream * soup_request_send (SoupRequest *request,
GCancellable *cancellable,
GError **error);
void soup_request_send_async (SoupRequest *request,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GInputStream * soup_request_send_finish (SoupRequest *request,
GAsyncResult *result,
GError **error);
goffset soup_request_get_content_length (SoupRequest *request);
const char * soup_request_get_content_type (SoupRequest *request);
SoupSession * soup_request_get_session (SoupRequest *request);
SoupURI * soup_request_get_uri (SoupRequest *request);
void soup_request_disable_feature (SoupRequest *request,
GType feature_type);
#define SOUP_REQUEST_SESSION
#define SOUP_REQUEST_URI
GObject +----SoupRequest +----SoupRequestData +----SoupRequestFile +----SoupRequestHTTP
"session" SoupSession* : Read / Write / Construct Only "uri" SoupURI* : Read / Write / Construct Only
A SoupRequest is created by SoupSession, and represents a request to retrieve a particular URI.
typedef struct _SoupRequest SoupRequest;
A request to retrieve a particular URI.
Since 2.42
GInputStream * soup_request_send (SoupRequest *request,GCancellable *cancellable,GError **error);
Synchronously requests the URI pointed to by request, and returns
a GInputStream that can be used to read its contents.
Note that you cannot use this method with SoupRequests attached to a SoupSessionAsync.
|
a SoupRequest |
|
a GCancellable or NULL
|
|
return location for a GError, or NULL
|
Returns : |
a GInputStream that can be used to
read from the URI pointed to by request. [transfer full]
|
Since 2.42
void soup_request_send_async (SoupRequest *request,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Begins an asynchronously request for the URI pointed to by
request.
Note that you cannot use this method with SoupRequests attached to a SoupSessionSync.
|
a SoupRequest |
|
a GCancellable or NULL
|
|
a GAsyncReadyCallback |
|
user data passed to callback
|
Since 2.42
GInputStream * soup_request_send_finish (SoupRequest *request,GAsyncResult *result,GError **error);
Gets the result of a soup_request_send_async().
|
a SoupRequest |
|
the GAsyncResult |
|
return location for a GError, or NULL
|
Returns : |
a GInputStream that can be used to
read from the URI pointed to by request. [transfer full]
|
Since 2.42
goffset soup_request_get_content_length (SoupRequest *request);
Gets the length of the data represented by request. For most
request types, this will not be known until after you call
soup_request_send() or soup_request_send_finish().
|
a SoupRequest |
Returns : |
the length of the data represented by request,
or -1 if not known. |
Since 2.42
const char * soup_request_get_content_type (SoupRequest *request);
Gets the type of the data represented by request. For most request
types, this will not be known until after you call
soup_request_send() or soup_request_send_finish().
As in the HTTP Content-Type header, this may include parameters after the MIME type.
|
a SoupRequest |
Returns : |
the type of the data represented by request,
or NULL if not known. |
Since 2.42
SoupSession * soup_request_get_session (SoupRequest *request);
Gets request's SoupSession
|
a SoupRequest |
Returns : |
request's SoupSession. [transfer none]
|
Since 2.42
SoupURI * soup_request_get_uri (SoupRequest *request);
Gets request's URI
|
a SoupRequest |
Returns : |
request's URI. [transfer none]
|
Since 2.42
void soup_request_disable_feature (SoupRequest *request,GType feature_type);
This disables the actions of SoupSessionFeatures with the
given feature_type (or a subclass of that type) on request, so
that request is processed as though the feature(s) hadn't been
added to the session. Eg, passing SOUP_TYPE_PROXY_URI_RESOLVER for
feature_type will disable proxy handling and cause request to be
sent directly to the indicated origin server, regardless of system
proxy configuration.
|
a SoupRequest |
|
the GType of a SoupSessionFeature |
Since 2.42
"session" property"session" SoupSession* : Read / Write / Construct Only
The request's session.