Soup

---

Description:

Content:

Namespaces:

• Form
• XMLRPC

Interfaces:

• PasswordManager
• ProxyResolver
• ProxyURIResolver
• SessionFeature - An object that implement some sort of optional feature for Session.

Classes:

• Address
• Auth - The abstract base class for handling authentication.
• AuthBasic -
• AuthDigest -
• AuthDomain
• AuthDomainBasic
• AuthDomainDigest
• AuthManager
• AuthNTLM -
• AuthNegotiate
• Buffer - A data buffer, generally used to represent a chunk of a MessageBody.
• ByteArray
• Cache
• ClientContext - A ClientContext provides additional information about the client making a particular request.
• Connection
• ContentDecoder
• ContentSniffer
• Cookie - An HTTP cookie.
• CookieJar
• CookieJarDB
• CookieJarText
• Date - A date and time.
• HSTSEnforcer
• HSTSEnforcerDB
• HSTSPolicy - An HTTP Strict Transport Security policy.
• Logger
• Message - Represents an HTTP message being sent or received.
• MessageBody - A Message request or response body.
• MessageHeaders - The HTTP message headers associated with a request or response.
• MessageQueue
• MessageQueueItem
• Multipart - Represents a multipart HTTP message body, parsed according to the syntax of RFC 2046.
• MultipartInputStream
• ProxyResolverDefault
• Request - A request to retrieve a particular URI.
• RequestData
• RequestFile
• RequestHTTP
• Requester
• Server -
• Session
• SessionAsync -
• SessionSync -
• Socket
• URI - A URI represents a (parsed) URI.
• WebsocketConnection - A class representing a WebSocket connection.
• WebsocketExtension
• WebsocketExtensionDeflate
• WebsocketExtensionManager
• XMLRPCParams - Opaque structure containing XML-RPC methodCall parameter values.

Structs:

• MessageHeadersIter - An opaque type used to iterate over a MessageHeaders structure.
• Range - Represents a byte range as used in the Range header.

Enums:

• AddressFamily - The supported address families.
• CacheResponse
• CacheType - The type of cache; this affects what kinds of responses will be saved.
• Cacheability
• ConnectionState
• CookieJarAcceptPolicy - The policy for accepting or rejecting cookies returned in responses.
• DateFormat - Date formats that to_string can use.
• Encoding - How a message body is encoded for transport
• Expectation - Represents the parsed value of the "Expect" header.
• HTTPVersion - Indicates the HTTP protocol version being used.
• KnownStatusCode -
• LoggerLogLevel - Describes the level of logging output to provide.
• MemoryUse - Describes how Buffer should use the data passed in by the caller.
• MessageFlags - Various flags that can be set on a Message to alter its behavior.
• MessageHeadersType - Value passed to MessageHeaders to set certain default behaviors.
• MessagePriority - Priorities that can be set on a Message to instruct the message queue to process it before any other message with lower priority.
• SameSitePolicy
• ServerListenOptions - Options to pass to listen, etc.
• SocketIOStatus - Return value from the Socket IO methods.
• Status - These represent the known HTTP status code values, plus various network and internal errors.
• WebsocketCloseCode - Pre-defined close codes that can be passed to close or received from get_close_code.
• WebsocketConnectionType - The type of a WebsocketConnection.
• WebsocketDataType - The type of data contained in a message signal.
• WebsocketError - WebSocket-related errors.
• WebsocketState - The state of the WebSocket connection.

Error domains:

• RequestError - A Request error.
• RequesterError
• TLDError - Error codes for SOUP_TLD_ERROR.

Constants:

• public const int ADDRESS_ANY_PORT
  This can be passed to any Address method that expects a port, to indicate that you don't care what port is used.
• public const string ADDRESS_FAMILY
  Alias for the family property.
• public const string ADDRESS_NAME
  Alias for the name property.
• public const string ADDRESS_PHYSICAL
  An alias for the physical property.
• public const string ADDRESS_PORT
  An alias for the port property.
• public const string ADDRESS_PROTOCOL
  Alias for the protocol property.
• public const string ADDRESS_SOCKADDR
  An alias for the sockaddr property.
• public const string AUTH_DOMAIN_ADD_PATH
  Alias for the SoupAuthDomain:add-path property.
