Soup.Server

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	accept_iostream (stream, local_addr, remote_addr)
	add_auth_domain (auth_domain)
	add_early_handler (path, callback, *user_data)
	add_handler (path, callback, *user_data)
	add_websocket_extension (extension_type)
	add_websocket_handler (path, origin, protocols, callback, *user_data)
	disconnect ()
	get_listeners ()
	get_tls_auth_mode ()
	get_tls_certificate ()
	get_tls_database ()
	get_uris ()
	is_https ()
	listen (address, options)
	listen_all (port, options)
	listen_local (port, options)
	listen_socket (socket, options)
	pause_message (msg)
	remove_auth_domain (auth_domain)
	remove_handler (path)
	remove_websocket_extension (extension_type)
	set_tls_auth_mode (mode)
	set_tls_certificate (certificate)
	set_tls_database (tls_database)
	unpause_message (msg)

Virtual Methods

Inherited:

GObject.Object (7)

	do_request_aborted (msg)
	do_request_finished (msg)
	do_request_read (msg)
	do_request_started (msg)

Properties

Name	Type	Flags	Short Description
raw-paths	bool	r/w/co	If True, percent-encoding in the Request-URI path will not be automatically decoded.
server-header	str	r/w/c	Server header
tls-auth-mode	Gio.TlsAuthenticationMode	r/w/c	Gio.TlsAuthenticationMode to use for SSL/TLS client authentication
tls-certificate	Gio.TlsCertificate	r/w/c	Gio.TlsCertificate to use for https
tls-database	Gio.TlsDatabase	r/w/c	Gio.TlsDatabase to use for validating SSL/TLS client certificates

Signals

Inherited:

GObject.Object (1)

Name	Short Description
request-aborted	Emitted when processing has failed for a message.
request-finished	Emitted when the server has finished writing a response to a request.
request-read	Emitted when the server has successfully read a request.
request-started	Emitted when the server has started reading a new request.

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	GObject.Object	r

Class Details

