Class HttpServerSettings

Contains all settings for configuring a basic HTTP server.

The defaults are sufficient for most normal uses.

Inherits from

Fields

Name Type Descrption
port ushort The port on which the HTTP server is listening.
bindAddresses string[] The interfaces on which the HTTP server is listening.
hostName string Determines the server host name.
options HttpServerOption Configures optional features of the HTTP server
maxRequestTime core.time.Duration Time of a request after which the connection is closed with an error; not supported yet
keepAliveTimeout core.time.Duration Maximum time between two request on a keep-alive connection
maxRequestSize ulong Maximum number of transferred bytes per request after which the connection is closed with an error; not supported yet
maxRequestHeaderSize ulong Maximum number of transferred bytes for the request header. This includes the request line the url and all headers.
errorPageHandler HttpServerErrorPageHandler Sets a custom handler for displaying error pages for HTTP errors
sslCertFile string If set, a HTTPS server will be started instead of plain HTTP
sslKeyFile string If set, a HTTPS server will be started instead of plain HTTP
sslContext SslContext If set, a HTTPS server will be started instead of plain HTTP
sessionStore SessionStore Session management is enabled if a session store instance is provided
sessionIdCookie string
serverString string
accessLogFormat string Specifies the format used for the access log.
accessLogFile string Spefifies the name of a file to which access log messages are appended.
accessLogToConsole bool If set, access log entries will be output to the console.
disableDistHost bool Disable support for VibeDist and instead start listening immediately.

Methods

Name Description
dup Returns a duplicate of the settings object.

Authors

Sönke Ludwig, Jan Krüger

Copyright

© 2012 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.