• public const string AUTH_DOMAIN_BASIC_AUTH_CALLBACK
  Alias for the auth_callback property.
• public const string AUTH_DOMAIN_BASIC_AUTH_DATA
  Alias for the auth_data property.
• public const string AUTH_DOMAIN_DIGEST_AUTH_CALLBACK
  Alias for the auth_callback property.
• public const string AUTH_DOMAIN_DIGEST_AUTH_DATA
  Alias for the auth_callback property.
• public const string AUTH_DOMAIN_FILTER
  Alias for the filter property.
• public const string AUTH_DOMAIN_FILTER_DATA
  Alias for the filter_data property.
• public const string AUTH_DOMAIN_GENERIC_AUTH_CALLBACK
  Alias for the generic_auth_callback property.
• public const string AUTH_DOMAIN_GENERIC_AUTH_DATA
  Alias for the generic_auth_data property.
• public const string AUTH_DOMAIN_PROXY
  Alias for the proxy property.
• public const string AUTH_DOMAIN_REALM
  Alias for the realm property.
• public const string AUTH_DOMAIN_REMOVE_PATH
  Alias for the SoupAuthDomain:remove-path property.
• public const string AUTH_HOST
  An alias for the host property.
• public const string AUTH_IS_AUTHENTICATED
  An alias for the is_authenticated property.
• public const string AUTH_IS_FOR_PROXY
  An alias for the is_for_proxy property.
• public const string AUTH_REALM
  An alias for the realm property.
• public const string AUTH_SCHEME_NAME
  An alias for the scheme_name property.
• public const int CHAR_HTTP_CTL
• public const int CHAR_HTTP_SEPARATOR
• public const int CHAR_URI_GEN_DELIMS
• public const int CHAR_URI_PERCENT_ENCODED
• public const int CHAR_URI_SUB_DELIMS
• public const string COOKIE_JAR_ACCEPT_POLICY
  Alias for the accept_policy property.
• public const string COOKIE_JAR_DB_FILENAME
  Alias for the filename property.
• public const string COOKIE_JAR_READ_ONLY
  Alias for the read_only property.
• public const string COOKIE_JAR_TEXT_FILENAME
  Alias for the filename property.
• public const int COOKIE_MAX_AGE_ONE_DAY
  A constant corresponding to 1 day, for use with Cookie and set_max_age.
• public const int COOKIE_MAX_AGE_ONE_HOUR
  A constant corresponding to 1 hour, for use with Cookie and set_max_age.
• public const int COOKIE_MAX_AGE_ONE_WEEK
  A constant corresponding to 1 week, for use with Cookie and set_max_age.
• public const int COOKIE_MAX_AGE_ONE_YEAR
  A constant corresponding to 1 year, for use with Cookie and set_max_age.
• public const string FORM_MIME_TYPE_MULTIPART
  A macro containing the value "multipart/form-data"; the MIME type used for posting form data that contains files to be uploaded.
• public const string FORM_MIME_TYPE_URLENCODED
  A macro containing the value "application/x-www-form-urlencoded"; the default MIME type for POSTing HTML form data.
• public const string HSTS_ENFORCER_DB_FILENAME
• public const int HSTS_POLICY_MAX_AGE_PAST
• public const string LOGGER_LEVEL
  Alias for the level property, qv.
• public const string LOGGER_MAX_BODY_SIZE
  Alias for the max_body_size property, qv.
• public const int MAJOR_VERSION
  Like get_major_version, but from the headers used at application compile time, rather than from the library linked against at application run time.
• public const string MESSAGE_FIRST_PARTY
  Alias for the first_party property.
• public const string MESSAGE_FLAGS
  Alias for the flags property.
• public const string MESSAGE_HTTP_VERSION
  Alias for the http_version property.
• public const string MESSAGE_IS_TOP_LEVEL_NAVIGATION
• public const string MESSAGE_METHOD
  Alias for the method property.
• public const string MESSAGE_PRIORITY
  Sets the priority of the Message.
• public const string MESSAGE_REASON_PHRASE
  Alias for the reason_phrase property.
• public const string MESSAGE_REQUEST_BODY
  Alias for the SoupMessage:request-body property.
