Run an Application on the given port. This calls runSettings with defaultSettings.

Run an Application on the port present in the PORT environment variable

Uses the Port given when the variable is unset.

Since 3.0.9

Run an Application with the given Settings.

Same as runSettings, but uses a user-supplied socket instead of opening one. This allows the user to provide, for example, Unix named socket, which can be used when reverse HTTP proxying into your application.

Note that the settingsPort will still be passed to Applications via the serverPort record.

When the listen socket in the second argument is closed, all live connections are gracefully shut down.

Allows you to provide a function which will return a Connection. In cases where creating the Connection can be expensive, this allows the expensive computations to be performed in a separate thread instead of the main server loop.

Since 1.3.5

Allows you to provide a function which will return a function which will return Connection.

Since 2.1.4

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 defaultSettings

The default settings for the Warp server. See the individual settings for the default value.

Port to listen on. Default value: 3000

Since 2.1.0

Interface to bind to. Default value: HostIPv4

Since 2.1.0

What to do with exceptions thrown by either the application or server. Default: ignore server-generated exceptions (see InvalidRequest) and print application-generated exceptions to stderr.

Since 2.1.0

A function to create a Response when an exception occurs.

Default: 500, text/plain, "Something went wrong"

Since 2.1.0

What to do when a connection is opened. When False is returned, the connection is closed immediately. Otherwise, the connection is going on. Default: always returns True.

Since 2.1.0

What to do when a connection is closed. Default: do nothing.

Since 2.1.0

Timeout value in seconds. Default value: 30

Since 2.1.0

Use an existing timeout manager instead of spawning a new one. If used, settingsTimeout is ignored.

Since 2.1.0

Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used.

The FD cache is an optimization that is useful for servers dealing with static files. However, if files are being modified, it can cause incorrect results in some cases. Therefore, we disable it by default. If you know that your files will be static or you prefer performance to file consistency, it's recommended to turn this on; a reasonable value for those cases is 10. Enabling this cache results in drastic performance improvement for file transfers.

Default value: since 3.0.13, default value is 0, was previously 10

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.

Since 2.1.0

Perform no parsing on the rawPathInfo.

This is useful for writing HTTP proxies.

Default: False

Since 2.1.0

A code to install shutdown handler.

For instance, this code should set up a UNIX signal handler. The handler should call the first argument, which close the listen socket, at shutdown.

Default: does not install any code.

Since 3.0.1

Default server name if application does not set one.

Since 3.0.2

The maximum number of bytes to flush from an unconsumed request body.

By default, Warp does not flush the request body so that, if a large body is present, the connection is simply terminated instead of wasting time and bandwidth on transmitting it. However, some clients do not deal with that situation well. You can either change this setting to Nothing to flush the entire body in all cases, or in your application ensure that you always consume the entire request body.

Default: 8192 bytes.

Since 3.0.3

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: void . forkIOWithUnmask

Since 3.0.4

Do not use the PROXY protocol.

Since 3.0.5

Require PROXY header.

This is for cases where a "dumb" TCP/SSL proxy is being used, which cannot add an X-Forwarded-For HTTP header field but has enabled support for the PROXY protocol.

See http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt and http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol.

Only the human-readable header format (version 1) is supported. The binary header format (version 2) is not supported.

Since 3.0.5

Use the PROXY header if it exists, but also accept connections without the header. See setProxyProtocolRequired.

WARNING: This is contrary to the PROXY protocol specification and using it can indicate a security problem with your architecture if the web server is directly accessable to the public, since it would allow easy IP address spoofing. However, it can be useful in some cases, such as if a load balancer health check uses regular HTTP without the PROXY header, but proxied connections do include the PROXY header.

Since 3.0.5

Get the listening port.

Since 2.1.1

Get the interface to bind to.

Since 2.1.1

Port to listen on. Default value: 3000

Default value: HostIPv4

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.

A function to create Response when an exception occurs.

Default: 500, text/plain, "Something went wrong"

Since 2.0.3

What to do when a connection is open. When False is returned, the connection is closed immediately. Otherwise, the connection is going on. Default: always returns True.

What to do when a connection is close. Default: do nothing.

Timeout value in seconds. Default value: 30

Use an existing timeout manager instead of spawning a new one. If used, settingsTimeout is ignored. Default is Nothing

Cache duratoin time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 0

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.

Since 1.3.6

Perform no parsing on the rawPathInfo.

This is useful for writing HTTP proxies.

Default: False

Since 2.0.3

Default implementation of settingsOnExceptionResponse for the debugging purpose. 500, text/plain, a showed exception.

Apply the logic provided by defaultExceptionHandler to determine if an exception should be shown or not. The goal is to hide exceptions which occur under the normal course of the web server running.

Since 2.1.3

What kind of transport is used for this connection?

TCP port number.

Error types for bad Request.

Whether or not ConnSendFileOverride in Connection can be overridden. This is a kind of hack to keep the signature of Connection clean.

Explicitly pause the slowloris timeout.

This is useful for cases where you partially consume a request body. For more information, see https://github.com/yesodweb/wai/issues/351

Since 3.0.10

Data type to manipulate IO actions for connections.

Default action value for Connection.

The version of Warp.

Internal information.

The type for header value used with HeaderName.

Array for a set of HTTP headers.

The size for IndexedHeader for HTTP Request. From 0 to this corresponds to "Content-Length", "Transfer-Encoding", "Expect", "Connection", "Range", and "Host".

Creating MutableFdCache and executing the action in the second argument. The first argument is a cache duration in second.

Getting Fd and Refresh from the mutable Fd cacher.

Mutable Fd cacher.

An action to activate a Fd cache entry.

Creating DateCache and executing the action.

Getting GMTDate based on DateCache.

The type of the cache of the Date header value.

The type of the Date header value.

Receiving a HTTP request from Connection and parsing its header to create Request.

Sending a HTTP response to Connection according to Response.

Applications/middlewares MUST specify a proper ResponseHeaders. so that inconsistency does not happen. No header is deleted by this function.

Especially, Applications/middlewares MUST take care of Content-Length, Content-Range, and Transfer-Encoding because they are inserted, when necessary, regardless they already exist. This function does not insert Content-Encoding. It's middleware's responsibility.

The Date and Server header is added if not exist in HTTP response header.

There are three basic APIs to create Response:

responseFile :: Status -> ResponseHeaders -> FilePath -> Maybe FilePart -> Response

HTTP response body is sent by sendfile() for GET method. HTTP response body is not sent by HEAD method. Applications are categorized into simple and sophisticated. Simple applications should specify Nothing to Maybe FilePart. The size of the specified file is obtained by disk access. Then Range is handled. Sophisticated applications should specify Just to Maybe FilePart. They should treat Range (and If-Range) by themselves. In both cases, Content-Length and Content-Range (if necessary) are automatically added into the HTTP response header. If Content-Length and Content-Range exist in the HTTP response header, they would cause inconsistency. Status is also changed to 206 (Partial Content) if necessary.

responseBuilder :: Status -> ResponseHeaders -> Builder -> Response

HTTP response body is created from Builder. Transfer-Encoding: chunked is used in HTTP/1.1.

responseStream :: Status -> ResponseHeaders -> StreamingBody -> Response

HTTP response body is created from Builder. Transfer-Encoding: chunked is used in HTTP/1.1.

responseRaw :: (IO ByteString -> (ByteString -> IO ()) -> IO ()) -> Response -> Response

No header is added and no Transfer-Encoding: is applied.