| libsoup Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
#include <libsoup/soup.h>
SoupRequestHTTP;
void soup_request_http_set_method (SoupRequestHTTP *http,
const char *method);
void soup_request_http_set_request_version
(SoupRequestHTTP *http,
SoupHTTPVersion version);
void soup_request_http_set_flags (SoupRequestHTTP *http,
SoupMessageFlags flags);
SoupMessageFlags soup_request_http_get_flags (SoupRequestHTTP *http);
void soup_request_http_set_first_party (SoupRequestHTTP *http,
SoupURI *first_party);
SoupURI * soup_request_http_get_first_party (SoupRequestHTTP *http);
gboolean soup_request_http_get_https_status (SoupRequestHTTP *http,
GTlsCertificate **certificate,
GTlsCertificateFlags *errors);
SoupMessage * soup_request_http_get_message (SoupRequestHTTP *http);
"first-party" SoupURI* : Read / Write "flags" SoupMessageFlags : Read / Write "method" gchar* : Read / Write "reason-phrase" gchar* : Read "request-headers" SoupMessageHeaders* : Read "request-uri" SoupURI* : Read / Write "request-version" SoupHTTPVersion : Read / Write "response-headers" SoupMessageHeaders* : Read "response-version" SoupHTTPVersion : Read "status-code" guint : Read "tls-certificate" GTlsCertificate* : Read "tls-errors" GTlsCertificateFlags : Read
typedef struct {
const char *method;
SoupURI *request_uri;
SoupHTTPVersion request_version;
SoupMessageHeaders *request_headers;
guint status_code;
char *reason_phrase;
SoupHTTPVersion response_version;
SoupMessageHeaders *response_headers;
} SoupRequestHTTP;
void soup_request_http_set_method (SoupRequestHTTP *http,const char *method);
void soup_request_http_set_request_version (SoupRequestHTTP *http,SoupHTTPVersion version);
Sets http to use the version of HTTP specified by version in its
request.
|
a SoupRequestHTTP |
|
the version of HTTP to use |
Since 2.42
void soup_request_http_set_flags (SoupRequestHTTP *http,SoupMessageFlags flags);
Sets the specified flags on msg. Note that some SoupMessageFlags
(such as SOUP_MESSAGE_CAN_REBUILD and
SOUP_MESSAGE_OVERWRITE_CHUNKS) have no effect in the SoupRequest
API.
|
a SoupRequestHTTP |
|
a set of SoupMessageFlags values |
Since 2.42
SoupMessageFlags soup_request_http_get_flags (SoupRequestHTTP *http);
Gets http's message flags.
|
a SoupRequestHTTP |
Returns : |
http's message flags |
Since 2.42
void soup_request_http_set_first_party (SoupRequestHTTP *http,SoupURI *first_party);
Sets first_party as the main document SoupURI for http. For
details of when and how this is used refer to the documentation for
SoupCookieJarAcceptPolicy.
|
a SoupRequestHTTP |
|
the SoupURI for the request's first party |
Since 2.42
SoupURI * soup_request_http_get_first_party (SoupRequestHTTP *http);
Gets http's first-party SoupURI; see the documentation
for SoupCookieJarAcceptPolicy for more details.
|
a SoupRequestHTTP |
Returns : |
http's first-party URI. [transfer none]
|
Since 2.42
gboolean soup_request_http_get_https_status (SoupRequestHTTP *http,GTlsCertificate **certificate,GTlsCertificateFlags *errors);
If http is using https, this retrieves the GTlsCertificate
associated with its connection, and the GTlsCertificateFlags showing
what problems, if any, have been found with that certificate.
|
a SoupRequestHTTP |
|
http's TLS certificate. [out][transfer none]
|
|
the verification status of certificate. [out]
|
Returns : |
TRUE if http uses https, FALSE if not |
Since 2.42
SoupMessage * soup_request_http_get_message (SoupRequestHTTP *http);
Gets a new reference to the SoupMessage associated to this SoupRequest
|
a SoupRequestHTTP object |
Returns : |
a new reference to the SoupMessage. [transfer full] |
Since 2.42
"first-party" property"first-party" SoupURI* : Read / Write
The SoupURI loaded in the application when the request was queued.
Since 2.42
"flags" property"flags" SoupMessageFlags : Read / Write
The request's SoupMessageFlags.
Since 2.42
"method" property"method" gchar* : Read / Write
The request's HTTP method; "GET" by default. Note that in
C you can simply read the method field
of the SoupRequestHTTP.
Default value: "GET"
Since 2.42
"reason-phrase" property"reason-phrase" gchar* : Read
The request's HTTP response reason phrase. Note that in C
you can simply read the reason_phrase
field of the SoupRequestHTTP.
Default value: NULL
Since 2.42
"request-headers" property"request-headers" SoupMessageHeaders* : Read
The request's HTTP request headers. Note that in C you can
simply read the request_headers field of
the SoupRequestHTTP.
Since 2.42
"request-uri" property"request-uri" SoupURI* : Read / Write
The request's SoupURI. Note that in C you can simply read
the request_uri field of the
SoupRequestHTTP.
Since 2.42
"request-version" property"request-version" SoupHTTPVersion : Read / Write
The SoupHTTPVersion used when sending the request;
SOUP_HTTP_1_1 by default. Note that in C you can simply
read the request_version field of the
SoupRequestHTTP.
Default value: SOUP_HTTP_1_1
Since 2.42
"response-headers" property"response-headers" SoupMessageHeaders* : Read
The request's HTTP response headers. Note that in C you can
simply read the response_headers field
of the SoupRequestHTTP.
Since 2.42
"response-version" property"response-version" SoupHTTPVersion : Read
The SoupHTTPVersion that the server replied with. Note
that in C you can simply read the
response_version field of the
SoupRequestHTTP.
Default value: SOUP_HTTP_1_1
Since 2.42
"status-code" property"status-code" guint : Read
The request's HTTP response status code. Note that in C you
can simply read the status_code field of
the SoupRequestHTTP.
Allowed values: <= 599
Default value: 0
Since 2.42
"tls-certificate" property"tls-certificate" GTlsCertificate* : Read
The GTlsCertificate associated with the request
Since 2.42
"tls-errors" property"tls-errors" GTlsCertificateFlags : Read
The verification errors on "tls-certificate"
Since 2.42