• public const string MESSAGE_REQUEST_BODY_DATA
  Alias for the SoupMessage:request-body-data property.
• public const string MESSAGE_REQUEST_HEADERS
  Alias for the SoupMessage:request-headerss property.
• public const string MESSAGE_RESPONSE_BODY
  Alias for the SoupMessage:response-body property.
• public const string MESSAGE_RESPONSE_BODY_DATA
  Alias for the SoupMessage:response-body-data property.
• public const string MESSAGE_RESPONSE_HEADERS
  Alias for the SoupMessage:response-headerss property.
• public const string MESSAGE_SERVER_SIDE
  Alias for the server_side property.
• public const string MESSAGE_SITE_FOR_COOKIES
• public const string MESSAGE_STATUS_CODE
  Alias for the status_code property.
• public const string MESSAGE_TLS_CERTIFICATE
  Alias for the tls_certificate property.
• public const string MESSAGE_TLS_ERRORS
  Alias for the tls_errors property.
• public const string MESSAGE_URI
  Alias for the uri property.
• public const int MICRO_VERSION
  Like get_micro_version, but from the headers used at application compile time, rather than from the library linked against at application run time.
• public const int MINOR_VERSION
  Like get_minor_version, but from the headers used at application compile time, rather than from the library linked against at application run time.
• public const string REQUEST_SESSION
  Alias for the session property, qv.
• public const string REQUEST_URI
  Alias for the uri property, qv.
• public const string SERVER_ASYNC_CONTEXT
  Alias for the deprecated async_context property, qv.
• public const string SERVER_HTTPS_ALIASES
  Alias for the https_aliases property, qv.
• public const string SERVER_HTTP_ALIASES
  Alias for the http_aliases property, qv.
• public const string SERVER_INTERFACE
  Alias for the @interface property, qv.
• public const string SERVER_PORT
  Alias for the deprecated port property, qv.
• public const string SERVER_RAW_PATHS
  Alias for the raw_paths property.
• public const string SERVER_SERVER_HEADER
  Alias for the server_header property, qv.
• public const string SERVER_SSL_CERT_FILE
  Alias for the ssl_cert_file property, qv.
• public const string SERVER_SSL_KEY_FILE
  Alias for the ssl_key_file property, qv.
• public const string SERVER_TLS_CERTIFICATE
  Alias for the tls_certificate property, qv.
• public const string SESSION_ACCEPT_LANGUAGE
  Alias for the accept_language property, qv.
• public const string SESSION_ACCEPT_LANGUAGE_AUTO
  Alias for the accept_language_auto property, qv.
• public const string SESSION_ASYNC_CONTEXT
  Alias for the async_context property, qv.
• public const string SESSION_HTTPS_ALIASES
  Alias for the https_aliases property, qv.
• public const string SESSION_HTTP_ALIASES
  Alias for the http_aliases property, qv.
• public const string SESSION_IDLE_TIMEOUT
  Alias for the idle_timeout property, qv.
• public const string SESSION_LOCAL_ADDRESS
  Alias for the local_address property, qv.
• public const string SESSION_MAX_CONNS
  Alias for the max_conns property, qv.
• public const string SESSION_MAX_CONNS_PER_HOST
  Alias for the max_conns_per_host property, qv.
• public const string SESSION_PROXY_RESOLVER
  Alias for the proxy_resolver property, qv.
• public const string SESSION_PROXY_URI
  Alias for the proxy_uri property, qv.
• public const string SESSION_SSL_CA_FILE
  Alias for the ssl_ca_file property, qv.
• public const string SESSION_SSL_STRICT
  Alias for the ssl_strict property, qv.
• public const string SESSION_SSL_USE_SYSTEM_CA_FILE
  Alias for the ssl_use_system_ca_file property, qv.
• public const string SESSION_TIMEOUT
  Alias for the timeout property, qv.
• public const string SESSION_TLS_DATABASE
  Alias for the tls_database property, qv.
• public const string SESSION_TLS_INTERACTION
  Alias for the tls_interaction property, qv.
• public const string SESSION_USER_AGENT
  Alias for the user_agent property, qv.
• public const string SESSION_USE_NTLM
  Alias for the use_ntlm property, qv.
• public const string SESSION_USE_THREAD_CONTEXT
  Alias for the use_thread_context property, qv.
