Interface Server_ConstructProps

Hierarchy

GObject.Object_ConstructProps
- Server_ConstructProps

Index

Properties

Optional async_context

async_context?: object

The server's #GMainContext, if you are using the old API. Servers created using soup_server_listen() will listen on the #GMainContext that was the thread-default context at the time soup_server_listen() was called.

Optional http_aliases

http_aliases?: string[]

A %NULL-terminated array of URI schemes that should be considered to be aliases for "http". Eg, if this included "dav", than a URI of dav://example.com/path would be treated identically to http://example.com/path. In particular, this is needed in cases where a client sends requests with absolute URIs, where those URIs do not use "http:".

The default value is an array containing the single element "*", a special value which means that any scheme except "https" is considered to be an alias for "http".

Optional https_aliases

https_aliases?: string[]

A comma-delimited list of URI schemes that should be considered to be aliases for "https". See #SoupServer:http-aliases for more information.

The default value is %NULL, meaning that no URI schemes are considered aliases for "https".

Optional interface

interface?: Soup.Address

The address of the network interface the server is listening on, if you are using the old #SoupServer API. (This will not be set if you use soup_server_listen(), etc.)

Optional port

port?: number

The port the server is listening on, if you are using the old #SoupServer API. (This will not be set if you use soup_server_listen(), etc.)

Optional raw_paths

raw_paths?: boolean

Optional server_header

server_header?: string

If non-%NULL, the value to use for the "Server" header on #SoupMessages 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 #SoupSession:user_agent, if you set a #SoupServer:server_header property that has trailing whitespace, #SoupServer will append its own product token (eg, "libsoup/2.3.2") to the end of the header for you.

Optional ssl_cert_file

ssl_cert_file?: string

Path to a file containing a PEM-encoded certificate.

If you set this property and #SoupServer:ssl-key-file at construct time, then soup_server_new() will try to read the files; if it cannot, it will return %NULL, with no explicit indication of what went wrong (and logging a warning with newer versions of glib, since returning %NULL from a constructor is illegal).

Optional ssl_key_file

ssl_key_file?: string

Path to a file containing a PEM-encoded private key. See #SoupServer:ssl-cert-file for more information about how this is used.

Optional tls_certificate

tls_certificate?: TlsCertificate

A #GTlsCertificate that has a #GTlsCertificate:private-key set. If this is set, then the server will be able to speak https in addition to (or instead of) plain http.

Alternatively, you can call soup_server_set_ssl_cert_file() to have #SoupServer read in a a certificate from a file.