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