soup/org.gtkkn.bindings.soup/ServerMessage

ServerMessage

class ServerMessage(val soupServerMessagePointer: <Error class: unknown class><<Error class: unknown class>>)(source)

An HTTP server request and response pair.

A SoupServerMessage represents an HTTP message that is being sent or received on a class@Server.

class@Server will create SoupServerMessages automatically for incoming requests, which your application will receive via handlers.

Note that libsoup's terminology here does not quite match the HTTP specification: in RFC 2616, an "HTTP-message" is either a Request, or a Response. In libsoup, a #SoupServerMessage combines both the request and the response.

Skipped during bindings generation

parameter resp_body: Array parameter of type guint8 is not supported

Constructors

ServerMessage

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

Types

Companion

object Companion

Properties

soupServerMessagePointer

val soupServerMessagePointer: <Error class: unknown class><<Error class: unknown class>>

tlsPeerCertificate

val tlsPeerCertificate: <Error class: unknown class>?

The peer's #GTlsCertificate associated with the message

tlsPeerCertificateErrors

val tlsPeerCertificateErrors: <Error class: unknown class>

The verification errors on #SoupServerMessage:tls-peer-certificate

Functions

emitConnected

fun emitConnected()

Emits the "connected" signal. See onConnected.

emitDisconnected

fun emitDisconnected()

Emits the "disconnected" signal. See onDisconnected.

emitFinished

fun emitFinished()

Emits the "finished" signal. See onFinished.

emitGotBody

fun emitGotBody()

Emits the "got-body" signal. See onGotBody.

emitGotChunk

fun emitGotChunk(chunk: <Error class: unknown class>)

Emits the "got-chunk" signal. See onGotChunk.

emitGotHeaders

fun emitGotHeaders()

Emits the "got-headers" signal. See onGotHeaders.

emitWroteBody

fun emitWroteBody()

Emits the "wrote-body" signal. See onWroteBody.

emitWroteBodyData

fun emitWroteBodyData(chunkSize: <Error class: unknown class>)

Emits the "wrote-body-data" signal. See onWroteBodyData.

emitWroteChunk

fun emitWroteChunk()

Emits the "wrote-chunk" signal. See onWroteChunk.

emitWroteHeaders

fun emitWroteHeaders()

Emits the "wrote-headers" signal. See onWroteHeaders.

emitWroteInformational

fun emitWroteInformational()

Emits the "wrote-informational" signal. See onWroteInformational.

getHttpVersion

fun getHttpVersion(): HttpVersion

Get the HTTP version of @msg.

getLocalAddress

fun getLocalAddress(): <Error class: unknown class>?

Retrieves the class@Gio.SocketAddress associated with the local end of a connection.

getMethod

fun getMethod(): String

Get the HTTP method of @msg.

getReasonPhrase

fun getReasonPhrase(): String?

Get the HTTP reason phrase of @msg.

getRemoteAddress

fun getRemoteAddress(): <Error class: unknown class>?

Retrieves the class@Gio.SocketAddress associated with the remote end of a connection.

getRemoteHost

fun getRemoteHost(): String?

Retrieves the IP address associated with the remote end of a connection.

getRequestBody

fun getRequestBody(): MessageBody

Get the request body of @msg.

getRequestHeaders

fun getRequestHeaders(): MessageHeaders

Get the request headers of @msg.

getResponseBody

fun getResponseBody(): MessageBody

Get the response body of @msg.

getResponseHeaders

fun getResponseHeaders(): MessageHeaders

Get the response headers of @msg.

getSocket

fun getSocket(): <Error class: unknown class>?

Retrieves the class@Gio.Socket that @msg is associated with.

getStatus

fun getStatus(): <Error class: unknown class>

Get the HTTP status code of @msg.

getUri

fun getUri(): <Error class: unknown class>

Get @msg's URI.

isOptionsPing

fun isOptionsPing(): Boolean

Gets if @msg represents an OPTIONS message with the path *.

onAcceptCertificate

fun onAcceptCertificate( 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 client TLS certificate has been received. You can return true to accept @tls_certificate despite

onConnected

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

Emitted when the @msg's socket is connected and the TLS handshake completed.

onDisconnected

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

Emitted when the @msg's socket is disconnected.

onFinished

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

Emitted when all HTTP processing is finished for a message. (After signal@ServerMessage::wrote-body).

onGotBody

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

Emitted after receiving the complete request body.

onGotChunk

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

Emitted after receiving a chunk of a message body.

onGotHeaders

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

Emitted after receiving the Request-Line and request headers.

onWroteBody

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

Emitted immediately after writing the complete response body for a message.

onWroteBodyData

fun onWroteBodyData( 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.

onWroteChunk

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

Emitted immediately after writing a body chunk for a message.

onWroteHeaders

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

Emitted immediately after writing the response headers for a message.

onWroteInformational

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

Emitted immediately after writing a 1xx (Informational) response.

pause

fun pause()

Pauses I/O on @msg.

setHttpVersion

fun setHttpVersion(version: HttpVersion)

Set the HTTP version of @msg.

setRedirect

fun setRedirect(statusCode: <Error class: unknown class>, redirectUri: String)

Sets @msg's status_code to @status_code and adds a Location header pointing to @redirect_uri. Use this from a class@Server when you want to redirect the client to another URI.

setStatus

fun setStatus(statusCode: <Error class: unknown class>, reasonPhrase: String? = null)

Sets @msg's status code to @status_code.

stealConnection

fun stealConnection(): <Error class: unknown class>

"Steals" the HTTP connection associated with @msg from its #SoupServer. This happens immediately, regardless of the current state of the connection; if the response to @msg has not yet finished being sent, then it will be discarded; you can steal the connection from a signal@ServerMessage::wrote-informational or signal@ServerMessage::wrote-body signal handler if you need to wait for part or all of the response to be sent.

unpause

fun unpause()

Resumes I/O on @msg.