• public const string SOCKET_ASYNC_CONTEXT
  Alias for the async_context property.
• public const string SOCKET_FLAG_NONBLOCKING
  Alias for the non_blocking property.
• public const string SOCKET_IS_SERVER
  Alias for the is_server property, qv.
• public const string SOCKET_LOCAL_ADDRESS
  Alias for the local_address property.
• public const string SOCKET_REMOTE_ADDRESS
  Alias for the remote_address property.
• public const string SOCKET_SSL_CREDENTIALS
  Alias for the ssl_creds property.
• public const string SOCKET_SSL_FALLBACK
  Alias for the ssl_fallback property.
• public const string SOCKET_SSL_STRICT
  Alias for the ssl_strict property.
• public const string SOCKET_TIMEOUT
  Alias for the timeout property.
• public const string SOCKET_TLS_CERTIFICATE
  Alias for the tls_certificate property.
• public const string SOCKET_TLS_ERRORS
  Alias for the tls_errors property.
• public const string SOCKET_TRUSTED_CERTIFICATE
  Alias for the trusted_certificate property.
• public const string SOCKET_USE_THREAD_CONTEXT
  Alias for the use_thread_context property.
• public const int VERSION_MIN_REQUIRED
  A macro that should be defined by the user prior to including libsoup.

Delegates:

• public delegate void AddressCallback (Address addr, uint status)
  The callback function passed to resolve_async.
• public delegate bool AuthDomainBasicAuthCallback (AuthDomainBasic domain, Message msg, string username, string password)
  Callback used by AuthDomainBasic for authentication purposes.
• public delegate string? AuthDomainDigestAuthCallback (AuthDomainDigest domain, Message msg, string username)
  Callback used by AuthDomainDigest for authentication purposes.
• public delegate bool AuthDomainFilter (AuthDomain domain, Message msg)
  The prototype for a AuthDomain filter; see set_filter for details.
• public delegate bool AuthDomainGenericAuthCallback (AuthDomain domain, Message msg, string username)
  The prototype for a AuthDomain generic authentication callback.
• public delegate Buffer? ChunkAllocator (Message msg, size_t max_len)
  The prototype for a chunk allocation callback.
• public delegate LoggerLogLevel LoggerFilter (Logger logger, Message msg)
  The prototype for a logging filter.
• public delegate void LoggerPrinter (Logger logger, LoggerLogLevel level, char direction, string data)
  The prototype for a custom printing callback.
• public delegate void MessageHeadersForeachFunc (string name, string value)
  The callback passed to @foreach.
• public delegate void PasswordManagerCallback (PasswordManager password_manager, Message msg, Auth auth, bool retrying)
• public delegate void ProxyResolverCallback (ProxyResolver proxy_resolver, Message msg, uint arg, Address addr)
• public delegate void ProxyURIResolverCallback (ProxyURIResolver resolver, uint status, URI proxy_uri)
  Callback for get_proxy_uri_async
• public delegate void ServerCallback (Server server, Message msg, string path, HashTable<string,string>? query, ClientContext client)
  A callback used to handle requests to a Server.
• public delegate void ServerWebsocketCallback (Server server, WebsocketConnection connection, string path, ClientContext client)
  A callback used to handle WebSocket requests to a Server.
• public delegate void SessionCallback (Session session, Message msg)
  Prototype for the callback passed to queue_message, qv.
• public delegate void SessionConnectProgressCallback (Session session, SocketClientEvent event, IOStream connection)
  Prototype for the progress callback passed to connect_async.
• public delegate void SocketCallback (Socket sock, uint status)
  The callback function passed to connect_async.

Functions:

• public unowned TimeoutSource add_completion (MainContext? async_context, SourceFunc function)
  Adds function to be executed from inside async_context with the default priority.
• public unowned TimeoutSource add_idle (MainContext? async_context, SourceFunc function)
  Adds an idle event as with g_idle_add, but using the given async_context.
• public unowned TimeoutSource add_io_watch (MainContext? async_context, IOChannel chan, IOCondition condition, IOFunc function)
  Adds an I/O watch as with add_watch, but using the given async_context.
