ServerMessage

Object Hierarchy:

Description:

[ CCode ( type_id = "soup_server_message_get_type ()" ) ]
public sealed class ServerMessage : Object

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 `SoupServerMessage`s 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 ServerMessage combines both the request and the response.

Namespace: Soup

Package: libsoup-3.0

Content:

Properties:

public TlsCertificate tls_peer_certificate { get; }
The peer's TlsCertificate associated with the message
public TlsCertificateFlags tls_peer_certificate_errors { get; }
The verification errors on tls_peer_certificate

Creation methods:

protected ServerMessage ()

Methods:

public HTTPVersion get_http_version ()
Get the HTTP version of this.
public unowned SocketAddress? get_local_address ()
Retrieves the [class@Gio.
public unowned string get_method ()
Get the HTTP method of this.
public unowned string? get_reason_phrase ()
Get the HTTP reason phrase of this.
public unowned SocketAddress? get_remote_address ()
Retrieves the [class@Gio.
public unowned string? get_remote_host ()
Retrieves the IP address associated with the remote end of a connection.
public unowned MessageBody get_request_body ()
Get the request body of this.
public unowned MessageHeaders get_request_headers ()
Get the request headers of this.
public unowned MessageBody get_response_body ()
Get the response body of this.
public unowned MessageHeaders get_response_headers ()
Get the response headers of this.
public unowned Socket? get_socket ()
Retrieves the [class@Gio.
public uint get_status ()
Get the HTTP status code of this.
public unowned TlsCertificate? get_tls_peer_certificate ()
Gets the peer's TlsCertificate associated with this's connection.
public TlsCertificateFlags get_tls_peer_certificate_errors ()
Gets the errors associated with validating this 's TLS peer certificate.
public unowned Uri get_uri ()
Get this's URI.
public bool is_options_ping ()
Gets if this represents an OPTIONS message with the path `*`.
public void pause ()
Pauses I/O on this.
public void set_http_version (HTTPVersion version)
Set the HTTP version of this.
public void set_redirect (uint status_code, string redirect_uri)
Sets this's status_code to status_code and adds a Location header pointing to redirect_uri.
public void set_response (string? content_type, MemoryUse resp_use, uint8[]? resp_body)
Convenience function to set the response body of a ServerMessage.
public void set_status (uint status_code, string? reason_phrase)
Sets this's status code to status_code.
public IOStream steal_connection ()
"Steals" the HTTP connection associated with this from its Server.
public void unpause ()
Resumes I/O on this.

Signals:

public signal bool accept_certificate (TlsCertificate tls_peer_certificate, TlsCertificateFlags tls_peer_errors)
Emitted during the msg's connection TLS handshake after client TLS certificate has been received.
public signal void connected ()
Emitted when the msg's socket is connected and the TLS handshake completed.
public signal void disconnected ()
Emitted when the msg's socket is disconnected.
public signal void finished ()
Emitted when all HTTP processing is finished for a message.
public signal void got_body ()
Emitted after receiving the complete request body.
public signal void got_chunk (Bytes chunk)
Emitted after receiving a chunk of a message body.
public signal void got_headers ()
Emitted after receiving the Request-Line and request headers.
public signal void wrote_body ()
Emitted immediately after writing the complete response body for a message.
public signal void wrote_body_data (uint chunk_size)
Emitted immediately after writing a portion of the message body to the network.
public signal void wrote_chunk ()
Emitted immediately after writing a body chunk for a message.
public signal void wrote_headers ()
Emitted immediately after writing the response headers for a message.
public signal void wrote_informational ()
Emitted immediately after writing a 1xx (Informational) response.

Inherited Members:

All known members inherited from class GLib.Object