Server
#SoupServer provides a basic implementation of an HTTP server. The recommended usage of this server is for internal use, tasks like a mock server for tests, a private service for IPC, etc. It is not recommended to be exposed to untrusted clients as it may be vulnerable to denial of service attacks or other exploits.
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 null) for the path.)
When a new connection is accepted (or a new request is started on an existing persistent connection), the #SoupServer will emit signal@Server::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, #SoupServer 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, #SoupServer 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 #SoupServer will skip the remaining steps and return the response. If the request headers contain Expect: 100-continue and no status code has been set, #SoupServer 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), #SoupServer 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::request-finished (or signal@Server::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: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 #SoupServer 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 SoupServers, or else check the passed-in URI in the handler function.).
#SoupServer will begin processing connections as soon as you return to (or start) the main loop for the current thread-default struct@GLib.MainContext.
Skipped during bindings generation
method
raw-paths: Property has no getter nor settermethod
server-header: Property has no getter nor settermethod
tls-certificate: Property TypeInfo of getter and setter do not matchmethod
tls-database: Property TypeInfo of getter and setter do not matchconstructor
new: Varargs parameter is not supported
Constructors
Properties
Functions
Adds a new client stream to the @server.
Adds an authentication domain to @server.
Adds an "early" handler to @server for requests prefixed by @path.
Adds a handler to @server for requests prefixed by @path.
Add support for a WebSocket extension of the given @extension_type.
Adds a WebSocket handler to @server for requests prefixed by @path.
Closes and frees @server's listening sockets.
Emits the "request-aborted" signal. See onRequestAborted.
Emits the "request-finished" signal. See onRequestFinished.
Emits the "request-read" signal. See onRequestRead.
Emits the "request-started" signal. See onRequestStarted.
Gets @server's list of listening sockets.
Gets the @server SSL/TLS certificate.
Gets the @server SSL/TLS database.
Attempts to set up @server to listen for connections on @address.
Attempts to set up @server to listen for connections on all interfaces on the system.
Attempts to set up @server to listen for connections on "localhost".
Attempts to set up @server to listen for connections on @socket.
Emitted when processing has failed for a message.
Emitted when the server has finished writing a response to a request.
Emitted when the server has successfully read a request.
Emitted when the server has started reading a new request.
This is deprecated since version 3.2.
Removes @auth_domain from @server.
Removes all handlers (early and normal) registered at @path.
Removes support for WebSocket extension of type @extension_type (or any subclass of
Sets @server up to do https, using the given SSL/TLS @certificate.
Sets @server's #GTlsDatabase to use for validating SSL/TLS client certificates.
This is deprecated since version 3.2.