• public unowned TimeoutSource add_timeout (MainContext? async_context, uint interval, SourceFunc function)
  Adds a timeout as with g_timeout_add, but using the given async_context.
• public bool check_version (uint major, uint minor, uint micro)
  Like SOUP_CHECK_VERSION, but the check for soup_check_version is at runtime instead of compile time.
• public Cookie? cookie_parse (string header, URI origin)
  Parses header and returns a Cookie.
• public SList<Cookie> cookies_from_request (Message msg)
  Parses msg's Cookie request header and returns a SList of Cookies.
• public SList<Cookie> cookies_from_response (Message msg)
  Parses msg's Set-Cookie response headers and returns a SList of Cookies.
• public string cookies_to_cookie_header (SList<Cookie> cookies)
  Serializes a SList of Cookie into a string suitable for setting as the value of the "Cookie" header.
• public void cookies_to_request (SList<Cookie> cookies, Message msg)
  Adds the name and value of each cookie in cookies to msg 's "Cookie" request.
• public void cookies_to_response (SList<Cookie> cookies, Message msg)
  Appends a "Set-Cookie" response header to msg for each cookie in cookies.
• public uint get_major_version ()
  Returns the major version number of the libsoup library.
• public uint get_micro_version ()
  Returns the micro version number of the libsoup library.
• public uint get_minor_version ()
  Returns the minor version number of the libsoup library.
• public Resource get_resource ()
• public bool header_contains (string header, string token)
  Parses header to see if it contains the token token (matched case-insensitively).
• public void header_free_param_list (HashTable<string,string> param_list)
  Frees param_list.
• public void header_g_string_append_param (StringBuilder string, string name, string value)
  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.
• public void header_g_string_append_param_quoted (StringBuilder string, string name, string value)
  Appends something like name="value" to string, taking care to escape any quotes or backslashes in value.
• public SList<string> header_parse_list (string header)
  Parses a header whose content is described by RFC2616 as "#something", where "something" does not itself contain commas, except as part of quoted-strings.
• public HashTable<string,string> header_parse_param_list (string header)
  Parses a header which is a comma-delimited list of something like: token [ "=" ( token | quoted-string ) ].
• public HashTable<string,string>? header_parse_param_list_strict (string header)
  A strict version of header_parse_param_list that bails out if there are duplicate parameters.
• public SList<string> header_parse_quality_list (string header, out SList<string> unacceptable)
  Parses a header whose content is a list of items with optional "qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding, Accept-Language, TE).
• public HashTable<string,string> header_parse_semi_param_list (string header)
  Parses a header which is a semicolon-delimited list of something like: token [ "=" ( token | quoted-string ) ].
• public HashTable<string,string>? header_parse_semi_param_list_strict (string header)
  A strict version of header_parse_semi_param_list that bails out if there are duplicate parameters.
• public bool headers_parse (string str, int len, MessageHeaders dest)
  Parses the headers of an HTTP request or response in str and stores the results in dest.
• public uint headers_parse_request (string str, int len, MessageHeaders req_headers, out string req_method, out string req_path, out HTTPVersion ver)
  Parses the headers of an HTTP request in str and stores the results in req_method, req_path, ver, and req_headers.
• public bool headers_parse_response (string str, int len, MessageHeaders headers, out HTTPVersion ver, out uint status_code, out string reason_phrase)
  Parses the headers of an HTTP response in str and stores the results in ver, status_code, reason_phrase, and headers.
• public bool headers_parse_status_line (string status_line, out HTTPVersion ver, out uint status_code, out string reason_phrase)
  Parses the HTTP Status-Line string in status_line into ver, status_code, and reason_phrase.
• public Quark http_error_quark ()
• public void message_headers_iter_init (out MessageHeadersIter iter, MessageHeaders hdrs)
• public Quark request_error_quark ()
• public Quark requester_error_quark ()
• public unowned string status_get_phrase (uint status_code)
• public uint status_proxify (uint status_code)
• public bool str_case_equal (void* v1, void* v2)
  Compares v1 and v2 in a case-insensitive manner
• public uint str_case_hash (void* key)
  Hashes key in a case-insensitive manner.
