Parses header and returns a SoupCookie. (If header contains
multiple cookies, only the first one will be parsed.)
If header does not have "path" or "domain" attributes, they will
be defaulted from origin. If origin is NULL, path will default
to "/", but domain will be left as NULL. Note that this is not a
valid state for a SoupCookie, and you will need to fill in some
appropriate string for the domain if you want to actually make use
of the cookie.
parsed, or contained an illegal "domain" attribute for a cookie
originating from origin.

Parameters:

String header Required (not null)

a cookie string (eg, the value of a Set-Cookie header)

Soup.URI origin Required (not null)

origin of the cookie, or NULL

Returns:

Soup.Cookie a new SoupCookie, or NULL if it could not be

Parses msg's Cookie request header and returns a GSList of
SoupCookies. As the "Cookie" header, unlike "Set-Cookie",
only contains cookie names and values, none of the other
SoupCookie fields will be filled in. (Thus, you can't generally
pass a cookie returned from this method directly to
soup_cookies_to_response().)
of SoupCookies, which can be freed with
soup_cookies_free().

Parameters:

Soup.Message msg Required (not null)

a SoupMessage containing a "Cookie" request header

Returns:

Array a GSList

Parses msg's Set-Cookie response headers and returns a GSList of
SoupCookies. Cookies that do not specify "path" or
"domain" attributes will have their values defaulted from msg.
of SoupCookies, which can be freed with
soup_cookies_free().

Parameters:

Soup.Message msg Required (not null)

a SoupMessage containing a "Set-Cookie" response header

Returns:

Array a GSList

Serializes a GSList of SoupCookie into a string suitable for
setting as the value of the "Cookie" header.

Parameters:

Array cookies Required (not null)

a GSList of SoupCookie

Returns:

String the serialization of cookies

Adds the name and value of each cookie in cookies to msg's
"Cookie" request. (If msg already has a "Cookie" request header,
these cookies will be appended to the cookies already present. Be
careful that you do not append the same cookies twice, eg, when
requeuing a message.)

Parameters:

Array cookies Required (not null)

a GSList of SoupCookie

Soup.Message msg Required (not null)

a SoupMessage

Returns:

none

Appends a "Set-Cookie" response header to msg for each cookie in

Parameters:

Array cookies Required (not null)

a GSList of SoupCookie

Soup.Message msg Required (not null)

a SoupMessage

Returns:

none

Decodes form, which is an urlencoded dataset as defined in the
HTML 4.01 spec.
table containing the name/value pairs from encoded_form, which you
can free with g_hash_table_destroy().

Parameters:

String encoded_form Required (not null)

data of type "application/x-www-form-urlencoded"

Returns:

Object a hash