class Soup.Server(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

Soup.ServerClass

A HTTP server.

Soup.Server implements a simple HTTP server.

To begin, create a server using [ctor`Server`.new]. Add at least one handler by calling [method`Server`.add_handler] or [method`Server`.add_early_handler]; the handler will be called to process any requests underneath the path you pass. (If you want all requests to go to the same handler, just pass “/” (or None) for the path.)

When a new connection is accepted (or a new request is started on an existing persistent connection), the Soup.Server will emit [signal`Server`:py:func:::request-started<Soup.Server.signals.request_started>] and then begin processing the request as described below, but note that once the message is assigned a status-code, then callbacks after that point will be skipped. Note also that it is not defined when the callbacks happen relative to various [class`ServerMessage`] signals.

Once the headers have been read, Soup.Server will check if there is a [class`AuthDomain`] (qv) covering the Request-URI; if so, and if the message does not contain suitable authorization, then the [class`AuthDomain`] will set a status of Soup.Status.UNAUTHORIZED on the message.

After checking for authorization, Soup.Server will look for “early” handlers (added with [method`Server`.add_early_handler]) matching the Request-URI. If one is found, it will be run; in particular, this can be used to connect to signals to do a streaming read of the request body.

(At this point, if the request headers contain Expect: 100-continue, and a status code has been set, then Soup.Server will skip the remaining steps and return the response. If the request headers contain Expect: 100-continue and no status code has been set, Soup.Server will return a Soup.Status.CONTINUE status before continuing.)

The server will then read in the response body (if present). At this point, if there are no handlers at all defined for the Request-URI, then the server will return Soup.Status.NOT_FOUND to the client.

Otherwise (assuming no previous step assigned a status to the message) any “normal” handlers (added with [method`Server`.add_handler]) for the message’s Request-URI will be run.

Then, if the path has a WebSocket handler registered (and has not yet been assigned a status), Soup.Server will attempt to validate the WebSocket handshake, filling in the response and setting a status of Soup.Status.SWITCHING_PROTOCOLS or Soup.Status.BAD_REQUEST accordingly.

If the message still has no status code at this point (and has not been paused with [method`ServerMessage`.pause]), then it will be given a status of Soup.Status.INTERNAL_SERVER_ERROR (because at least one handler ran, but returned without assigning a status).

Finally, the server will emit [signal`Server`:py:func:::request-finished<Soup.Server.signals.request_finished>] (or [signal`Server`:py:func:::request-aborted<Soup.Server.signals.request_aborted>] if an I/O error occurred before handling was completed).

If you want to handle the special “*” URI (eg, “OPTIONS *”), you must explicitly register a handler for “*”; the default handler will not be used for that case.

If you want to process https connections in addition to (or instead of) http connections, you can set the [property`Server`:py:data::tls-certificate<Soup.Server.props.tls_certificate>] property.

Once the server is set up, make one or more calls to [method`Server`.listen], [method`Server`.listen_local], or [method`Server`.listen_all] to tell it where to listen for connections. (All ports on a Soup.Server use the same handlers; if you need to handle some ports differently, such as returning different data for http and https, you’ll need to create multiple ``SoupServer``s, or else check the passed-in URI in the handler function.).

Soup.Server will begin processing connections as soon as you return to (or start) the main loop for the current thread-default [struct`GLib`.MainContext].

accept_iostream(stream, local_addr, remote_addr)

Parameters:

• stream (Gio.IOStream) – a Gio.IOStream

• local_addr (Gio.SocketAddress or None) – the local Gio.SocketAddress associated with the stream

• remote_addr (Gio.SocketAddress or None) – the remote Gio.SocketAddress associated with the stream

Raises:

GLib.Error

Returns:

True on success, False if the stream could not be accepted or any other error occurred (in which case error will be set).

Return type:

bool

Adds a new client stream to the self.

add_auth_domain(auth_domain)

Parameters:

auth_domain (Soup.AuthDomain) – a Soup.AuthDomain

Adds an authentication domain to self.

Each auth domain will have the chance to require authentication for each request that comes in; normally auth domains will require authentication for requests on certain paths that they have been set up to watch, or that meet other criteria set by the caller. If an auth domain determines that a request requires authentication (and the request doesn’t contain authentication), self will automatically reject the request with an appropriate status (401 Unauthorized or 407 Proxy Authentication Required). If the request used the Soup.Server:100-continue Expectation, self will reject it before the request body is sent.

add_early_handler(path, callback, *user_data)

Parameters:

• path (str or None) – the toplevel path for the handler

• callback (Soup.ServerCallback) – callback to invoke for requests under path

• user_data (object or None) – data for callback

Adds an “early” handler to self for requests prefixed by path.

Note that “normal” and “early” handlers are matched up together, so if you add a normal handler for “/foo” and an early handler for “/foo/bar”, then a request to “/foo/bar” (or any path below it) will run only the early handler. (But if you add both handlers at the same path, then both will get run.)

For requests under path (that have not already been assigned a status code by a [class`AuthDomain`] or a signal handler), callback will be invoked after receiving the request headers, but before receiving the request body; the message’s method and request-headers properties will be set.

Early handlers are generally used for processing requests with request bodies in a streaming fashion. If you determine that the request will contain a message body, normally you would call [method`MessageBody`.set_accumulate] on the message’s request-body to turn off request-body accumulation, and connect to the message’s [signal`ServerMessage`:py:func:::got-chunk<Soup.Server.signals.got_chunk>] signal to process each chunk as it comes in.

To complete the message processing after the full message body has been read, you can either also connect to [signal`ServerMessage`:py:func:::got-body<Soup.Server.signals.got_body>], or else you can register a non-early handler for path as well. As long as you have not set the status-code by the time [signal`ServerMessage`:py:func:::got-body<Soup.Server.signals.got_body>] is emitted, the non-early handler will be run as well.

add_handler(path, callback, *user_data)

Parameters:

• path (str or None) – the toplevel path for the handler

• callback (Soup.ServerCallback) – callback to invoke for requests under path

• user_data (object or None) – data for callback

Adds a handler to self for requests prefixed by path.

If path is None or “/”, then this will be the default handler for all requests that don’t have a more specific handler. (Note though that if you want to handle requests to the special “*” URI, you must explicitly register a handler for “*”; the default handler will not be used for that case.)

For requests under path (that have not already been assigned a status code by a [class`AuthDomain`], an early server handler, or a signal handler), callback will be invoked after receiving the request body; the [class`ServerMessage`]’s method, request-headers, and request-body properties will be set.

After determining what to do with the request, the callback must at a minimum call [method`ServerMessage`.set_status] on the message to set the response status code. Additionally, it may set response headers and/or fill in the response body.

If the callback cannot fully fill in the response before returning (eg, if it needs to wait for information from a database, or another network server), it should call [method`ServerMessage`.pause] to tell self to not send the response right away. When the response is ready, call [method`ServerMessage`.unpause] to cause it to be sent.

To send the response body a bit at a time using “chunked” encoding, first call [method`MessageHeaders`.set_encoding] to set Soup.Encoding.CHUNKED on the response-headers. Then call [method`MessageBody`.append] (or [method`MessageBody`.append_bytes])) to append each chunk as it becomes ready, and [method`ServerMessage`.unpause] to make sure it’s running. (The server will automatically pause the message if it is using chunked encoding but no more chunks are available.) When you are done, call [method`MessageBody`.complete] to indicate that no more chunks are coming.

