Memory-managed wrapper type.

Type class for types which can be safely cast to Server, for instance with toServer.

Cast to Server, for types for which this is known to be safe. For general casts, use castTo.

Adds a new client stream to the server.

Adds an authentication domain to server.

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), server will automatically reject the request with an appropriate status (401 Unauthorized or 407 Proxy Authentication Required). If the request used the SoupServer:100-continue Expectation, server will reject it before the request body is sent.

Adds an "early" handler to server 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 [classauthDomain] 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 [methodmessageBody.set_accumulate] on the message's request-body to turn off request-body accumulation, and connect to the message's signalserverMessage[gotChunk] 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 signalserverMessage[gotBody], 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 signalserverMessage[gotBody] is emitted, the non-early handler will be run as well.

Adds a handler to server for requests prefixed by path.

If path is Nothing 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 [classauthDomain], an early server handler, or a signal handler), callback will be invoked after receiving the request body; the [classserverMessage]'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 [methodserverMessage.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 [methodserverMessage.pause] to tell server to not send the response right away. When the response is ready, call [methodserverMessage.unpause] to cause it to be sent.

To send the response body a bit at a time using "chunked" encoding, first call [methodmessageHeaders.set_encoding] to set EncodingChunked on the response-headers. Then call [methodmessageBody.append] (or [methodmessageBody.append_bytes])) to append each chunk as it becomes ready, and [methodserverMessage.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 [methodmessageBody.complete] to indicate that no more chunks are coming.

Add support for a WebSocket extension of the given extensionType.

When a WebSocket client requests an extension of extensionType, a new [classwebsocketExtension] of type extensionType will be created to handle the request.

Note that [classwebsocketExtensionDeflate] is supported by default, use [methodserver.remove_websocket_extension] if you want to disable it.

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

If path is Nothing 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, server 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-Nothing, then only requests containing a matching "Origin" header will be accepted. If protocols is non-Nothing, 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.

Closes and frees server's listening sockets.

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

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

Gets server's list of listening sockets.

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

Gets the server SSL/TLS client authentication mode.

Gets the server SSL/TLS certificate.

Gets the server SSL/TLS database.

Gets a list of URIs corresponding to the interfaces server 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 [methodserver.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.

Checks whether server is capable of https.

In order for a server to run https, you must call [methodserver.set_tls_certificate], or set the [propertyserver: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 Server serves https exclusively. If you are using [methodserver.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 [methodserver.get_uris] to see if it currently has any https listeners.

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

If options includes ServerListenOptionsHttps, and server has been configured for TLS, then server 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, server will begin accepting and processing connections as soon as the appropriate [structgLib.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.

Attempts to set up server 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 ServerListenOptionsIpv4Only, ServerListenOptionsIpv6Only, or neither.) If port is specified, server will listen on that port. If it is 0, server will find an unused port to listen on. (In that case, you can use [methodserver.get_uris] to find out what port it ended up choosing.

See [methodserver.listen] for more details.

Attempts to set up server to listen for connections on "localhost".

That is, 127.0.0.1 and/or ::1, depending on whether options includes ServerListenOptionsIpv4Only, ServerListenOptionsIpv6Only, or neither). If port is specified, server will listen on that port. If it is 0, server will find an unused port to listen on. (In that case, you can use [methodserver.get_uris] to find out what port it ended up choosing.

See [methodserver.listen] for more details.

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

See [methodserver.listen] for more details.

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 [methodserver.unpause_message] to resume I/O.

This must only be called on a [classserverMessage] which was created by the Server and are currently doing I/O, such as those passed into a [callbackserverCallback] or emitted in a signalserver[requestRead] signal.

Removes authDomain from server.

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

Removes support for WebSocket extension of type extensionType (or any subclass of extensionType) from server.

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

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

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

Resumes I/O on msg.

Use this to resume after calling [methodserver.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 [classserverMessage] which was created by the Server and are currently doing I/O, such as those passed into a [callbackserverCallback] or emitted in a signalserver[requestRead] signal.

Construct a GValueConstruct with valid value for the “raw-paths” property. This is rarely needed directly, but it is used by new.

Get the value of the “raw-paths” property. When overloading is enabled, this is equivalent to

get server #rawPaths

Set the value of the “server-header” property to Nothing. When overloading is enabled, this is equivalent to

clear #serverHeader

Construct a GValueConstruct with valid value for the “server-header” property. This is rarely needed directly, but it is used by new.

Get the value of the “server-header” property. When overloading is enabled, this is equivalent to

get server #serverHeader

Set the value of the “server-header” property. When overloading is enabled, this is equivalent to

set server [ #serverHeader := value ]

Construct a GValueConstruct with valid value for the “tls-auth-mode” property. This is rarely needed directly, but it is used by new.

Get the value of the “tls-auth-mode” property. When overloading is enabled, this is equivalent to

get server #tlsAuthMode

Set the value of the “tls-auth-mode” property. When overloading is enabled, this is equivalent to

set server [ #tlsAuthMode := value ]

Construct a GValueConstruct with valid value for the “tls-certificate” property. This is rarely needed directly, but it is used by new.

Get the value of the “tls-certificate” property. When overloading is enabled, this is equivalent to

get server #tlsCertificate

Set the value of the “tls-certificate” property. When overloading is enabled, this is equivalent to

set server [ #tlsCertificate := value ]

Construct a GValueConstruct with valid value for the “tls-database” property. This is rarely needed directly, but it is used by new.

Get the value of the “tls-database” property. When overloading is enabled, this is equivalent to

get server #tlsDatabase

Set the value of the “tls-database” property. When overloading is enabled, this is equivalent to

set server [ #tlsDatabase := value ]

Emitted when processing has failed for a message.

This could mean either that it could not be read (if signalserver[requestRead] has not been emitted for it yet), or that the response could not be written back (if signalserver[requestRead] has been emitted but signalserver[requestFinished] 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 signalserver[requestStarted].

Connect a signal handler for the requestAborted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after server #requestAborted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the requestAborted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on server #requestAborted callback

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

Connect a signal handler for the requestFinished signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after server #requestFinished callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the requestFinished signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on server #requestFinished callback

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.

Connect a signal handler for the requestRead signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after server #requestRead callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the requestRead signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on server #requestRead callback

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 signalserver[request_read signal]. If a response is then sent, the request processing will end with a signalserver[requestFinished] signal. If a network error occurs, the processing will instead end with signalserver[requestAborted].

Connect a signal handler for the requestStarted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after server #requestStarted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the requestStarted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on server #requestStarted callback