Decodes the "multipart/form-data" request in msg; this is a
convenience method for the case when you have a single file upload
control in a form. (Or when you don't have any file upload
controls, but are still using "multipart/form-data" anyway.) Pass
the name of the file upload control in file_control_name, and
soup_form_decode_multipart() will extract the uploaded file data
into filename, content_type, and file. All of the other form
control data will be returned (as strings, as with
soup_form_decode()) in the returned GHashTable.
You may pass NULL for filename and/or content_type if you do not
care about those fields. soup_form_decode_multipart() may also
return NULL in those fields if the client did not provide that
information. You must free the returned filename and content-type
with g_free(), and the returned file data with soup_buffer_free().
If you have a form with more than one file upload control, you will
need to decode it manually, using soup_multipart_new_from_message()
and soup_multipart_get_part().
table containing the name/value pairs (other than
g_hash_table_destroy(). On error, it will return NULL.

Parameters:

Soup.Message msg Required (not null)

a SoupMessage containing a "multipart/form-data" request body

String file_control_name Required (not null)

the name of the HTML file upload control, or NULL

Object out_values

String filename

String content_type

Soup.Buffer file

Returns:

Object a hash

Encodes form_data_set into a value of type
"application/x-www-form-urlencoded", as defined in the HTML 4.01
spec. Unlike soup_form_encode_hash(), this preserves the ordering
of the form elements, which may be required in some situations.

Parameters:

GLib.Data form_data_set Required (not null)

a datalist containing name/value pairs

Returns:

String the encoded form

Encodes form_data_set into a value of type
"application/x-www-form-urlencoded", as defined in the HTML 4.01
spec.
Note that the HTML spec states that "The control names/values are
listed in the order they appear in the document." Since this method
takes a hash table, it cannot enforce that; if you care about the
ordering of the form fields, use soup_form_encode_datalist().

Parameters:

Object form_data_set Required (not null)

a hash table containing name/value pairs (as strings)

Returns:

String the encoded form

Creates a new SoupMessage and sets it up to send form_data_set to

Parameters:

String method Required (not null)

the HTTP method, either "GET" or "POST"

String uri Required (not null)

the URI to send the form data to

GLib.Data form_data_set Required (not null)

the data to send to uri

Returns:

Soup.Message the new SoupMessage

Creates a new SoupMessage and sets it up to send form_data_set to

Parameters:

String method Required (not null)

the HTTP method, either "GET" or "POST"

String uri Required (not null)

the URI to send the form data to

Object form_data_set Required (not null)

the data to send to uri

Returns:

Soup.Message the new SoupMessage

Creates a new SoupMessage and sets it up to send multipart to
To send a "multipart/form-data" POST, first
create a SoupMultipart, using SOUP_FORM_MIME_TYPE_MULTIPART as
the MIME type. Then use soup_multipart_append_form_string() and
soup_multipart_append_form_file() to add the value of each form
control to the multipart. (These are just convenience methods, and
you can use soup_multipart_append_part() if you need greater
control over the part headers.) Finally, call
soup_form_request_new_from_multipart() to serialize the multipart
structure and create a SoupMessage.

Parameters:

String uri Required (not null)

the URI to send the form data to

Soup.Multipart multipart Required (not null)

a "multipart/form-data" SoupMultipart

Returns:

Soup.Message the new SoupMessage

Parses header to see if it contains the token token (matched
case-insensitively). Note that this can't be used with lists
that have qvalues.

Parameters:

String header Required (not null)

An HTTP header suitable for parsing with soup_header_parse_list()

String token Required (not null)

a token

Returns:

gboolean whether or not header contains token

Frees param_list.

Parameters:

Object param_list Required (not null)

a GHashTable returned from soup_header_parse_param_list() or soup_header_parse_semi_param_list()

Returns:

none

Appends something like name=value to string,
taking care to quote value if needed, and if so, to escape any
quotes or backslashes in value.
Alternatively, if value is a non-ASCII UTF-8 string, it will be
appended using RFC2231 syntax. Although in theory this is supposed
to work anywhere in HTTP that uses this style of parameter, in
reality, it can only be used portably with the Content-Disposition
"filename" parameter.
If value is NULL, this will just append name to string.

Parameters:

GLib.String string Required (not null)

a GString being used to construct an HTTP header value

String name Required (not null)

a parameter name

String value Required (not null)

a parameter value, or NULL

Returns:

none

Appends something like name="value" to

Parameters:

GLib.String string Required (not null)

a GString being used to construct an HTTP header value

String name Required (not null)

a parameter name

String value Required (not null)

a parameter value

Returns:

none

Parses a header whose content is described by RFC2616 as
"something", where "something" does not itself contain commas,
except as part of quoted-strings.
allocated strings

Parameters:

String header Required (not null)

a header value

Returns:

Array a GSList of list elements, as

Parses a header which is a comma-delimited list of something like:
token [ "=" ( token | quoted-string ) ].
Tokens that don't have an associated value will still be added to
the resulting hash table, but with a NULL value.
This also handles RFC2231 encoding (which in HTTP is mostly used
for giving UTF8-encoded filenames in the Content-Disposition
header).
GHashTable of list elements, which can be freed with
soup_header_free_param_list().

Parameters:

String header Required (not null)

a header value

Returns:

Object a

Parses a header whose content is a list of items with optional
"qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding,
Accept-Language, TE).
If unacceptable is not NULL, then on return, it will contain the
items with qvalue 0. Either way, those items will be removed from
the main list.
allocated strings), highest-qvalue first.

