Namespace
Soup – 3.0
HTTP client/server library for GNOME
Dependencies
| GLib—2.0 | The base type system library |
| Browse documentation | |
| GObject—2.0 | The base type system library |
| Browse documentation | |
| Gio—2.0 | GObject Interfaces and Objects, Networking, IPC, and I/O |
| Browse documentation |
Classes
| Auth |
The abstract base class for handling authentication. since: 3.0 |
| AuthBasic |
HTTP “Basic” authentication. since: 3.0 |
| AuthDigest |
HTTP “Digest” authentication. since: 3.0 |
| AuthDomain |
Server-side authentication. since: 3.0 |
| AuthDomainBasic |
Server-side “Basic” authentication. since: 3.0 |
| AuthDomainDigest |
Server-side “Digest” authentication. since: 3.0 |
| AuthManager |
HTTP client-side authentication handler. since: 3.0 |
| AuthNegotiate |
HTTP-based GSS-Negotiate authentication, as defined by RFC 4559. since: 3.0 |
| AuthNTLM |
HTTP-based NTLM authentication. since: 3.0 |
| Cache |
File-based cache for HTTP resources. since: 3.0 |
| ContentDecoder |
Handles decoding of HTTP messages. since: 3.0 |
| ContentSniffer |
Sniffs the mime type of messages. since: 3.0 |
| CookieJar |
Automatic cookie handling for SoupSession. since: 3.0 |
| CookieJarDB |
Database-based Cookie Jar. since: 3.0 |
| CookieJarText |
Text-file-based (“cookies.txt”) Cookie Jar. since: 3.0 |
| HSTSEnforcer |
Automatic HTTP Strict Transport Security enforcing for since: 3.0 |
| HSTSEnforcerDB |
Persistent HTTP Strict Transport Security enforcer. since: 3.0 |
| Logger |
Debug logging support. since: 3.0 |
| Message |
Represents an HTTP message being sent or received. since: 3.0 |
| MultipartInputStream |
Handles streams of multipart messages. since: 3.0 |
| Server |
A HTTP server. since: 3.0 |
| ServerMessage |
An HTTP server request and response pair. since: 3.0 |
| Session |
Soup session state object. since: 3.0 |
| WebsocketConnection |
The WebSocket Protocol. since: 3.0 |
| WebsocketExtension |
A WebSocket extension. since: 3.0 |
| WebsocketExtensionDeflate |
A SoupWebsocketExtensionDeflate is a since: 3.0 |
| WebsocketExtensionManager |
SoupWebsocketExtensionManager is the since: 3.0 |
Interfaces
| SessionFeature |
Interface for miscellaneous since: 3.0 |
Structs
| Cookie |
Implements HTTP cookies, as described by RFC 6265. since: 3.0 |
| HSTSPolicy |
since: 3.0 |
| MessageBody |
since: 3.0 |
| MessageHeaders |
The HTTP message headers associated with a request or response. since: 3.0 |
| MessageHeadersIter |
An opaque type used to iterate over a %SoupMessageHeaders structure. since: 3.0 |
| MessageMetrics |
Contains metrics collected while loading a since: 3.0 |
| Multipart |
Represents a multipart HTTP message body, parsed according to the syntax of RFC 2046. since: 3.0 |
| Range |
Represents a byte range as used in the Range header. since: 3.0 |
Enumerations
| CacheType |
The type of cache; this affects what kinds of responses will be saved. since: 3.0 |
| CookieJarAcceptPolicy |
The policy for accepting or rejecting cookies returned in responses. since: 3.0 |
| DateFormat |
Date formats that since: 3.0 |
| Encoding |
How a message body is encoded for transport. since: 3.0 |
| HTTPVersion |
Indicates the HTTP protocol version being used. since: 3.0 |
| LoggerLogLevel |
Describes the level of logging output to provide. since: 3.0 |
| MemoryUse |
The lifetime of the memory being passed. since: 3.0 |
| MessageHeadersType |
Value passed to since: 3.0 |
| MessagePriority |
Priorities that can be set on a since: 3.0 |
| SameSitePolicy |
Represents the same-site policies of a cookie. since: 3.0 |
| Status |
These represent the known HTTP status code values, plus various network and internal errors. since: 3.0 |
| URIComponent |
Enum values passed to since: 3.0 |
| WebsocketCloseCode |
Pre-defined close codes that can be passed to
since: 3.0 |
| WebsocketConnectionType |
The type of a since: 3.0 |
| WebsocketDataType |
The type of data contained in a since: 3.0 |
| WebsocketState |
The state of the WebSocket connection. since: 3.0 |
Bitfields
| Cacheability |
Indicates if a message should or shouldn’t be cached. since: 3.0 |
| Expectation |
Represents the parsed value of the “Expect” header. since: 3.0 |
| MessageFlags |
Various flags that can be set on a since: 3.0 |
| ServerListenOptions |
Options to pass to since: 3.0 |
Error Domains
| SessionError |
A since: 3.0 |
| TLDError |
Error codes for since: 3.0 |
| WebsocketError |
WebSocket-related errors. since: 3.0 |
Callbacks
| AuthDomainBasicAuthCallback |
Callback used by since: 3.0 |
| AuthDomainDigestAuthCallback |
Callback used by since: 3.0 |
| AuthDomainFilter |
The prototype for a since: 3.0 |
| AuthDomainGenericAuthCallback |
The prototype for a since: 3.0 |
| LoggerFilter |
The prototype for a logging filter. since: 3.0 |
| LoggerPrinter |
The prototype for a custom printing callback. since: 3.0 |
| MessageHeadersForeachFunc |
The callback passed to since: 3.0 |
| ServerCallback |
A callback used to handle requests to a since: 3.0 |
| ServerWebsocketCallback |
A callback used to handle WebSocket requests to a since: 3.0 |
Functions
| check_version |
Like since: 3.0 |
| cookies_free |
Frees since: 3.0 |
| cookies_from_request |
Parses since: 3.0 |
| cookies_from_response |
Parses since: 3.0 |
| cookies_to_cookie_header |
Serializes a since: 3.0 |
| cookies_to_request |
Adds the name and value of each cookie in since: 3.0 |
| cookies_to_response |
Appends a “Set-Cookie” response header to since: 3.0 |
| date_time_new_from_http_string |
Parses since: 3.0 |
| date_time_to_string |
Converts since: 3.0 |
| form_decode |
Decodes since: 3.0 |
| form_decode_multipart |
Decodes the “multipart/form-data” request in since: 3.0 |
| form_encode |
Encodes the given field names and values into a value of type “application/x-www-form-urlencoded”. since: 3.0 |
| form_encode_datalist |
Encodes since: 3.0 |
| form_encode_hash |
Encodes since: 3.0 |
| form_encode_valist |
See since: 3.0 |
| get_major_version |
Returns the major version number of the libsoup library. since: 3.0 |
| get_micro_version |
Returns the micro version number of the libsoup library. since: 3.0 |
| get_minor_version |
Returns the minor version number of the libsoup library. since: 3.0 |
| header_contains |
Parses since: 3.0 |
| header_free_list |
Frees since: 3.0 |
| header_free_param_list |
Frees since: 3.0 |
| header_g_string_append_param |
Appends something like since: 3.0 |
| header_g_string_append_param_quoted |
Appends something like since: 3.0 |
| header_parse_list |
Parses a header whose content is described by RFC2616 as since: 3.0 |
| header_parse_param_list |
Parses a header which is a comma-delimited list of something like:
since: 3.0 |
| header_parse_param_list_strict |
A strict version of since: 3.0 |
| header_parse_quality_list |
Parses a header whose content is a list of items with optional “qvalue”s (eg, Accept, Accept-Charset, Accept-Encoding, Accept-Language, TE). since: 3.0 |
| header_parse_semi_param_list |
Parses a header which is a semicolon-delimited list of something
like: since: 3.0 |
| header_parse_semi_param_list_strict |
A strict version of since: 3.0 |
| headers_parse |
Parses the headers of an HTTP request or response in since: 3.0 |
| headers_parse_request |
Parses the headers of an HTTP request in since: 3.0 |
| headers_parse_response |
Parses the headers of an HTTP response in since: 3.0 |
| headers_parse_status_line |
Parses the HTTP Status-Line string in since: 3.0 |
| tld_domain_is_public_suffix |
Looks whether the since: 3.0 |
| tld_get_base_domain |
Finds the base domain for a given since: 3.0 |
| uri_copy |
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 since: 3.0 |
| uri_decode_data_uri |
Decodes the given data URI and returns its contents and since: 3.0 |
| uri_equal |
Tests whether or not since: 3.0 |
| websocket_client_prepare_handshake |
Adds the necessary headers to since: 3.0 |
| websocket_client_verify_handshake |
Looks at the response status code and headers in since: 3.0 |
| websocket_server_check_handshake |
Examines the method and request headers in since: 3.0 |
| websocket_server_process_handshake |
Examines the method and request headers in since: 3.0 |
Function Macros
| CHECK_VERSION |
Macro to test the version of libsoup being compiled against. since: 3.0 |
| DEPRECATED_FOR |
Marks a symbol as deprecated in favor of another symbol. since: 3.0 |
| DEPRECATED_IN_3_0_FOR |
A macro used to indicate a symbol was deprecated in this version with a replacement. since: 3.0 |
| DEPRECATED_IN_3_2_FOR |
A macro used to indicate a symbol was deprecated in this version with a replacement. since: 3.0 |
| DEPRECATED_IN_3_4_FOR |
A macro used to indicate a symbol was deprecated in this version with a replacement. since: 3.0 |
| UNAVAILABLE |
Marks a symbol unavailable before the given major and minor version. since: 3.0 |
Constants
| COOKIE_MAX_AGE_ONE_DAY |
A constant corresponding to 1 day. since: 3.0 |
| COOKIE_MAX_AGE_ONE_HOUR |
A constant corresponding to 1 hour. since: 3.0 |
| COOKIE_MAX_AGE_ONE_WEEK |
A constant corresponding to 1 week. since: 3.0 |
| COOKIE_MAX_AGE_ONE_YEAR |
A constant corresponding to 1 year. since: 3.0 |
| FORM_MIME_TYPE_MULTIPART |
A macro containing the value
since: 3.0 |
| FORM_MIME_TYPE_URLENCODED |
A macro containing the value
since: 3.0 |
| HSTS_POLICY_MAX_AGE_PAST |
An expiration date that is always in the past. since: 3.0 |
| HTTP_URI_FLAGS |
The set of since: 3.0 |
| MAJOR_VERSION |
Like since: 3.0 |
| MICRO_VERSION |
Like since: 3.0 |
| MINOR_VERSION |
Like since: 3.0 |
| VERSION_MIN_REQUIRED |
A macro that should be defined by the user prior to including
since: 3.0 |