Class HTTPServerSettings

Contains all settings for configuring a basic HTTP server.

The defaults are sufficient for most normal uses.

Inherits from

  • Object (base class)

Constructors

Name Description
this

Fields

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

Properties

Name Type Description
dup [get] HTTPServerSettings Returns a duplicate of the settings object.

Authors

Sönke Ludwig, Jan Krüger, Ilya Shipunov

Copyright

© 2012-2013 RejectedSoftware e.K.

License

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