Parameters:

String header Required (not null)

a header value

Object out_values

Array unacceptable

Returns:

Array a GSList of acceptable values (as

Parses a header which is a semicolon-delimited list of something
Tokens that don't have an associated value will still be added to
the resulting hash table, but with a NULL value.
This also handles RFC2231 encoding (which in HTTP is mostly used
for giving UTF8-encoded filenames in the Content-Disposition
header).
GHashTable of list elements, which can be freed with
soup_header_free_param_list().

Parameters:

String header Required (not null)

a header value

Returns:

Object a

Parses the headers of an HTTP request or response in str and
stores the results in dest. Beware that dest may be modified even
on failure.
This is a low-level method; normally you would use
soup_headers_parse_request() or soup_headers_parse_response().

Parameters:

String str Required (not null)

the header string (including the Request-Line or Status-Line, and the trailing blank line)

gint32 len Required (not null)

length of str up to (but not including) the terminating blank line.

Soup.MessageHeaders dest Required (not null)

SoupMessageHeaders to store the header values in

Returns:

gboolean success or failure

Parses the headers of an HTTP request in str and stores the
results in req_method, req_path, ver, and req_headers.
Beware that req_headers may be modified even on failure.
HTTP error to be returned to the client if they could not be.

Parameters:

String str Required (not null)

the header string (including the trailing blank line)

gint32 len Required (not null)

length of str up to (but not including) the terminating blank line.

Soup.MessageHeaders req_headers Required (not null)

SoupMessageHeaders to store the header values in

Object out_values

String req_method

String req_path

Soup.HTTPVersion ver

Returns:

guint32 SOUP_STATUS_OK if the headers could be parsed, or an

Parses the headers of an HTTP response in str and stores the
results in ver, status_code, reason_phrase, and headers.
Beware that headers may be modified even on failure.

Parameters:

String str Required (not null)

the header string (including the trailing blank line)

gint32 len Required (not null)

length of str up to (but not including) the terminating blank line.

Soup.MessageHeaders headers Required (not null)

SoupMessageheaders to store the header values in

Object out_values

Soup.HTTPVersion ver

guint32 status_code

String reason_phrase

Returns:

gboolean success or failure.

Parses the HTTP Status-Line string in status_line into ver,
either "\0" or "\r\n".

Parameters:

String status_line Required (not null)

an HTTP Status-Line

Object out_values

Soup.HTTPVersion ver

guint32 status_code

String reason_phrase

Returns:

gboolean TRUE if status_line was parsed successfully.

Returns:

guint32

The quark used as SOUP_SSL_ERROR

Returns:

guint32 The quark used as SOUP_SSL_ERROR

Looks up the stock HTTP description of status_code. This is used
by soup_message_set_status() to get the correct text to go with a
given status code.
There is no reason for you to ever use this
function. If you wanted the textual description for the
status_code of a given SoupMessage, you should just look at the
message's reason_phrase. However, you should only do that for use
in debugging messages; HTTP reason phrases are not localized, and
are not generally very descriptive anyway, and so they should never
be presented to the user directly. Instead, you should create you
own error messages based on the status code, and on what you were
trying to do.

Parameters:

guint32 status_code Required (not null)

an HTTP status code

Returns:

String the (terse, English) description of status_code

Turns SOUP_STATUS_CANT_RESOLVE into
SOUP_STATUS_CANT_RESOLVE_PROXY and SOUP_STATUS_CANT_CONNECT into
SOUP_STATUS_CANT_CONNECT_PROXY. Other status codes are passed
through unchanged.

Parameters:

guint32 status_code Required (not null)

a status code

Returns:

guint32 the "proxified" equivalent of status_code.

Compares v1 and v2 in a case-insensitive manner

Parameters:

void* v1 Required (not null)

an ASCII string

void* v2 Required (not null)

another ASCII string

Returns:

gboolean TRUE if they are equal (modulo case)

Hashes key in a case-insensitive manner.

Parameters:

void* key Required (not null)

ASCII string to hash

Returns:

guint32 the hash code.

Fully %-decodes part.
In the past, this would return NULL if part contained invalid
percent-encoding, but now it just ignores the problem (as
soup_uri_new() already did).

Parameters:

String part Required (not null)

a URI part

Returns:

String the decoded URI part.

This %-encodes the given URI part and returns the escaped
version in allocated memory, which the caller must free when it is
done.

Parameters:

String part Required (not null)

a URI part

String escape_extra Required (not null)

additional reserved characters to escape (or NULL)

Returns:

String the encoded URI part

Compares v1 and v2, considering only the scheme, host, and port.
and port.

Parameters:

void* v1 Required (not null)

a SoupURI

void* v2 Required (not null)

a SoupURI

Returns:

gboolean whether or not the URIs are equal in scheme, host,

Hashes key, considering only the scheme, host, and port.

Parameters:

void* key Required (not null)

a SoupURI

Returns:

guint32 a hash

%-decodes any "unreserved" characters (or characters in
"Unreserved" characters are those that are not allowed to be used
for punctuation according to the URI spec. For example, letters are
unreserved, so soup_uri_normalize() will turn
http://example.com/foo/b%61r into
http://example.com/foo/bar, which is guaranteed
to mean the same thing. However, "/" is "reserved", so
http://example.com/foo%2Fbar would not
be changed, because it might mean something different to the
server.
In the past, this would return NULL if part contained invalid
percent-encoding, but now it just ignores the problem (as
soup_uri_new() already did).

Parameters:

String part Required (not null)

a URI part

String unescape_extra Required (not null)

reserved characters to unescape (or NULL)

Returns:

String the normalized URI part

Creates a new GValueArray. (This is just a wrapper around
g_value_array_new(), for naming consistency purposes.)

Returns:

GObject.ValueArray a new GValueArray

Inserts value into hash. (Unlike with g_hash_table_insert(), both
the key and the value are copied).

Parameters:

Object hash Required (not null)

a value hash

String key Required (not null)

the key

GObject.Value value Required (not null)

a value

Returns:

none

Creates a GHashTable whose keys are strings and whose values
are GValue.
empty GHashTable

Returns:

Object a new

This creates an XML-RPC methodCall and returns it as a string.
This is the low-level method that soup_xmlrpc_request_new() and
soup_xmlrpc_call() are built on.
GValueArray, you can just pass its values and n_values fields.)
The correspondence between glib types and XML-RPC types is:
For structs, use a GHashTable that maps strings to GValue;
soup_value_hash_new() and related methods can help with this.

Parameters:

String method_name Required (not null)

the name of the XML-RPC method

GObject.Value params Required (not null)

arguments to method

gint32 n_params Required (not null)

length of params

Returns:

String the text of the methodCall, or NULL on error

This creates a (successful) XML-RPC methodResponse and returns it
as a string. To create a fault response, use
soup_xmlrpc_build_fault().
The glib type to XML-RPC type mapping is as with
soup_xmlrpc_build_method_call(), qv.

Parameters:

GObject.Value value Required (not null)

the return value

Returns:

String the text of the methodResponse, or NULL on error

Returns:

guint32

Returns:

guint32

Parses method_call to get the name and parameters, and returns the
parameter values in a GValueArray; see also
soup_xmlrpc_extract_method_call(), which is more convenient if you
know in advance what the types of the parameters will be.

Parameters:

String method_call Required (not null)

the XML-RPC methodCall string

gint32 length Required (not null)

the length of method_call, or -1 if it is NUL-terminated

Object out_values

String method_name

GObject.ValueArray params

Returns:

gboolean success or failure.

Parses method_response and returns the return value in value. If
will be set to an error of type SOUP_XMLRPC_FAULT, with the error
code containing the fault code, and the error message containing
the fault string. (If method_response cannot be parsed at all,
soup_xmlrpc_parse_method_response() will return FALSE, but error
will be unset.)
response could not be parsed, or contained a fault.

Parameters:

String method_response Required (not null)

the XML-RPC methodResponse string

gint32 length Required (not null)

the length of method_response, or -1 if it is NUL-terminated

Object out_values

GObject.Value value

Returns:

gboolean TRUE if a return value was parsed, FALSE if the