GI.Soup.Constants

Documentation

pattern VERSION_MIN_REQUIRED :: Int32

A macro that should be defined by the user prior to including libsoup.h. The definition should be one of the predefined libsoup version macros: SOUP_VERSION_2_24, SOUP_VERSION_2_26, ...

This macro defines the earliest version of libsoup that the package is required to be able to compile against.

If the compiler is configured to warn about the use of deprecated functions, then using functions that were deprecated in version VERSION_MIN_REQUIRED or earlier will cause warnings (but using functions deprecated in later releases will not).

Since: 2.42

pattern SOCKET_USE_THREAD_CONTEXT :: Text

Alias for the Socket:use-thread-context property. (Use mainContextGetThreadDefault)

Since: 2.38

pattern SOCKET_TRUSTED_CERTIFICATE :: Text

Alias for the Socket:trusted-certificate property.

pattern SOCKET_TLS_ERRORS :: Text

Alias for the Socket:tls-errors property. Note that this property's value is only useful if the socket is for a TLS connection, and only reliable after some data has been transferred to or from it.

Since: 2.34

pattern SOCKET_TLS_CERTIFICATE :: Text

Alias for the Socket:tls-certificate property. Note that this property's value is only useful if the socket is for a TLS connection, and only reliable after some data has been transferred to or from it.

Since: 2.34

pattern SOCKET_TIMEOUT :: Text

Alias for the Socket:timeout property. (The timeout in seconds for blocking socket I/O operations.)

pattern SOCKET_SSL_STRICT :: Text

Alias for the Socket:ssl-strict property.

pattern SOCKET_SSL_FALLBACK :: Text

Alias for the Socket:ssl-fallback property.

pattern SOCKET_SSL_CREDENTIALS :: Text

Alias for the Socket:ssl-creds property. (SSL credential information.)

pattern SOCKET_REMOTE_ADDRESS :: Text

Alias for the Socket:remote-address property. (Address of remote end of socket.)

pattern SOCKET_LOCAL_ADDRESS :: Text

Alias for the Socket:local-address property. (Address of local end of socket.)

pattern SOCKET_IS_SERVER :: Text

Alias for the Socket:is-server property, qv.

pattern SOCKET_FLAG_NONBLOCKING :: Text

Alias for the Socket:non-blocking property. (Whether or not the socket uses non-blocking I/O.)

pattern SOCKET_ASYNC_CONTEXT :: Text