add_websocket_extension(extension_type)

Parameters:

extension_type (GObject.GType) – a GObject.GType

Add support for a WebSocket extension of the given extension_type.

When a WebSocket client requests an extension of extension_type, a new [class`WebsocketExtension`] of type extension_type will be created to handle the request.

Note that [class`WebsocketExtensionDeflate`] is supported by default, use [method`Server`.remove_websocket_extension] if you want to disable it.

add_websocket_handler(path, origin, protocols, callback, *user_data)

Parameters:

• path (str or None) – the toplevel path for the handler

• origin (str or None) – the origin of the connection

• protocols ([str] or None) – the protocols supported by this handler

• callback (Soup.ServerWebsocketCallback) – callback to invoke for successful WebSocket requests under path

• user_data (object or None) – data for callback

Adds a WebSocket handler to self for requests prefixed by path.

If path is None or “/”, then this will be the default handler for all requests that don’t have a more specific handler.

When a path has a WebSocket handler registered, self will check incoming requests for WebSocket handshakes after all other handlers have run (unless some earlier handler has already set a status code on the message), and update the request’s status, response headers, and response body accordingly.

If origin is non-None, then only requests containing a matching “Origin” header will be accepted. If protocols is non-None, then only requests containing a compatible “Sec-WebSocket-Protocols” header will be accepted. More complicated requirements can be handled by adding a normal handler to path, and having it perform whatever checks are needed and setting a failure status code if the handshake should be rejected.

disconnect()

Closes and frees self's listening sockets.

Note that if there are currently requests in progress on self, that they will continue to be processed if self's [struct`GLib`.MainContext] is still running.

You can call [method`Server`.listen], etc, after calling this function if you want to start listening again.

get_listeners()

Returns:

a list of listening sockets.

Return type:

[Gio.Socket]

Gets self's list of listening sockets.

You should treat these sockets as read-only; writing to or modifiying any of these sockets may cause self to malfunction.

get_tls_auth_mode()

Returns:

a Gio.TlsAuthenticationMode

Return type:

Gio.TlsAuthenticationMode

Gets the self SSL/TLS client authentication mode.

get_tls_certificate()

Returns:

a Gio.TlsCertificate or None

Return type:

Gio.TlsCertificate or None

Gets the self SSL/TLS certificate.

get_tls_database()

Returns:

a Gio.TlsDatabase

Return type:

Gio.TlsDatabase or None

Gets the self SSL/TLS database.

get_uris()

Returns:

a list of GLib.Uris, which you must free when you are done with it.

Return type:

[GLib.Uri]

Gets a list of URIs corresponding to the interfaces self is listening on.

These will contain IP addresses, not hostnames, and will also indicate whether the given listener is http or https.

Note that if you used [method`Server`.listen_all] the returned URIs will use the addresses 0.0.0.0 and ::, rather than actually returning separate URIs for each interface on the system.

is_https()

Returns:

True if self is configured to serve https.

Return type:

bool

Checks whether self is capable of https.

In order for a server to run https, you must call [method`Server`.set_tls_certificate], or set the [property`Server`:py:data::tls-certificate<Soup.Server.props.tls_certificate>] property, to provide it with a certificate to use.

If you are using the deprecated single-listener APIs, then a return value of True indicates that the Soup.Server serves https exclusively. If you are using [method`Server`.listen], etc, then a True return value merely indicates that the server is *able* to do https, regardless of whether it actually currently is or not. Use [method`Server`.get_uris] to see if it currently has any https listeners.

listen(address, options)

Parameters:

• address (Gio.SocketAddress) – the address of the interface to listen on

• options (Soup.ServerListenOptions) – listening options for this server

Raises:

GLib.Error

Returns:

True on success, False if address could not be bound or any other error occurred (in which case error will be set).

Return type:

bool

Attempts to set up self to listen for connections on address.

If options includes Soup.ServerListenOptions.HTTPS, and self has been configured for TLS, then self will listen for https connections on this port. Otherwise it will listen for plain http.

You may call this method (along with the other “listen” methods) any number of times on a server, if you want to listen on multiple ports, or set up both http and https service.

