Class HTTPServerSettings

Contains all settings for configuring a basic HTTP server.

The defaults are sufficient for most normal uses.

Constructors

Name	Description
this (bind_string)	Constructs a new settings object with a custom bind interface and/or port.
this ()	Constructs a new settings object with default values.

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.
accessLogger	HTTPLogger	Specifies a custom access logger instance.
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.
hostName	string	Determines the server host name.
keepAliveTimeout	core.time.Duration	Maximum time between two request on a keep-alive connection
maxRequestHeaderLineSize	ulong	Maximum number of bytes in a single line in the request header.
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
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.
rejectConnectionPredicate	nothrow @safe bool delegate(in NetworkAddress)	Provides a way to reject incoming connections as early as possible.
serverString	string
sessionIdCookie	string
sessionOptions	SessionOption	Session options to use when initializing a new session.
sessionStore	SessionStore	Session management is enabled if a session store instance is provided
tlsContext	TLSContext	If set, a HTTPS server will be started instead of plain HTTP.
useCompressionIfPossible	bool	Responds to "Accept-Encoding" by using compression if possible.
webSocketPingInterval	core.time.Duration	Interval between WebSocket ping frames.

Properties

Name	Type	Description
dup[get]	HTTPServerSettings	Returns a duplicate of the settings object.
errorPageHandler[get, set]	@safe void delegate(HTTPServerRequest, HTTPServerResponse, HTTPServerErrorInfo)	Sets a custom handler for displaying error pages for HTTP errors
errorPageHandler[set]	void delegate(HTTPServerRequest, HTTPServerResponse, HTTPServerErrorInfo)	Scheduled for deprecation - use a @safe callback instead.