Alias for the Socket:async-context property. (The socket's MainContext.)

pattern SESSION_USE_THREAD_CONTEXT :: Text

Alias for the Session:use-thread-context property, qv.

Since: 2.38

pattern SESSION_USE_NTLM :: Text

Alias for the Session:use-ntlm property, qv.

pattern SESSION_USER_AGENT :: Text

Alias for the Session:user-agent property, qv.

pattern SESSION_TLS_INTERACTION :: Text

Alias for the Session:tls-interaction property, qv.

Since: 2.48

pattern SESSION_TLS_DATABASE :: Text

Alias for the Session:tls-database property, qv.

Since: 2.38

pattern SESSION_TIMEOUT :: Text

Alias for the Session:timeout property, qv.

pattern SESSION_SSL_USE_SYSTEM_CA_FILE :: Text

Alias for the Session:ssl-use-system-ca-file property, qv.

Since: 2.38

pattern SESSION_SSL_STRICT :: Text

Alias for the Session:ssl-strict property, qv.

Since: 2.30

pattern SESSION_SSL_CA_FILE :: Text

Alias for the Session:ssl-ca-file property, qv.

pattern SESSION_PROXY_URI :: Text

Alias for the Session:proxy-uri property, qv.

pattern SESSION_PROXY_RESOLVER :: Text

Alias for the Session:proxy-resolver property, qv.

pattern SESSION_MAX_CONNS_PER_HOST :: Text

Alias for the Session:max-conns-per-host property, qv.

pattern SESSION_MAX_CONNS :: Text

Alias for the Session:max-conns property, qv.

pattern SESSION_LOCAL_ADDRESS :: Text

Alias for the Session:local-address property, qv.

Since: 2.42

pattern SESSION_IDLE_TIMEOUT :: Text

Alias for the Session:idle-timeout property, qv.

Since: 2.24

pattern SESSION_HTTP_ALIASES :: Text

Alias for the Session:http-aliases property, qv.

Since: 2.38

pattern SESSION_HTTPS_ALIASES :: Text

Alias for the Session:https-aliases property, qv.

Since: 2.38

pattern SESSION_ASYNC_CONTEXT :: Text

Alias for the Session:async-context property, qv.

pattern SESSION_ACCEPT_LANGUAGE_AUTO :: Text

Alias for the Session:accept-language-auto property, qv.

Since: 2.30

pattern SESSION_ACCEPT_LANGUAGE :: Text

Alias for the Session:accept-language property, qv.

Since: 2.30

pattern SERVER_TLS_CERTIFICATE :: Text

Alias for the Server:tls-certificate property, qv.

Since: 2.38

pattern SERVER_SSL_KEY_FILE :: Text

Deprecated: use Server:tls-certificate orsoup_server_set_ssl_certificate().

Alias for the Server:ssl-key-file property, qv.

pattern SERVER_SSL_CERT_FILE :: Text

Deprecated: use Server:tls-certificate orsoup_server_set_ssl_certificate().

Alias for the Server:ssl-cert-file property, qv.

pattern SERVER_SERVER_HEADER :: Text

Alias for the Server:server-header property, qv.

pattern SERVER_RAW_PATHS :: Text

Alias for the Server:raw-paths property. (If True, percent-encoding in the Request-URI path will not be automatically decoded.)

pattern SERVER_PORT :: Text

Deprecated: SoupServers can listen on multiple interfacesat once now. Use serverListen, etc, to listen on aport, and serverGetUris to see what ports arebeing listened on.

Alias for the deprecated Server:port property, qv.

pattern SERVER_INTERFACE :: Text

Deprecated: SoupServers can listen on multiple interfacesat once now. Use serverListen, etc, to listen on aninterface, and serverGetUris to see what addressesare being listened on.

Alias for the Server:interface property, qv.

pattern SERVER_HTTP_ALIASES :: Text

Alias for the Server:http-aliases property, qv.

Since: 2.44

pattern SERVER_HTTPS_ALIASES :: Text

Alias for the Server:https-aliases property, qv.

Since: 2.44

pattern SERVER_ASYNC_CONTEXT :: Text

Deprecated: The new API uses the thread-default MainContextrather than having an explicitly-specified one.

Alias for the deprecated Server:async-context property, qv.

pattern REQUEST_URI :: Text

Alias for the Request:uri property, qv.

Since: 2.42

pattern REQUEST_SESSION :: Text

Alias for the Request:session property, qv.

Since: 2.42

pattern MINOR_VERSION :: Int32

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

Since: 2.42

pattern MICRO_VERSION :: Int32

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

Since: 2.42

pattern MESSAGE_URI :: Text

Alias for the Message:uri property. (The message's URI.)

pattern MESSAGE_TLS_ERRORS :: Text

Alias for the Message:tls-errors property. (The verification errors on Message:tls-certificate.)

Since: 2.34

pattern MESSAGE_TLS_CERTIFICATE :: Text

Alias for the Message:tls-certificate property. (The TLS certificate associated with the message, if any.)

Since: 2.34

pattern MESSAGE_STATUS_CODE :: Text

Alias for the Message:status-code property. (The message's HTTP response status code.)

pattern MESSAGE_SERVER_SIDE :: Text

Alias for the Message:server-side property. (True if the message was created by Server.)

pattern MESSAGE_RESPONSE_HEADERS :: Text

Alias for the Message:response-headers property. (The message's HTTP response headers.)

pattern MESSAGE_RESPONSE_BODY_DATA :: Text

Alias for the Message:response-body-data property. (The message's HTTP response body, as a Bytes.)

Since: 2.46

pattern MESSAGE_RESPONSE_BODY :: Text

Alias for the Message:response-body property. (The message's HTTP response body.)

pattern MESSAGE_REQUEST_HEADERS :: Text

Alias for the Message:request-headers property. (The message's HTTP request headers.)

pattern MESSAGE_REQUEST_BODY_DATA :: Text

Alias for the Message:request-body-data property. (The message's HTTP request body, as a Bytes.)

Since: 2.46

pattern MESSAGE_REQUEST_BODY :: Text

Alias for the Message:request-body property. (The message's HTTP request body.)

pattern MESSAGE_REASON_PHRASE :: Text

Alias for the Message:reason-phrase property. (The message's HTTP response reason phrase.)

pattern MESSAGE_PRIORITY :: Text

Sets the priority of the Message. See messageSetPriority for further details.

Since: 2.44

pattern MESSAGE_METHOD :: Text

Alias for the Message:method property. (The message's HTTP method.)

pattern MESSAGE_HTTP_VERSION :: Text

Alias for the Message:http-version property. (The message's HTTPVersion.)

pattern MESSAGE_FLAGS :: Text

Alias for the Message:flags property. (The message's MessageFlags.)

pattern MESSAGE_FIRST_PARTY :: Text

Alias for the Message:first-party property. (The URI loaded in the application when the message was queued.)

Since: 2.30

pattern MAJOR_VERSION :: Int32

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

Since: 2.42

pattern LOGGER_MAX_BODY_SIZE :: Text

Alias for the Logger:max-body-size property, qv.

Since: 2.56

pattern LOGGER_LEVEL :: Text

Alias for the Logger:level property, qv.

Since: 2.56

pattern FORM_MIME_TYPE_URLENCODED :: Text

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

Since: 2.26

pattern FORM_MIME_TYPE_MULTIPART :: Text

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

Since: 2.26

pattern COOKIE_MAX_AGE_ONE_YEAR :: Int32

A constant corresponding to 1 year, for use with cookieNew and cookieSetMaxAge.

Since: 2.24

pattern COOKIE_MAX_AGE_ONE_WEEK :: Int32

A constant corresponding to 1 week, for use with cookieNew and cookieSetMaxAge.

Since: 2.24

pattern COOKIE_MAX_AGE_ONE_HOUR :: Int32

A constant corresponding to 1 hour, for use with cookieNew and cookieSetMaxAge.

Since: 2.24

pattern COOKIE_MAX_AGE_ONE_DAY :: Int32

A constant corresponding to 1 day, for use with cookieNew and cookieSetMaxAge.

Since: 2.24

pattern COOKIE_JAR_TEXT_FILENAME :: Text

Alias for the CookieJarText:filename property. (The cookie-storage filename.)

pattern COOKIE_JAR_READ_ONLY :: Text

Alias for the CookieJar:read-only property. (Whether or not the cookie jar is read-only.)

pattern COOKIE_JAR_DB_FILENAME :: Text

Alias for the CookieJarDB:filename property. (The cookie-storage filename.)

pattern COOKIE_JAR_ACCEPT_POLICY :: Text

Alias for the CookieJar:accept-policy property.

Since: 2.30

pattern CHAR_URI_SUB_DELIMS :: Int32

No description available in the introspection data.

pattern CHAR_URI_PERCENT_ENCODED :: Int32

No description available in the introspection data.

pattern CHAR_URI_GEN_DELIMS :: Int32

No description available in the introspection data.

pattern CHAR_HTTP_SEPARATOR :: Int32

No description available in the introspection data.

pattern CHAR_HTTP_CTL :: Int32

No description available in the introspection data.

pattern AUTH_SCHEME_NAME :: Text

An alias for the Auth:scheme-name property. (The authentication scheme name.)

pattern AUTH_REALM :: Text

An alias for the Auth:realm property. (The authentication realm.)

pattern AUTH_IS_FOR_PROXY :: Text

An alias for the Auth:is-for-proxy property. (Whether or not the auth is for a proxy server.)

pattern AUTH_IS_AUTHENTICATED :: Text

An alias for the Auth:is-authenticated property. (Whether or not the auth has been authenticated.)

pattern AUTH_HOST :: Text

An alias for the Auth:host property. (The host being authenticated to.)

pattern AUTH_DOMAIN_REMOVE_PATH :: Text

Alias for the AuthDomain:remove-path property. (Shortcut for calling authDomainRemovePath.)

pattern AUTH_DOMAIN_REALM :: Text

Alias for the AuthDomain:realm property. (The realm of this auth domain.)

pattern AUTH_DOMAIN_PROXY :: Text

Alias for the AuthDomain:proxy property. (Whether or not this is a proxy auth domain.)

pattern AUTH_DOMAIN_GENERIC_AUTH_DATA :: Text

Alias for the AuthDomain:generic-auth-data property. (The data to pass to the AuthDomainGenericAuthCallback.)

pattern AUTH_DOMAIN_GENERIC_AUTH_CALLBACK :: Text

Alias for the AuthDomain:generic-auth-callback property. (The AuthDomainGenericAuthCallback.)

pattern AUTH_DOMAIN_FILTER_DATA :: Text

Alias for the AuthDomain:filter-data property. (Data to pass to the AuthDomainFilter.)

pattern AUTH_DOMAIN_FILTER :: Text

Alias for the AuthDomain:filter property. (The AuthDomainFilter for the domain.)

pattern AUTH_DOMAIN_DIGEST_AUTH_DATA :: Text

Alias for the AuthDomainDigest:auth-callback property. (The AuthDomainDigestAuthCallback.)

pattern AUTH_DOMAIN_DIGEST_AUTH_CALLBACK :: Text

Alias for the AuthDomainDigest:auth-callback property. (The AuthDomainDigestAuthCallback.)

pattern AUTH_DOMAIN_BASIC_AUTH_DATA :: Text

Alias for the AuthDomainBasic:auth-data property. (The data to pass to the AuthDomainBasicAuthCallback.)

pattern AUTH_DOMAIN_BASIC_AUTH_CALLBACK :: Text

Alias for the AuthDomainBasic:auth-callback property. (The AuthDomainBasicAuthCallback.)

pattern AUTH_DOMAIN_ADD_PATH :: Text

Alias for the AuthDomain:add-path property. (Shortcut for calling authDomainAddPath.)

pattern ADDRESS_SOCKADDR :: Text

An alias for the Address:sockaddr property. (A pointer to the struct sockaddr for this address.)

pattern ADDRESS_PROTOCOL :: Text

Alias for the Address:protocol property. (The URI scheme used with this address.)

pattern ADDRESS_PORT :: Text

An alias for the Address:port property. (The port for this address.)

pattern ADDRESS_PHYSICAL :: Text

An alias for the Address:physical property. (The stringified IP address for this address.)

pattern ADDRESS_NAME :: Text

Alias for the Address:name property. (The hostname for this address.)

pattern ADDRESS_FAMILY :: Text

Alias for the Address:family property. (The AddressFamily for this address.)

pattern ADDRESS_ANY_PORT :: Int32

This can be passed to any Address method that expects a port, to indicate that you don't care what port is used.