• public bool tld_domain_is_public_suffix (string domain)
  Looks whether the domain passed as argument is a public domain suffix (.
• public Quark tld_error_quark ()
• public unowned string tld_get_base_domain (string hostname) throws Error
  Finds the base domain for a given hostname.
• public string uri_decode (string part)
  Fully typeof ( unichar2)-decodes part.
• public string uri_encode (string part, string? escape_extra)
  This typeof ( unichar2)-encodes the given URI part and returns the escaped version in allocated memory, which the caller must free when it is done.
• public string uri_normalize (string part, string? unescape_extra)
  typeof ( unichar2)-decodes any "unreserved" characters (or characters in unescape_extra) in part, and typeof ( unichar2)-encodes any non-ASCII characters, spaces, and non-printing characters in part.
• public void value_array_append (ValueArray array, Type type, ...)
  Appends the provided value of type type to array as with append.
• public void value_array_append_vals (ValueArray array, ...)
  Appends the provided values into array as with append.
• public ValueArray? value_array_from_args (va_list args)
  Creates a ValueArray from the provided arguments, which must consist of pairs of a Type and a value of that type, terminated by INVALID.
• public bool value_array_get_nth (ValueArray array, uint index_, Type type, ...)
  Gets the index_ element of array and stores its value into the provided location.
• public void value_array_insert (ValueArray array, uint index_, Type type, ...)
  Inserts the provided value of type type into array as with insert.
• public ValueArray value_array_new ()
  Creates a new ValueArray.
• public ValueArray value_array_new_with_vals (...)
  Creates a new ValueArray and copies the provided values into it.
• public bool value_array_to_args (ValueArray array, va_list args)
  Extracts a ValueArray into the provided arguments, which must consist of pairs of a Type and a value of pointer-to-that-type, terminated by INVALID.
• public void value_hash_insert (HashTable<string,Value?> hash, string key, Type type, ...)
  Inserts the provided value of type type into hash.
• public void value_hash_insert_vals (HashTable<string,Value?> hash, ...)
  Inserts the given data into hash.
• public void value_hash_insert_value (HashTable<string,Value?> hash, string key, Value value)
  Inserts value into hash.
• public bool value_hash_lookup (HashTable<string,Value?> hash, string key, Type type, ...)
  Looks up key in hash and stores its value into the provided location.
• public bool value_hash_lookup_vals (HashTable<string,Value?> hash, ...)
  Looks up a number of keys in hash and returns their values.
• public HashTable<string,Value?> value_hash_new ()
  Creates a GenericSet whose keys are strings and whose values are Value.
• public HashTable<string,Value?> value_hash_new_with_vals (...)
  Creates a GenericSet whose keys are strings and whose values are Value, and initializes it with the provided data.
• public void websocket_client_prepare_handshake (Message msg, string? origin, string[]? protocols)
  Adds the necessary headers to msg to request a WebSocket handshake.
• public void websocket_client_prepare_handshake_with_extensions (Message msg, string? origin, string[]? protocols, GenericArray<TypeClass>? supported_extensions)
  Adds the necessary headers to msg to request a WebSocket handshake including supported WebSocket extensions.
• public bool websocket_client_verify_handshake (Message msg) throws Error
  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).
• public bool websocket_client_verify_handshake_with_extensions (Message msg, GenericArray<TypeClass>? supported_extensions, out List<WebsocketExtension> accepted_extensions) throws Error
  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).
• public Quark websocket_error_get_quark ()
• public bool websocket_server_check_handshake (Message msg, string? origin, string[]? protocols) throws Error
  Examines the method and request headers in msg and determines whether msg contains a valid handshake request.
• public bool websocket_server_check_handshake_with_extensions (Message msg, string? origin, string[]? protocols, GenericArray<TypeClass>? supported_extensions) throws Error
  Examines the method and request headers in msg and determines whether msg contains a valid handshake request.
• public bool websocket_server_process_handshake (Message msg, string? expected_origin, string[]? protocols)
  Examines the method and request headers in msg and (assuming msg contains a valid handshake request), fills in the handshake response.
• public bool websocket_server_process_handshake_with_extensions (Message msg, string? expected_origin, string[]? protocols, GenericArray<TypeClass>? supported_extensions, out List<WebsocketExtension> accepted_extensions)
  Examines the method and request headers in msg and (assuming msg contains a valid handshake request), fills in the handshake response.