soup/org.gtkkn.bindings.soup

Package-level declarations

Types

Auth

open class Auth(pointer: <Error class: unknown class><<Error class: unknown class>>)

The abstract base class for handling authentication.

AuthDomain

open class AuthDomain(pointer: <Error class: unknown class><<Error class: unknown class>>)

Server-side authentication.

AuthDomainBasic

class AuthDomainBasic(pointer: <Error class: unknown class><<Error class: unknown class>>) : AuthDomain

Server-side "Basic" authentication.

AuthDomainBasicAuthCallback

typealias AuthDomainBasicAuthCallback = (domain: AuthDomainBasic, msg: ServerMessage, username: String, password: String) -> Boolean

Callback used by #SoupAuthDomainBasic for authentication purposes.

AuthDomainDigest

class AuthDomainDigest(pointer: <Error class: unknown class><<Error class: unknown class>>) : AuthDomain

Server-side "Digest" authentication.

AuthDomainDigestAuthCallback

typealias AuthDomainDigestAuthCallback = (domain: AuthDomainDigest, msg: ServerMessage, username: String) -> String?

Callback used by #SoupAuthDomainDigest for authentication purposes.

AuthDomainFilter

typealias AuthDomainFilter = (domain: AuthDomain, msg: ServerMessage) -> Boolean

The prototype for a #SoupAuthDomain filter.

AuthDomainGenericAuthCallback

typealias AuthDomainGenericAuthCallback = (domain: AuthDomain, msg: ServerMessage, username: String) -> Boolean

The prototype for a #SoupAuthDomain generic authentication callback.

AuthManager

