Struct soup::ServerMessage

pub struct ServerMessage { /* private fields */ }

An HTTP server request and response pair.

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

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.

Properties

tls-peer-certificate

The peer’s #GTlsCertificate associated with the message

Readable

tls-peer-certificate-errors

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

Readable

Signals

accept-certificate

Emitted during the @msg’s connection TLS handshake after client TLS certificate has been received. You can return true to accept @tls_certificate despite @tls_errors.

connected

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

disconnected

Emitted when the @msg’s socket is disconnected.

finished

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

got-body

Emitted after receiving the complete request body.

got-chunk

Emitted after receiving a chunk of a message body.

Note that “chunk” in this context means any subpiece of the body, not necessarily the specific HTTP 1.1 chunks sent by the other side.

got-headers

Emitted after receiving the Request-Line and request headers.

wrote-body

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

wrote-body-data

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

wrote-chunk

Emitted immediately after writing a body chunk for a message.

Note that this signal is not parallel to got-chunk; it is emitted only when a complete chunk (added with MessageBody::append() or MessageBody::append_bytes() has been written. To get more useful continuous progress information, use wrote-body-data.

wrote-headers

Emitted immediately after writing the response headers for a message.

wrote-informational

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

Implements

[trait@glib::ObjectExt]

Implementations

impl ServerMessage

pub fn http_version(&self) -> HTTPVersion

Get the HTTP version of @self.

Returns

a #SoupHTTPVersion.

pub fn local_address(&self) -> Option<SocketAddress>

Retrieves the gio::SocketAddress associated with the local end of a connection.

Returns

the #GSocketAddress associated with the local end of a connection, it may be None if you used ServerExt::accept_iostream().

pub fn method(&self) -> Option<GString>

Get the HTTP method of @self.

Returns

the HTTP method.

pub fn reason_phrase(&self) -> Option<GString>

Get the HTTP reason phrase of @self.

Returns

the reason phrase.

pub fn remote_address(&self) -> Option<SocketAddress>

Retrieves the gio::SocketAddress associated with the remote end of a connection.

Returns

the #GSocketAddress associated with the remote end of a connection, it may be None if you used Server::accept_iostream.

pub fn remote_host(&self) -> Option<GString>

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

Returns

the IP address associated with the remote end of a connection, it may be None if you used ServerExt::accept_iostream().

pub fn request_body(&self) -> Option<MessageBody>

Get the request body of @self.

Returns

a #SoupMessageBody.

pub fn request_headers(&self) -> Option<MessageHeaders>

Get the request headers of @self.

Returns

a #SoupMessageHeaders with the request headers.

pub fn response_body(&self) -> Option<MessageBody>

Get the response body of @self.

Returns

a #SoupMessageBody.

pub fn response_headers(&self) -> Option<MessageHeaders>

Get the response headers of @self.

Returns

a #SoupMessageHeaders with the response headers.

pub fn socket(&self) -> Option<Socket>

Retrieves the gio::Socket that @self is associated with.

If you are using this method to observe when multiple requests are made on the same persistent HTTP connection (eg, as the ntlm-test test program does), you will need to pay attention to socket destruction as well (eg, by using weak references), so that you do not get fooled when the allocator reuses the memory address of a previously-destroyed socket to represent a new socket.

Returns

the #GSocket that @self is associated with, None if you used ServerExt::accept_iostream().

pub fn status(&self) -> u32

Get the HTTP status code of @self.

Returns

the HTTP status code.

pub fn tls_peer_certificate(&self) -> Option<TlsCertificate>

Gets the peer’s #GTlsCertificate associated with @self’s connection. Note that this is not set yet during the emission of SoupServerMessage::accept-certificate signal.

Returns

@self’s TLS peer certificate, or None if @self’s connection is not SSL.

pub fn tls_peer_certificate_errors(&self) -> TlsCertificateFlags

Gets the errors associated with validating @self’s TLS peer certificate. Note that this is not set yet during the emission of SoupServerMessage::accept-certificate signal.

Returns

a #GTlsCertificateFlags with @self’s TLS peer certificate errors.

pub fn uri(&self) -> Option<Uri>

Get @self’s URI.

Returns

a #GUri

pub fn is_options_ping(&self) -> bool

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

Returns

true if is an OPTIONS ping

pub fn pause(&self)

Pauses I/O on @self.

This can be used when you need to return from the server handler without having the full response ready yet. Use unpause() to resume I/O.

pub fn set_http_version(&self, version: HTTPVersion)

Set the HTTP version of @self.

version

a #SoupHTTPVersion

pub fn set_redirect(&self, status_code: u32, redirect_uri: &str)

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

@redirect_uri can be a relative URI, in which case it is interpreted relative to @self’s current URI. In particular, if @redirect_uri is just a path, it will replace the path and query of @self’s URI.

status_code

a 3xx status code

redirect_uri

the URI to redirect @self to

pub fn set_response( &self, content_type: Option<&str>, resp_use: MemoryUse, resp_body: &[u8] )

Convenience function to set the response body of a #SoupServerMessage. If @content_type is None, the response body must be empty as well.

content_type

MIME Content-Type of the body

resp_use

a #SoupMemoryUse describing how to handle @resp_body

resp_body

a data buffer containing the body of the message response.

pub fn set_status(&self, status_code: u32, reason_phrase: Option<&str>)

Sets @self’s status code to @status_code.

If @status_code is a known value and @reason_phrase is None, the reason_phrase will be set automatically.

status_code

an HTTP status code

reason_phrase

a reason phrase

pub fn steal_connection(&self) -> Option<IOStream>

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

Note that when calling this function from C, @self will most likely be freed as a side effect.

Returns

the #GIOStream formerly associated with @self (or None if @self was no longer associated with a connection). No guarantees are made about what kind of #GIOStream is returned.

pub fn unpause(&self)

Resumes I/O on @self.

Use this to resume after calling pause(), or after adding a new chunk to a chunked response. I/O won’t actually resume until you return to the main loop.

pub fn connect_accept_certificate<F: Fn(&Self, &TlsCertificate, TlsCertificateFlags) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted during the @msg’s connection TLS handshake after client TLS certificate has been received. You can return true to accept @tls_certificate despite @tls_errors.

tls_peer_certificate

the peer’s #GTlsCertificate

tls_peer_errors

the tls errors of @tls_certificate

Returns

true to accept the TLS certificate and stop other handlers from being invoked, or false to propagate the event further.

pub fn connect_connected<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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

pub fn connect_disconnected<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the @msg’s socket is disconnected.

pub fn connect_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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

pub fn connect_got_body<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted after receiving the complete request body.

pub fn connect_got_chunk<F: Fn(&Self, &Bytes) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted after receiving a chunk of a message body.

Note that “chunk” in this context means any subpiece of the body, not necessarily the specific HTTP 1.1 chunks sent by the other side.

chunk

the just-read chunk

pub fn connect_got_headers<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted after receiving the Request-Line and request headers.

pub fn connect_wrote_body<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

pub fn connect_wrote_body_data<F: Fn(&Self, u32) + 'static>( &self, f: F ) -> SignalHandlerId

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

chunk_size

the number of bytes written

pub fn connect_wrote_chunk<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted immediately after writing a body chunk for a message.

Note that this signal is not parallel to got-chunk; it is emitted only when a complete chunk (added with MessageBody::append() or MessageBody::append_bytes() has been written. To get more useful continuous progress information, use wrote-body-data.

pub fn connect_wrote_headers<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted immediately after writing the response headers for a message.

pub fn connect_wrote_informational<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

pub fn connect_tls_peer_certificate_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_tls_peer_certificate_errors_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for ServerMessage

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ServerMessage

type ParamSpec = ParamSpecObject

type SetValue = ServerMessage

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ServerMessage>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ServerMessage

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ServerMessage

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ServerMessage

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for ServerMessage

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ServerMessage

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ServerMessage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ServerMessage