Optionalproperties: Partial<Soup.Server.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeConstruct Onlyraw_If true, percent-encoding in the Request-URI path will not be
automatically decoded.
Construct OnlyrawIf true, percent-encoding in the Request-URI path will not be
automatically decoded.
Server header.
If non-null, the value to use for the "Server" header on
ServerMessages 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 Session.user_agent, if you set a
Server.server_header property that has trailing
whitespace, Server will append its own product token (eg,
libsoup/2.3.2) to the end of the header for you.
Server header.
If non-null, the value to use for the "Server" header on
ServerMessages 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 Session.user_agent, if you set a
Server.server_header property that has trailing
whitespace, Server will append its own product token (eg,
libsoup/2.3.2) to the end of the header for you.
A Gio.TlsAuthenticationMode for SSL/TLS client authentication.
A [class@Gio.TlsCertificate[] that has a 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.
A Gio.TlsDatabase to use for validating SSL/TLS client certificates.
A Gio.TlsAuthenticationMode for SSL/TLS client authentication.
A [class@Gio.TlsCertificate[] that has a 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.
A Gio.TlsDatabase to use for validating SSL/TLS client certificates.
Adds a new client stream to the server.
Optionallocal_addr: Gio.SocketAddressthe local Gio.SocketAddress associated with the stream
Optionalremote_addr: Gio.SocketAddressthe remote Gio.SocketAddress associated with the stream
true on success, false if the stream could not be accepted or any other error occurred (in which case error will be set).
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 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 MessageBody.set_accumulate on
the message's request-body to turn off request-body accumulation, and connect
to the message's Soup.ServerMessage::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 Soup.ServerMessage::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
Soup.ServerMessage::got-body is emitted, the non-early handler will be
run as well.
the toplevel path for the handler
callback to invoke for requests under path
Adds a handler to server for requests prefixed by path.
If path is null 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 AuthDomain, an early server handler, or a
signal handler), callback will be invoked after receiving the
request body; the 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 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 ServerMessage.pause
to tell server to not send the response right away. When the
response is ready, call ServerMessage.unpause to cause it
to be sent.
To send the response body a bit at a time using "chunked" encoding, first call MessageHeaders.set_encoding to set Soup.Encoding.CHUNKED on the response-headers. Then call MessageBody.append (or MessageBody.append_bytes)) to append each chunk as it becomes ready, and 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 MessageBody.complete to indicate that no more chunks are coming.
the toplevel path for the handler
callback to invoke for requests under path
Add support for a WebSocket extension of the given extension_type.
When a WebSocket client requests an extension of extension_type,
a new WebsocketExtension of type extension_type will be created
to handle the request.
Note that WebsocketExtensionDeflate is supported by default, use Server.remove_websocket_extension if you want to disable it.
Adds a WebSocket handler to server for requests prefixed by path.
If path is null 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-null, then only requests containing a matching
"Origin" header will be accepted. If protocols is non-null, 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.
the toplevel path for the handler
the origin of the connection
the protocols supported by this handler
callback to invoke for successful WebSocket requests under path
SignalconnectSignalconnect_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 GLib.MainContext is still
running.
You can call Server.listen, etc, after calling this function if you want to start listening again.
SignalemitGets the server SSL/TLS client authentication mode.
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 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.
a list of GLib.Uri, which you must free with each element with GLib.Uri.unref when you are done with it.
Checks whether server is capable of https.
In order for a server to run https, you must call Server.set_tls_certificate, or set the Server.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 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 Server.get_uris to see if it currently has
any https listeners.
true if server is configured to serve https.
Attempts to set up server to listen for connections on address.
If options includes Soup.ServerListenOptions.HTTPS, 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 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.
the address of the interface to listen on
listening options for this server
true on success, false if address could not be bound or any other error occurred (in which case error will be set).
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 Soup.ServerListenOptions.IPV4_ONLY,
Soup.ServerListenOptions.IPV6_ONLY, 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 Server.get_uris to find out
what port it ended up choosing.
See Server.listen for more details.
the port to listen on, or 0
listening options for this server
true on success, false if port could not be bound or any other error occurred (in which case error will be set).
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
Soup.ServerListenOptions.IPV4_ONLY, Soup.ServerListenOptions.IPV6_ONLY, 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
Server.get_uris to find out what port it ended up choosing.
See Server.listen for more details.
the port to listen on, or 0
listening options for this server
true on success, false if port could not be bound or any other error occurred (in which case error will be set).
Attempts to set up server to listen for connections on socket.
See Server.listen for more details.
a listening Gio.Socket
listening options for this server
true on success, false if an error occurred (in which case error will be set).
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 Server.unpause_message to resume I/O.
This must only be called on a ServerMessage which was created by the
Server and are currently doing I/O, such as those passed into a
ServerCallback or emitted in a Soup.Server::request-read
signal.
a Soup.ServerMessage associated with server.
Removes all handlers (early and normal) registered at path.
the toplevel path for the handler
Removes support for WebSocket extension of type extension_type (or any subclass of
extension_type) from server.
Sets server's Gio.TlsAuthenticationMode to use for SSL/TLS client authentication.
Sets server up to do https, using the given SSL/TLS certificate.
Sets server's Gio.TlsDatabase to use for validating SSL/TLS client certificates.
Resumes I/O on msg.
Use this to resume after calling 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 ServerMessage which was created by the
Server and are currently doing I/O, such as those passed into a
ServerCallback or emitted in a Soup.Server::request-read
signal.
a Soup.ServerMessage associated with server.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Server 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 Server.new. Add at least one handler by calling Server.add_handler or 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 Server will emit
Soup.Server::request-startedand 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 ServerMessage signals.Once the headers have been read, Server will check if there is a AuthDomain
(qv)covering the Request-URI; if so, and if the message does not contain suitable authorization, then the AuthDomain will set a status of Soup.Status.UNAUTHORIZED on the message.After checking for authorization, Server will look for "early" handlers (added with 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 Server will skip the remaining steps and return the response. If the request headers containExpect: 100-continueand no status code has been set, 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 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), 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 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
Soup.Server::request-finished(orSoup.Server::request-abortedif 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 Server.tls_certificate property.
Once the server is set up, make one or more calls to Server.listen, Server.listen_local, or Server.listen_all to tell it where to listen for connections. (All ports on a 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 Servers, or else check the passed-in URI in the handler function.).
Server will begin processing connections as soon as you return to (or start) the main loop for the current thread-default GLib.MainContext.