class AuthManager(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

HTTP client-side authentication handler.

Cache

open class Cache(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

File-based cache for HTTP resources.

Cacheability

class Cacheability(val mask: <Error class: unknown class>)

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

CacheType

enum CacheType : Enum<CacheType>

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

ContentDecoder

class ContentDecoder(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

Handles decoding of HTTP messages.

ContentSniffer

class ContentSniffer(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

Sniffs the mime type of messages.

class Cookie(pointer: <Error class: unknown class><<Error class: unknown class>>)

Implements HTTP cookies, as described by RFC 6265.

CookieJar

open class CookieJar(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

Automatic cookie handling for SoupSession.

CookieJarAcceptPolicy

enum CookieJarAcceptPolicy : Enum<CookieJarAcceptPolicy>

The policy for accepting or rejecting cookies returned in responses.

CookieJarDb

class CookieJarDb(pointer: <Error class: unknown class><<Error class: unknown class>>) : CookieJar

Database-based Cookie Jar.

CookieJarText

class CookieJarText(pointer: <Error class: unknown class><<Error class: unknown class>>) : CookieJar

Text-file-based ("cookies.txt") Cookie Jar

DateFormat

enum DateFormat : Enum<DateFormat>

Date formats that func@date_time_to_string can use.

Encoding

enum Encoding : Enum<Encoding>

How a message body is encoded for transport

Expectation

class Expectation(val mask: <Error class: unknown class>)

Represents the parsed value of the "Expect" header.

HstsEnforcer

open class HstsEnforcer(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

Automatic HTTP Strict Transport Security enforcing for class@Session.

HstsEnforcerDb

class HstsEnforcerDb(pointer: <Error class: unknown class><<Error class: unknown class>>) : HstsEnforcer

Persistent HTTP Strict Transport Security enforcer.

HstsPolicy

class HstsPolicy(pointer: <Error class: unknown class><<Error class: unknown class>>)

#SoupHSTSPolicy implements HTTP policies, as described by RFC 6797.

HttpVersion

enum HttpVersion : Enum<HttpVersion>

Indicates the HTTP protocol version being used.

Logger

class Logger(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

Debug logging support

LoggerFilter

typealias LoggerFilter = (logger: Logger, msg: Message) -> LoggerLogLevel

The prototype for a logging filter.

LoggerLogLevel

enum LoggerLogLevel : Enum<LoggerLogLevel>

Describes the level of logging output to provide.

LoggerPrinter

typealias LoggerPrinter = (logger: Logger, level: LoggerLogLevel, direction: Char, data: String) -> Unit

The prototype for a custom printing callback.

MemoryUse

enum MemoryUse : Enum<MemoryUse>

The lifetime of the memory being passed.

Message

class Message(pointer: <Error class: unknown class><<Error class: unknown class>>)

Represents an HTTP message being sent or received.

MessageBody

class MessageBody(pointer: <Error class: unknown class><<Error class: unknown class>>)

#SoupMessageBody represents the request or response body of a class@Message.

MessageFlags

class MessageFlags(val mask: <Error class: unknown class>)

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

MessageHeaders

class MessageHeaders(pointer: <Error class: unknown class><<Error class: unknown class>>)

The HTTP message headers associated with a request or response.

MessageHeadersForeachFunc

typealias MessageHeadersForeachFunc = (name: String, value: String) -> Unit

The callback passed to method@MessageHeaders.foreach.

MessageHeadersIter

class MessageHeadersIter(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

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

MessageHeadersType

enum MessageHeadersType : Enum<MessageHeadersType>

Value passed to ctor@MessageHeaders.new to set certain default behaviors.

MessageMetrics

class MessageMetrics(pointer: <Error class: unknown class><<Error class: unknown class>>)

Contains metrics collected while loading a class@Message either from the network or the disk cache.

MessagePriority

enum MessagePriority : Enum<MessagePriority>

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

Multipart

class Multipart(pointer: <Error class: unknown class><<Error class: unknown class>>)

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

MultipartInputStream

class MultipartInputStream(pointer: <Error class: unknown class><<Error class: unknown class>>)

Handles streams of multipart messages.

Range

class Range(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

Represents a byte range as used in the Range header.

SameSitePolicy

enum SameSitePolicy : Enum<SameSitePolicy>

Represents the same-site policies of a cookie.

Server

open class Server(pointer: <Error class: unknown class><<Error class: unknown class>>)

A HTTP server.

ServerCallback

typealias ServerCallback = (server: Server, msg: ServerMessage, path: String, <Error class: unknown class>?) -> Unit

A callback used to handle requests to a class@Server.

ServerListenOptions

class ServerListenOptions(val mask: <Error class: unknown class>)

Options to pass to method@Server.listen, etc.

ServerMessage

class ServerMessage(pointer: <Error class: unknown class><<Error class: unknown class>>)

An HTTP server request and response pair.

ServerWebsocketCallback

typealias ServerWebsocketCallback = (server: Server, msg: ServerMessage, path: String, connection: WebsocketConnection) -> Unit

A callback used to handle WebSocket requests to a #SoupServer.

Session

open class Session(pointer: <Error class: unknown class><<Error class: unknown class>>)

Soup session state object.

SessionError

enum SessionError : Enum<SessionError>

A #SoupSession error.

SessionErrorException

class SessionErrorException(error: <Error class: unknown class>, val code: SessionError)

SessionFeature

interface SessionFeature

Interface for miscellaneous class@Session features.

Soup

object Soup

SoupTypeProvider

object SoupTypeProvider

Status

enum Status : Enum<Status>

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

TldError

enum TldError : Enum<TldError>

Error codes for %SOUP_TLD_ERROR.

TldErrorException

class TldErrorException(error: <Error class: unknown class>, val code: TldError)

UriComponent

enum UriComponent : Enum<UriComponent>

Enum values passed to func@uri_copy to indicate the components of the URI that should be updated with the given values.

WebsocketCloseCode

enum WebsocketCloseCode : Enum<WebsocketCloseCode>

Pre-defined close codes that can be passed to method@WebsocketConnection.close or received from method@WebsocketConnection.get_close_code.

WebsocketConnection

class WebsocketConnection(pointer: <Error class: unknown class><<Error class: unknown class>>)

The WebSocket Protocol

WebsocketConnectionType

enum WebsocketConnectionType : Enum<WebsocketConnectionType>

The type of a class@WebsocketConnection.

WebsocketDataType

enum WebsocketDataType : Enum<WebsocketDataType>

The type of data contained in a signal@WebsocketConnection::message signal.

WebsocketError

enum WebsocketError : Enum<WebsocketError>

WebSocket-related errors.

WebsocketErrorException

class WebsocketErrorException(error: <Error class: unknown class>, val code: WebsocketError)

WebsocketExtension

open class WebsocketExtension(pointer: <Error class: unknown class><<Error class: unknown class>>)

A WebSocket extension

WebsocketExtensionDeflate

class WebsocketExtensionDeflate(pointer: <Error class: unknown class><<Error class: unknown class>>) : WebsocketExtension

A SoupWebsocketExtensionDeflate is a class@WebsocketExtension implementing permessage-deflate (RFC 7692).

WebsocketExtensionManager

class WebsocketExtensionManager(pointer: <Error class: unknown class><<Error class: unknown class>>) : SessionFeature

SoupWebsocketExtensionManager is the iface@SessionFeature that handles WebSockets extensions for a class@Session.

WebsocketState

enum WebsocketState : Enum<WebsocketState>

The state of the WebSocket connection.

Properties

AuthDomainBasicAuthCallbackFunc

val AuthDomainBasicAuthCallbackFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> <Error class: unknown class>>>

AuthDomainDigestAuthCallbackFunc

val AuthDomainDigestAuthCallbackFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> <Error class: unknown class><<Error class: unknown class>>?>>

AuthDomainFilterFunc

val AuthDomainFilterFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> <Error class: unknown class>>>

AuthDomainGenericAuthCallbackFunc

val AuthDomainGenericAuthCallbackFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> <Error class: unknown class>>>

LoggerFilterFunc

val LoggerFilterFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> <Error class: unknown class>>>

LoggerPrinterFunc

val LoggerPrinterFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class><<Error class: unknown class>>) -> Unit>>

MessageHeadersForeachFuncFunc

val MessageHeadersForeachFuncFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> Unit>>

ServerCallbackFunc

val ServerCallbackFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>?) -> Unit>>

ServerWebsocketCallbackFunc

val ServerWebsocketCallbackFunc: <Error class: unknown class><<Error class: unknown class><(<Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>, <Error class: unknown class><<Error class: unknown class>>) -> Unit>>