soup/org.gtkkn.bindings.soup/Message

Message

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

Represents an HTTP message being sent or received.

A #SoupMessage represents an HTTP message that is being sent or received.

You would create a #SoupMessage with ctor@Message.new or ctor@Message.new_from_uri, set up its fields appropriately, and send it.

property@Message:status-code will normally be a enum@Status value, eg, %SOUP_STATUS_OK, though of course it might actually be an unknown status code. property@Message:reason-phrase is the actual text returned from the server, which may or may not correspond to the "standard" description of

Constructors

Message

constructor(method: String, uriString: String)

Creates a new empty #SoupMessage, which will connect to @uri.

constructor(method: String, uriString: String, encodedForm: String)

Creates a new #SoupMessage and sets it up to send the given @encoded_form to @uri via @method. If @method is "GET", it will include the form data into @uri's query field, and if @method is "POST" or "PUT", it will be set as request body.

constructor(uriString: String, multipart: Multipart)

Creates a new #SoupMessage and sets it up to send @multipart to

constructor(method: String, uri: <Error class: unknown class>)

Creates a new empty #SoupMessage, which will connect to @uri.

constructor(baseUri: <Error class: unknown class>)

Creates a new #SoupMessage to send OPTIONS * to a server. The path of

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

Types

Companion

object Companion

Properties

firstParty

var firstParty: <Error class: unknown class>

The struct@GLib.Uri loaded in the application when the message was queued.

flags

var flags: MessageFlags

Various message options.

httpVersion

val httpVersion: HttpVersion

The HTTP protocol version to use.

isOptionsPing

var isOptionsPing: Boolean

Whether the message is an OPTIONS ping.

isTopLevelNavigation

var isTopLevelNavigation: Boolean

Set when the message is navigating between top level domains.

method

var method: String

The message's HTTP method.

priority

var priority: MessagePriority

Sets the priority of the #SoupMessage. See method@Message.set_priority for further details.

reasonPhrase

val reasonPhrase: String?

The HTTP response reason phrase.

remoteAddress

val remoteAddress: <Error class: unknown class>?

The remote class@Gio.SocketAddress of the connection associated with the message.

requestHeaders

val requestHeaders: MessageHeaders

The HTTP request headers.

responseHeaders

val responseHeaders: MessageHeaders

The HTTP response headers.

soupMessagePointer

val soupMessagePointer: <Error class: unknown class><<Error class: unknown class>>

tlsCiphersuiteName

val tlsCiphersuiteName: String

The Name of TLS ciphersuite negotiated for this message connection.

tlsPeerCertificate

val tlsPeerCertificate: <Error class: unknown class>?

The peer's class@Gio.TlsCertificate associated with the message.

tlsPeerCertificateErrors

val tlsPeerCertificateErrors: <Error class: unknown class>

The verification errors on property@Message:tls-peer-certificate.

tlsProtocolVersion

val tlsProtocolVersion: <Error class: unknown class>

The TLS protocol version negotiated for the message connection.

uri

var uri: <Error class: unknown class>

The message's Request-URI.

Functions

addFlags

fun addFlags(flags: MessageFlags)

Adds @flags to the set of @msg's flags.

addHeaderHandler

fun addHeaderHandler(signal: String, header: String, callback: <Error class: unknown class>): <Error class: unknown class>

Adds a signal handler to @msg for @signal.

addStatusCodeHandler

fun addStatusCodeHandler(signal: String, statusCode: <Error class: unknown class>, callback: <Error class: unknown class>): <Error class: unknown class>

Adds a signal handler to @msg for @signal.

connectAcceptCertificate

fun connectAcceptCertificate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted during the @msg's connection TLS handshake after an unacceptable TLS certificate has been received.

connectAuthenticate

fun connectAuthenticate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (auth: Auth, retrying: Boolean) -> Boolean): <Error class: unknown class>

Emitted when the message requires authentication.

connectContentSniffed

fun connectContentSniffed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (type: String, <Error class: unknown class>) -> Unit): <Error class: unknown class>

This signal is emitted after signal@Message::got-headers.

connectFinished

fun connectFinished(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when all HTTP processing is finished for a message.

connectGotBody

fun connectGotBody(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted after receiving the complete message response body.

connectGotBodyData

fun connectGotBodyData(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted after reading a portion of the message body from the network.

connectGotHeaders

fun connectGotHeaders(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted after receiving the Status-Line and response headers.

connectGotInformational

fun connectGotInformational(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted after receiving a 1xx (Informational) response for a (client-side) message.

connectHstsEnforced

fun connectHstsEnforced(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when class@HSTSEnforcer has upgraded the protocol for @msg to HTTPS as a result of matching its domain with a HSTS policy.

connectNetworkEvent

fun connectNetworkEvent(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted to indicate that some network-related event related to @msg has occurred.

connectRequestCertificate

fun connectRequestCertificate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted during the @msg's connection TLS handshake when

connectRequestCertificatePassword

fun connectRequestCertificatePassword(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted during the @msg's connection TLS handshake when

connectRestarted

fun connectRestarted(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when a request that was already sent once is now being sent again.

connectStarting

fun connectStarting(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted just before a message is sent.

connectWroteBody

fun connectWroteBody(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted immediately after writing the complete body for a message.

connectWroteBodyData

fun connectWroteBodyData(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted immediately after writing a portion of the message body to the network.

connectWroteHeaders