After calling this method, self will begin accepting and processing connections as soon as the appropriate [struct`GLib`.MainContext] is run.

Note that this API does not make use of dual IPv4/IPv6 sockets; if address is an IPv6 address, it will only accept IPv6 connections. You must configure IPv4 listening separately.

listen_all(port, options)

Parameters:

• port (int) – the port to listen on, or 0

• options (Soup.ServerListenOptions) – listening options for this server

Raises:

GLib.Error

Returns:

True on success, False if port could not be bound or any other error occurred (in which case error will be set).

Return type:

bool

Attempts to set up self to listen for connections on all interfaces on the system.

That is, it listens on the addresses 0.0.0.0 and/or ::, depending on whether options includes Soup.ServerListenOptions.IPV4_ONLY, Soup.ServerListenOptions.IPV6_ONLY, or neither.) If port is specified, self will listen on that port. If it is 0, self will find an unused port to listen on. (In that case, you can use [method`Server`.get_uris] to find out what port it ended up choosing.

See [method`Server`.listen] for more details.

listen_local(port, options)

Parameters:

• port (int) – the port to listen on, or 0

• options (Soup.ServerListenOptions) – listening options for this server

Raises:

GLib.Error

Returns:

True on success, False if port could not be bound or any other error occurred (in which case error will be set).

Return type:

bool

Attempts to set up self to listen for connections on “localhost”.

That is, 127.0.0.1 and/or ::1, depending on whether options includes Soup.ServerListenOptions.IPV4_ONLY, Soup.ServerListenOptions.IPV6_ONLY, or neither). If port is specified, self will listen on that port. If it is 0, self will find an unused port to listen on. (In that case, you can use [method`Server`.get_uris] to find out what port it ended up choosing.

See [method`Server`.listen] for more details.

listen_socket(socket, options)

Parameters:

• socket (Gio.Socket) – a listening Gio.Socket

• options (Soup.ServerListenOptions) – listening options for this server

Raises:

GLib.Error

Returns:

True on success, False if an error occurred (in which case error will be set).

Return type:

bool

Attempts to set up self to listen for connections on socket.

See [method`Server`.listen] for more details.

pause_message(msg)

Parameters:

msg (Soup.ServerMessage) – a Soup.ServerMessage associated with self.

Pauses I/O on msg.

This can be used when you need to return from the server handler without having the full response ready yet. Use [method`Server`.unpause_message] to resume I/O.

This must only be called on a [class`ServerMessage`] which was created by the Soup.Server and are currently doing I/O, such as those passed into a [callback`ServerCallback`] or emitted in a [signal`Server`:py:func:::request-read<Soup.Server.signals.request_read>] signal.

Deprecated since version 3.2: Use Soup.ServerMessage.pause() instead.

remove_auth_domain(auth_domain)

Parameters:

auth_domain (Soup.AuthDomain) – a Soup.AuthDomain

Removes auth_domain from self.

remove_handler(path)

Parameters:

path (str) – the toplevel path for the handler

Removes all handlers (early and normal) registered at path.

remove_websocket_extension(extension_type)

Parameters:

extension_type (GObject.GType) – a GObject.GType

Removes support for WebSocket extension of type extension_type (or any subclass of extension_type) from self.

set_tls_auth_mode(mode)

Parameters:

mode (Gio.TlsAuthenticationMode) – a Gio.TlsAuthenticationMode

Sets self's Gio.TlsAuthenticationMode to use for SSL/TLS client authentication.

set_tls_certificate(certificate)

Parameters:

certificate (Gio.TlsCertificate) – a Gio.TlsCertificate

Sets self up to do https, using the given SSL/TLS certificate.

set_tls_database(tls_database)

Parameters:

tls_database (Gio.TlsDatabase) – a Gio.TlsDatabase

Sets self's Gio.TlsDatabase to use for validating SSL/TLS client certificates.

unpause_message(msg)

Parameters:

msg (Soup.ServerMessage) – a Soup.ServerMessage associated with self.

Resumes I/O on msg.

Use this to resume after calling [method`Server`.pause_message], or after adding a new chunk to a chunked response.

I/O won’t actually resume until you return to the main loop.

This must only be called on a [class`ServerMessage`] which was created by the Soup.Server and are currently doing I/O, such as those passed into a [callback`ServerCallback`] or emitted in a [signal`Server`:py:func:::request-read<Soup.Server.signals.request_read>] signal.

Deprecated since version 3.2: Use Soup.ServerMessage.unpause() instead.

do_request_aborted(msg) virtual

Parameters:

msg (Soup.ServerMessage) –

do_request_finished(msg) virtual

Parameters:

msg (Soup.ServerMessage) –

do_request_read(msg) virtual

Parameters:

msg (Soup.ServerMessage) –

do_request_started(msg) virtual

Parameters:

msg (Soup.ServerMessage) –

Signal Details

Soup.Server.signals.request_aborted(server, message)

Signal Name:

request-aborted

Flags:

RUN_FIRST

Parameters:

• server (Soup.Server) – The object which received the signal

• message (Soup.ServerMessage) – the message

Emitted when processing has failed for a message.

This could mean either that it could not be read (if [signal`Server`:py:func:::request-read<Soup.Server.signals.request_read>] has not been emitted for it yet), or that the response could not be written back (if [signal`Server`:py:func:::request-read<Soup.Server.signals.request_read>] has been emitted but [signal`Server`:py:func:::request-finished<Soup.Server.signals.request_finished>] has not been).

message is in an undefined state when this signal is emitted; the signal exists primarily to allow the server to free any state that it may have allocated in [signal`Server`:py:func:::request-started<Soup.Server.signals.request_started>].

Soup.Server.signals.request_finished(server, message)

Signal Name:

request-finished

Flags:

RUN_FIRST

Parameters:

• server (Soup.Server) – The object which received the signal

• message (Soup.ServerMessage) – the message

Emitted when the server has finished writing a response to a request.

Soup.Server.signals.request_read(server, message)

Signal Name:

request-read

Flags:

RUN_FIRST

Parameters:

• server (Soup.Server) – The object which received the signal

• message (Soup.ServerMessage) – the message

Emitted when the server has successfully read a request.

message will have all of its request-side information filled in, and if the message was authenticated, client will have information about that. This signal is emitted before any (non-early) handlers are called for the message, and if it sets the message’s #status_code, then normal handler processing will be skipped.

Soup.Server.signals.request_started(server, message)

Signal Name:

request-started

Flags:

RUN_FIRST

Parameters:

• server (Soup.Server) – The object which received the signal

• message (Soup.ServerMessage) – the new message

Emitted when the server has started reading a new request.

message will be completely blank; not even the Request-Line will have been read yet. About the only thing you can usefully do with it is connect to its signals.

If the request is read successfully, this will eventually be followed by a [signal`Server`::request_read signal]. If a response is then sent, the request processing will end with a [signal`Server`:py:func:::request-finished<Soup.Server.signals.request_finished>] signal. If a network error occurs, the processing will instead end with [signal`Server`:py:func:::request-aborted<Soup.Server.signals.request_aborted>].

Property Details

Soup.Server.props.raw_paths

Name:

raw-paths

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

If True, percent-encoding in the Request-URI path will not be automatically decoded.

Soup.Server.props.server_header

Name:

server-header

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

Server header.

If non-None, the value to use for the “Server” header on [class`ServerMessage`]s processed by this server.

The Server header is the server equivalent of the User-Agent header, and provides information about the server and its components. It contains a list of one or more product tokens, separated by whitespace, with the most significant product token coming first. The tokens must be brief, ASCII, and mostly alphanumeric (although “-”, “_”, and “.” are also allowed), and may optionally include a “/” followed by a version string. You may also put comments, enclosed in parentheses, between or after the tokens.

Some HTTP server implementations intentionally do not use version numbers in their Server header, so that installations running older versions of the server don’t end up advertising their vulnerability to specific security holes.

As with [property`Session`:user_agent], if you set a [property`Server`:py:data::server-header<Soup.Server.props.server_header>] property that has trailing whitespace, Soup.Server will append its own product token (eg, libsoup/2.3.2) to the end of the header for you.

Soup.Server.props.tls_auth_mode

Name:

tls-auth-mode

Type:

Gio.TlsAuthenticationMode

Default Value:

Gio.TlsAuthenticationMode.NONE

Flags:

READABLE, WRITABLE, CONSTRUCT

A [enum`Gio`.TlsAuthenticationMode] for SSL/TLS client authentication.

Soup.Server.props.tls_certificate

Name:

tls-certificate

Type:

Gio.TlsCertificate

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

A [class`Gio`.TlsCertificate[] that has a [property`Gio`.TlsCertificate:private-key] set.

If this is set, then the server will be able to speak https in addition to (or instead of) plain http.

Soup.Server.props.tls_database

Name:

tls-database

Type:

Gio.TlsDatabase

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

A [class`Gio`.TlsDatabase] to use for validating SSL/TLS client certificates.