NULL for the default context Adds function to be executed from inside async_context with the default priority. Use this when you want to complete an action in with g_source_destroy().

Parameters:

GLib.MainContext async_context Required (not null)

Function (void* data) : GLib.Source Required (not null)

void* data Required (not null)

Returns:

GLib.Source

NULL for the default context Adds an idle event as with g_idle_add(), but using the given If you want function to run "right away", use soup_add_completion(), since that sets a higher priority on the GSource than soup_add_idle() does. with g_source_destroy().

Parameters:

GLib.MainContext async_context Required (not null)

Function (void* data) : GLib.Source Required (not null)

void* data Required (not null)

Returns:

GLib.Source

NULL for the default context Adds an I/O watch as with g_io_add_watch(), but using the given with g_source_destroy().

Parameters:

GLib.MainContext async_context Required (not null)

GLib.IOChannel chan Required (not null)

GObject.IOCondition condition Required (not null)

Function (IOChannel source, IOCondition condition, void* data) : GLib.Source Required (not null)

void* data Required (not null)

Returns:

GLib.Source

NULL for the default context Adds a timeout as with g_timeout_add(), but using the given with g_source_destroy().

Parameters:

GLib.MainContext async_context Required (not null)

Number interval Required (not null)

Function (void* data) : GLib.Source Required (not null)

void* data Required (not null)

Returns:

GLib.Source

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)

Soup.URI origin Required (not null)

Returns:

Soup.Cookie

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().) SoupCookies, which can be freed with soup_cookies_free().

Parameters:

Soup.Message msg Required (not null)

Returns:

Array a GSList of

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. SoupCookies, which can be freed with soup_cookies_free().

Parameters:

Soup.Message msg Required (not null)

Returns:

Array a GSList of

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

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)

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)

Returns:

none

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

Parameters:

String encoded_form Required (not null)

Returns:

Object a hash table containing the

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(). than file_control_name) from msg, which you can free with g_hash_table_destroy(). On error, it will return NULL.

Parameters:

Soup.Message msg Required (not null)

String file_control_name Required (not null)

Array filename Required (not null)

Array content_type Required (not null)

Soup.Buffer file Required (not null)

Returns:

Object

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)

Returns:

String

name/value pairs (as strings) 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

Returns:

String

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

Parameters:

String method Required (not null)

String uri Required (not null)

GLib.Data form_data_set Required (not null)

Returns:

Soup.Message

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

Parameters:

String method Required (not null)

String uri Required (not null)

Object form_data_set Required (not null)

the data to send to uri

Returns:

Soup.Message

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)

Soup.Multipart multipart Required (not null)

Returns:

Soup.Message

soup_header_parse_list() 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)

String token Required (not null)

Returns:

Boolean

soup_header_parse_quality_list() Frees list.

Parameters:

Array list Required (not null)

or

Returns:

none

or soup_header_parse_semi_param_list() Frees param_list.

Parameters:

Object param_list Required (not null)

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)

String name Required (not null)

String value Required (not null)

Returns:

none

Appends something like name="value" to

Parameters:

GLib.String string Required (not null)

String name Required (not null)

String value Required (not null)

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.

Parameters:

String header Required (not null)

Returns:

Array

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). with soup_header_free_param_list().

Parameters:

String header Required (not null)

Returns:

Object

unacceptable values 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. strings), highest-qvalue first.

Parameters:

String header Required (not null)

Object out_values

Array unacceptable

Returns:

Array

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). with soup_header_free_param_list().

Parameters:

String header Required (not null)

Returns:

Object

and the trailing blank line) 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)

Number len Required (not null)

the terminating blank line.

Soup.MessageHeaders dest Required (not null)

Returns:

Boolean

request method request path version 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)

Number len Required (not null)

the terminating blank line.

Soup.MessageHeaders req_headers Required (not null)

Object out_values

String req_method

String req_path

Soup.HTTPVersion ver

Returns:

Number

version the status code the reason phrase 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)

Number len Required (not null)

the terminating blank line.

Soup.MessageHeaders headers Required (not null)

Object out_values

Soup.HTTPVersion ver

Number status_code

String reason_phrase

Returns:

Boolean

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

Parameters:

String status_line Required (not null)

Object out_values

Soup.HTTPVersion ver

Number status_code

String reason_phrase

Returns:

Boolean

soup_ssl_get_client_credentials(). Frees creds.

Parameters:

Soup.SSLCredentials creds Required (not null)

Returns:

none

soup_ssl_get_server_credentials(). Frees creds.

Parameters:

Soup.SSLCredentials creds Required (not null)

Returns:

none

Authority certificates. Creates an opaque client credentials object which can later be passed to soup_ssl_wrap_iochannel(). If ca_file is non-NULL, any certificate received from a server must be signed by one of the CAs in the file, or an error will be returned. soup_ssl_free_client_credentials().

Parameters:

String ca_file Required (not null)

Returns:

Soup.SSLCredentials

certificate Creates an opaque server credentials object which can later be passed to soup_ssl_wrap_iochannel(). soup_ssl_free_server_credentials().

Parameters:

String cert_file Required (not null)

String key_file Required (not null)

Returns:

Soup.SSLCredentials

This attempts to wrap a new GIOChannel around sock that will SSL-encrypt/decrypt all traffic through it. failure.

Parameters:

GLib.IOChannel sock Required (not null)

Boolean non_blocking Required (not null)

Soup.SSLType type Required (not null)

String remote_host Required (not null)

Soup.SSLCredentials creds Required (not null)

Returns:

GLib.IOChannel

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:

Number status_code Required (not null)

Returns:

String 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:

Number status_code Required (not null)

Returns:

Number

Compares v1 and v2 in a case-insensitive manner

Parameters:

void* v1 Required (not null)

void* v2 Required (not null)

Returns:

Boolean

Hashes key in a case-insensitive manner.

Parameters:

void* key Required (not null)

Returns:

Number

Fully %-decodes part. code was encountered.

Parameters:

String part Required (not null)

Returns:

String

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)

String escape_extra Required (not null)

Returns:

String

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

Parameters:

void* v1 Required (not null)

void* v2 Required (not null)

Returns:

Boolean

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

Parameters:

void* key Required (not null)

Returns:

Number

%-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. code was encountered.

Parameters:

String part Required (not null)

String unescape_extra Required (not null)

Returns:

String

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

Returns:

GObject.ValueArray

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

Parameters:

Object hash Required (not null)

String key Required (not null)

GObject.Value value Required (not null)

Returns:

none

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

Returns:

Object

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)

GObject.Value params Required (not null)

Number n_params Required (not null)

Returns:

String

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)

Returns:

String

Returns:

Number

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)

Number length Required (not null)

Object out_values

String method_name

GObject.ValueArray params

Returns:

Boolean

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)

Number length Required (not null)

Object out_values

GObject.Value value

Returns:

Boolean