Various Warp server settings. This is purposely kept as an abstract data type so that new settings can be added without breaking backwards compatibility. In order to create a Settings value, use defaultSettings and the various 'set' functions to modify individual fields. For example:
setTimeout 20 defaultSettingsConstructors
SettingssettingsPort :: PortPort to listen on. Default value: 3000
settingsHost :: HostPreferenceDefault value: HostIPv4
settingsOnException :: Maybe Request -> SomeException -> IO ()What to do with exceptions thrown by either the application or server. Default: ignore server-generated exceptions (see InvalidRequest) and print application-generated applications to stderr.
settingsOnConnectionException :: Maybe (SockAddr -> SomeException -> IO ())Optional observer for exceptions escaping a connection worker. Nothing delegates to settingsOnException with no request, preserving its defaults.
settingsOnExceptionResponse :: SomeException -> ResponseA function to create Response when an exception occurs.
Default: 500, text/plain, "Something went wrong"
settingsOnOpen :: SockAddr -> IO BoolsettingsOnClose :: SockAddr -> IO ()What to do when a connection is close. Default: do nothing.
settingsTimeout :: IntTimeout value in seconds. Default value: 30
settingsManager :: Maybe ManagerUse an existing timeout manager instead of spawning a new one. If used, settingsTimeout is ignored. Default is Nothing
settingsFdCacheDuration :: IntCache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 0
settingsFileInfoCacheDuration :: IntCache duration time of file information in seconds. 0 means that the cache mechanism is not used. Default value: 0
settingsBeforeMainLoop :: IO ()Code to run after the listening socket is ready but before entering the main event loop. Useful for signaling to tests that they can start running, or to drop permissions after binding to a restricted port.
Default: do nothing.
settingsFork :: ((forall a. IO a -> IO a) -> IO ()) -> IO ()Code to fork a new thread to accept a connection.
This may be useful if you need OS bound threads, or if you wish to develop an alternative threading model.
Default:
defaultForksettingsAccept :: Socket -> IO (Socket, SockAddr)Code to accept a new connection.
Useful if you need to provide connected sockets from something other than a standard accept call.
Default:
defaultAcceptsettingsNoParsePath :: BoolPerform no parsing on the rawPathInfo.
This is useful for writing HTTP proxies.
Default: False
settingsInstallShutdownHandler :: IO () -> IO ()An action to install a handler (e.g. Unix signal handler) to close a listen socket. The first argument is an action to close the listen socket.
Default: no action
settingsServerName :: ByteStringDefault server name if application does not set one.
settingsMaximumBodyFlush :: Maybe IntSee
setMaximumBodyFlush.settingsProxyProtocol :: ProxyProtocolSpecify usage of the PROXY protocol.
settingsSlowlorisSize :: IntSize of bytes read to prevent Slowloris protection. Default value: 2048
settingsHTTP2Enabled :: BoolWhether to enable HTTP2 ALPN/upgrades. Default: True
settingsLogger :: Request -> Status -> Maybe Integer -> IO ()A log function. Default: no action.
settingsLogger req status mSentBytesN.B.
Maybe Integeris the concrete bytes of the message body after all the headers have been sent. This is Nothing when responseRaw is used. (e.g. when using websockets)settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()A HTTP/2 server push log function. Default: no action.
settingsGracefulShutdownTimeout :: Maybe IntAn optional timeout to limit the time (in seconds) waiting for a graceful shutdown of the web server.
settingsGracefulCloseTimeout1 :: IntA timeout to limit the time (in milliseconds) waiting for FIN for HTTP/1.x. 0 means uses immediate close. Default: 0.
settingsGracefulCloseTimeout2 :: IntA timeout to limit the time (in milliseconds) waiting for FIN for HTTP/2. 0 means uses immediate close. Default: 2000.
settingsMaxTotalHeaderLength :: IntDetermines the maximum header size that Warp will tolerate when using HTTP/1.x.
settingsAltSvc :: Maybe ByteStringSpecify the header value of Alternative Services (AltSvc:).
Default: Nothing
settingsMaxBuilderResponseBufferSize :: IntDetermines the maxium buffer size when sending
Builderresponses (See responseBuilder).When sending a builder response warp uses a 16 KiB buffer to write the builder to. When that buffer is too small to fit the builder warp will free it and create a new one that will fit the builder.
To protect against allocating too large a buffer warp will error if the builder requires more than this maximum.
Default: 1049_000_000 = 1 MiB.
settingsConnectionCounter :: Maybe CounterA counter for tracking open connections. Use makeSettingsAndCounter to create settings with a counter, then use getCount on the returned Counter to read the current value.
Default: Nothing (warp creates an internal counter)
DEPRECATED in favor of settingsServerState
settingsServerState :: Maybe ServerStateInternal read-only server state. Use makeSettingsAndServerState to gain access to the state of the server. Using functions like currentOpenConnections or currentShuttingDownState to gain insight into the current state of the server.
Default: Nothing (warp creates its own internal state)