Soup – 3.0

The abstract base class for handling authentication.

HTTP “Basic” authentication.

HTTP “Digest” authentication.

Server-side authentication.

Server-side “Basic” authentication.

Server-side “Digest” authentication.

HTTP client-side authentication handler.

HTTP-based GSS-Negotiate authentication, as defined by RFC 4559.

HTTP-based NTLM authentication.

File-based cache for HTTP resources.

Handles decoding of HTTP messages.

Sniffs the mime type of messages.

Automatic cookie handling for SoupSession.

Database-based Cookie Jar.

Text-file-based (“cookies.txt”) Cookie Jar.

Automatic HTTP Strict Transport Security enforcing for SoupSession.

Persistent HTTP Strict Transport Security enforcer.

Debug logging support.

Represents an HTTP message being sent or received.

Handles streams of multipart messages.

SoupServer provides a basic implementation of an HTTP server. The recommended usage of this server is for internal use, tasks like a mock server for tests, a private service for IPC, etc. It is not recommended to be exposed to untrusted clients as it may be vulnerable to denial of service attacks or other exploits.

An HTTP server request and response pair.

Soup session state object.

The WebSocket Protocol.

A WebSocket extension.

A SoupWebsocketExtensionDeflate is a SoupWebsocketExtension implementing permessage-deflate (RFC 7692).

SoupWebsocketExtensionManager is the SoupSessionFeature that handles WebSockets extensions for a SoupSession.

Interface for miscellaneous SoupSession features.

Implements HTTP cookies, as described by RFC 6265.

SoupHSTSPolicy implements HTTP policies, as described by RFC 6797.

SoupMessageBody represents the request or response body of a SoupMessage.

The HTTP message headers associated with a request or response.

An opaque type used to iterate over a %SoupMessageHeaders structure.

Contains metrics collected while loading a SoupMessage either from the network or the disk cache.

Represents a multipart HTTP message body, parsed according to the syntax of RFC 2046.

Represents a byte range as used in the Range header.

The type of cache; this affects what kinds of responses will be saved.

The policy for accepting or rejecting cookies returned in responses.

Date formats that soup_date_time_to_string() can use.

How a message body is encoded for transport.

Indicates the HTTP protocol version being used.

Describes the level of logging output to provide.

The lifetime of the memory being passed.

Value passed to soup_message_headers_new() to set certain default behaviors.

Priorities that can be set on a SoupMessage to instruct the message queue to process it before any other message with lower priority.

Represents the same-site policies of a cookie.

These represent the known HTTP status code values, plus various network and internal errors.

Enum values passed to soup_uri_copy() to indicate the components of the URI that should be updated with the given values.

Pre-defined close codes that can be passed to soup_websocket_connection_close() or received from soup_websocket_connection_get_close_code().

The type of a SoupWebsocketConnection.

The type of data contained in a SoupWebsocketConnection::message signal.

The state of the WebSocket connection.

Indicates if a message should or shouldn’t be cached.

Represents the parsed value of the “Expect” header.

Various flags that can be set on a SoupMessage to alter its behavior.

Options to pass to soup_server_listen(), etc.

A SoupSession error.

Error codes for SOUP_TLD_ERROR.

WebSocket-related errors.

Callback used by SoupAuthDomainBasic for authentication purposes.

Callback used by SoupAuthDomainDigest for authentication purposes.

The prototype for a SoupAuthDomain filter.

The prototype for a SoupAuthDomain generic authentication callback.

The prototype for a logging filter.

The prototype for a custom printing callback.

The callback passed to soup_message_headers_foreach().

A callback used to handle requests to a SoupServer.

A callback used to handle WebSocket requests to a SoupServer.

Like SOUP_CHECK_VERSION(), but the check for soup_check_version is at runtime instead of compile time.

Frees cookies.

Parses msg‘s Cookie request header and returns a GSList of SoupCookies.

Parses msg‘s Set-Cookie response headers and returns a GSList of SoupCookies.

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

Adds the name and value of each cookie in cookies to msg‘s “Cookie” request.

Appends a “Set-Cookie” response header to msg for each cookie in cookies.

Parses date_string and tries to extract a date from it.

Converts date to a string in the format described by format.

Decodes form.

Decodes the “multipart/form-data” request in multipart.

Encodes the given field names and values into a value of type “application/x-www-form-urlencoded”.

Encodes form_data_set into a value of type “application/x-www-form-urlencoded”.

Encodes form_data_set into a value of type “application/x-www-form-urlencoded”.

See soup_form_encode().

Returns the major version number of the libsoup library.

Returns the micro version number of the libsoup library.

Returns the minor version number of the libsoup library.

Parses header to see if it contains the token token (matched case-insensitively).

Frees list.

Frees param_list.

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.

Appends something like name="value" to string, taking care to escape any quotes or backslashes in value.

Parses a header whose content is described by RFC2616 as #something.

Parses a header which is a comma-delimited list of something like: token [ "=" ( token | quoted-string ) ].

A strict version of soup_header_parse_param_list() that bails out if there are duplicate parameters.

Parses a header whose content is a list of items with optional “qvalue”s (eg, Accept, Accept-Charset, Accept-Encoding, Accept-Language, TE).

Parses a header which is a semicolon-delimited list of something like: token [ "=" ( token | quoted-string ) ].

A strict version of soup_header_parse_semi_param_list() that bails out if there are duplicate parameters.

Parses the headers of an HTTP request or response in str and stores the results in dest.

Parses the headers of an HTTP request in str and stores the results in req_method, req_path, ver, and req_headers.

Parses the headers of an HTTP response in str and stores the results in ver, status_code, reason_phrase, and headers.

Parses the HTTP Status-Line string in status_line into ver, status_code, and reason_phrase.

Looks whether the domain passed as argument is a public domain suffix (.org, .com, .co.uk, etc) or not.

Finds the base domain for a given hostname.

As of 3.4.0 this will detect the default ports of HTTP(s) and WS(S) URIs when copying and set it to the default port of the new scheme. So for example copying http://localhost:80 while changing the scheme to https will result in https://localhost:443.

Decodes the given data URI and returns its contents and content_type.

Tests whether or not uri1 and uri2 are equal in all parts.

Adds the necessary headers to msg to request a WebSocket handshake including supported WebSocket extensions.

Looks at the response status code and headers in msg and determines if they contain a valid WebSocket handshake response (given the handshake request in msg‘s request headers).

Examines the method and request headers in msg and determines whether msg contains a valid handshake request.

Examines the method and request headers in msg and (assuming msg contains a valid handshake request), fills in the handshake response.

Macro to test the version of libsoup being compiled against.

Marks a symbol as deprecated in favor of another symbol.

A macro used to indicate a symbol was deprecated in this version with a replacement.

A macro used to indicate a symbol was deprecated in this version with a replacement.

A macro used to indicate a symbol was deprecated in this version with a replacement.

A macro used to indicate a symbol was deprecated in this version with a replacement.

Marks a symbol unavailable before the given major and minor version.

A constant corresponding to 1 day.

A constant corresponding to 1 hour.

A constant corresponding to 1 week.

A constant corresponding to 1 year.

A macro containing the value multipart/form-data; the MIME type used for posting form data that contains files to be uploaded.

A macro containing the value application/x-www-form-urlencoded; the default MIME type for POSTing HTML form data.

An expiration date that is always in the past.

The set of GUriFlags libsoup expects all GUri to use.

Like soup_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

Like soup_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

Like soup_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

A macro that should be defined by the user prior to including libsoup.h.