Safe Haskell	None
Language	Haskell2010

Network.Wai.Handler.Warp.Internal

Contents

Settings
- Connection counter
- Server state
Low level run functions
- Stopping the accept loop
Connection
Version
Data types
Time out manager
File descriptor cache
File information cache
Date
Request and response
Platform dependent helper functions
Misc

Description

IMPORTANT NOTICE

This module exports internals mainly to provide the warp-tls package with tools to implement what it needs to. This module/API should NOT be expected to remain stable at all, even between minor releases.

If you see a use case for these functions or types for other purposes, please create an issue in the repository so that we might add it to the main Warp API.

Synopsis

data Settings = Settings {
- settingsPort :: Port
- settingsHost :: HostPreference
- settingsOnException :: Maybe Request -> SomeException -> IO ()
- settingsOnConnectionException :: Maybe (SockAddr -> SomeException -> IO ())
- settingsOnExceptionResponse :: SomeException -> Response
- settingsOnOpen :: SockAddr -> IO Bool
- settingsOnClose :: SockAddr -> IO ()
- settingsTimeout :: Int
- settingsManager :: Maybe Manager
- settingsFdCacheDuration :: Int
- settingsFileInfoCacheDuration :: Int
- settingsBeforeMainLoop :: IO ()
- settingsFork :: ((forall a. IO a -> IO a) -> IO ()) -> IO ()
- settingsAccept :: Socket -> IO (Socket, SockAddr)
- settingsNoParsePath :: Bool
- settingsInstallShutdownHandler :: IO () -> IO ()
- settingsServerName :: ByteString
- settingsMaximumBodyFlush :: Maybe Int
- settingsProxyProtocol :: ProxyProtocol
- settingsSlowlorisSize :: Int
- settingsHTTP2Enabled :: Bool
- settingsLogger :: Request -> Status -> Maybe Integer -> IO ()
- settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()
- settingsGracefulShutdownTimeout :: Maybe Int
- settingsGracefulCloseTimeout1 :: Int
- settingsGracefulCloseTimeout2 :: Int
- settingsMaxTotalHeaderLength :: Int
- settingsAltSvc :: Maybe ByteString
- settingsMaxBuilderResponseBufferSize :: Int
- settingsConnectionCounter :: Maybe Counter
- settingsServerState :: Maybe ServerState
}
data ProxyProtocol
- = ProxyProtocolNone
- | ProxyProtocolRequired
- | ProxyProtocolOptional
makeSettingsAndCounter :: IO (Counter, Settings)
makeSettingsAndServerState :: IO (ServerState, Settings)
data Counter
getCount :: Counter -> IO Int
data ServerState
makeServerState :: Settings -> IO (ServerState, Settings)
runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO ()
runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO ()
runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO ()
runSettingsConnectionMakerSecureWith :: Settings -> Listener -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO ()
data Transport
- = TCP
- | TLS {
  - tlsMajorVersion :: Int
  - tlsMinorVersion :: Int
  - tlsNegotiatedProtocol :: Maybe ByteString
  - tlsChiperID :: Word16
  - tlsClientCertificate :: Maybe CertificateChain
  }
- | QUIC {
  }
data Listener = Listener {
- acceptOrStop :: IO (Maybe (Socket, SockAddr))
- closeListener :: IO ()
}
noListener :: Listener
makeListener :: Settings -> Socket -> IO Listener
data AcceptStopped = AcceptStopped
data Connection = Connection {
- connSendMany :: [ByteString] -> IO ()
- connSendAll :: ByteString -> IO ()
- connSendFile :: SendFile
- connClose :: IO ()
- connRecv :: Recv
- connRecvBuf :: RecvBuf
- connWriteBuffer :: IORef WriteBuffer
- connHTTP2 :: IORef Bool
- connMySockAddr :: SockAddr
- connAppsInProgress :: TVar Int
}
socketConnection :: Settings -> Socket -> IO Connection
type Recv = IO ByteString
makeGracefulRecv :: Socket -> BufferPool -> ServerState -> TVar Int -> Recv
type RecvBuf = Buffer -> BufSize -> IO Bool
type Buffer = Ptr Word8
type BufSize = Int
data WriteBuffer = WriteBuffer {
- bufBuffer :: Buffer
- bufSize :: !BufSize
- bufFree :: IO ()
}
createWriteBuffer :: BufSize -> IO WriteBuffer
allocateBuffer :: Int -> IO Buffer
freeBuffer :: Buffer -> IO ()
copy :: Buffer -> ByteString -> IO Buffer
data FileId = FileId {
- fileIdPath :: FilePath
- fileIdFd :: Maybe Fd
}
type SendFile = FileId -> Integer -> Integer -> IO () -> [ByteString] -> IO ()
sendFile :: Socket -> Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
readSendFile :: Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
warpVersion :: String
data InternalInfo = InternalInfo {
- timeoutManager :: Manager
- getDate :: IO GMTDate
- getFd :: FilePath -> IO (Maybe Fd, Refresh)
- getFileInfo :: FilePath -> IO FileInfo
}
type HeaderValue = ByteString
type IndexedHeader = IndexedRequestHeader
defaultIndexRequestHeader :: IndexedRequestHeader
module System.TimeManager
openFile :: FilePath -> IO Fd
data Fd
closeFile :: Fd -> IO ()
withFdCache :: Int -> ((FilePath -> IO (Maybe Fd, Refresh)) -> IO a) -> IO a
type Refresh = IO ()
setFileCloseOnExec :: Fd -> IO ()
data FileInfo = FileInfo {
- fileInfoName :: !FilePath
- fileInfoSize :: !Integer
- fileInfoTime :: HTTPDate
- fileInfoDate :: ByteString
}
withFileInfoCache :: Int -> ((FilePath -> IO FileInfo) -> IO a) -> IO a
getInfo :: FilePath -> IO FileInfo
withDateCache :: (IO GMTDate -> IO a) -> IO a
type GMTDate = ByteString
data Source
data FirstRequest
- = FirstRequest
- | SubsequentRequest
recvRequest :: FirstRequest -> Settings -> Connection -> InternalInfo -> Handle -> SockAddr -> Source -> Transport -> IO (Request, Maybe (IORef Int), IndexedRequestHeader, IO ByteString)
sendResponse :: Settings -> Connection -> InternalInfo -> Handle -> Request -> IndexedRequestHeader -> IO ByteString -> Response -> IO Bool
setSocketCloseOnExec :: Socket -> IO ()
windowsThreadBlockHack :: IO a -> IO a
http2server :: String -> Settings -> InternalInfo -> Transport -> SockAddr -> Application -> Server
withII :: Settings -> (InternalInfo -> IO a) -> IO a
serveConnection :: Connection -> InternalInfo -> Handle -> SockAddr -> Transport -> Settings -> Application -> IO ()
pReadMaker :: InternalInfo -> PositionReadMaker

Settings

data Settings Source #

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

Constructors

Settings

Fields

settingsPort :: Port
Port to listen on. Default value: 3000
settingsHost :: HostPreference
Default 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 -> Response
A function to create Response when an exception occurs.
Default: 500, text/plain, "Something went wrong"
Since: 2.0.3
settingsOnOpen :: SockAddr -> IO Bool
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.
settingsOnClose :: SockAddr -> IO ()
What to do when a connection is close. Default: do nothing.
settingsTimeout :: Int
Timeout value in seconds. Default value: 30
settingsManager :: Maybe Manager
Use an existing timeout manager instead of spawning a new one. If used, settingsTimeout is ignored. Default is Nothing
settingsFdCacheDuration :: Int
Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 0
settingsFileInfoCacheDuration :: Int
Cache 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.
Since: 1.3.6
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: defaultFork
Since: 3.0.4
settingsAccept :: 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: defaultAccept
Since: 3.3.24
settingsNoParsePath :: Bool
Perform no parsing on the rawPathInfo.
This is useful for writing HTTP proxies.
Default: False
Since: 2.0.3
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
Since: 3.0.1
settingsServerName :: ByteString
Default server name if application does not set one.
Since: 3.0.2
settingsMaximumBodyFlush :: Maybe Int
See setMaximumBodyFlush.
Since: 3.0.3
settingsProxyProtocol :: ProxyProtocol
Specify usage of the PROXY protocol.
Since: 3.0.5
settingsSlowlorisSize :: Int
Size of bytes read to prevent Slowloris protection. Default value: 2048
Since: 3.1.2
settingsHTTP2Enabled :: Bool
Whether to enable HTTP2 ALPN/upgrades. Default: True
Since: 3.1.7
settingsLogger :: Request -> Status -> Maybe Integer -> IO ()
A log function. Default: no action.
```
settingsLogger req status mSentBytes
```
N.B. Maybe Integer is 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)
Since: 3.1.10
settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()
A HTTP/2 server push log function. Default: no action.
Since: 3.2.7
settingsGracefulShutdownTimeout :: Maybe Int
An optional timeout to limit the time (in seconds) waiting for a graceful shutdown of the web server.
Since: 3.2.8
settingsGracefulCloseTimeout1 :: Int
A timeout to limit the time (in milliseconds) waiting for FIN for HTTP/1.x. 0 means uses immediate close. Default: 0.
Since: 3.3.5
settingsGracefulCloseTimeout2 :: Int
A timeout to limit the time (in milliseconds) waiting for FIN for HTTP/2. 0 means uses immediate close. Default: 2000.
Since: 3.3.5
settingsMaxTotalHeaderLength :: Int
Determines the maximum header size that Warp will tolerate when using HTTP/1.x.
Since: 3.3.8
settingsAltSvc :: Maybe ByteString
Specify the header value of Alternative Services (AltSvc:).
Default: Nothing
Since: 3.3.11
settingsMaxBuilderResponseBufferSize :: Int
Determines the maxium buffer size when sending Builder responses (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.
Since: 3.3.22
settingsConnectionCounter :: Maybe Counter
A 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
Since: 3.4.11
settingsServerState :: Maybe ServerState
Internal 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)
Since: 3.4.13

data ProxyProtocol Source #

Specify usage of the PROXY protocol.

Constructors

ProxyProtocolNone	See `setProxyProtocolNone`.
ProxyProtocolRequired	See `setProxyProtocolRequired`.
ProxyProtocolOptional	See `setProxyProtocolOptional`.

makeSettingsAndCounter :: IO (Counter, Settings) Source #

Create defaultSettings with a connection counter. Use getCount on the returned Counter to check open connections.

DEPRECATED in favor of makeSettingsAndServerState

Since: 3.4.11

makeSettingsAndServerState :: IO (ServerState, Settings) Source #

Create defaultSettings with a ServerState. Use functions like currentOpenConnections and currentShuttingDownState to gain insight into the state of the server.

Since: 3.4.13

Connection counter

data Counter Source #

The connections of a server: how many there are, and which threads are serving them.

Both come from the ThreadManager, which counts a connection from when the accept loop keeps a place for it -- before the thread that will serve it has been scheduled, which is too late for a graceful shutdown to notice it.

getCount :: Counter -> IO Int Source #

Get the current count of open connections.

Since: 3.4.11

Server state

data ServerState Source #

Internal read-only state of the server

Since: 3.4.13

makeServerState :: Settings -> IO (ServerState, Settings) Source #

Takes Settings and either returns the ServerState that was already in there, or creates a new ServerState.

The returned Settings will always contain a ServerState.

This makes it idempotent if care is taken that the oldSettings are not used after using this function.

Since: 3.4.13

Low level run functions

runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO () Source #

The connection setup action would be expensive. A good example is initialization of TLS. So, this converts the connection setup action to the connection maker which will be executed after forking a new worker thread. Then this calls runSettingsConnectionMaker with the connection maker. This allows the expensive computations to be performed in a separate worker thread instead of the main server loop.

Since: 1.3.5

runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO () Source #

This modifies the connection maker so that it returns TCP for Transport (i.e. plain HTTP) then calls runSettingsConnectionMakerSecure.

runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO () Source #

The core run function which takes Settings, a connection maker and Application. The connection maker can return a connection of either plain HTTP or HTTP over TLS.

Since: 2.1.4

runSettingsConnectionMakerSecureWith :: Settings -> Listener -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO () Source #

runSettingsConnectionMakerSecure for a caller that has the listening socket, and so can say how the accept loop waits on it and what becomes of it when the loop stops.

data Transport Source #

What kind of transport is used for this connection?

Constructors

TCP	Plain channel: TCP
TLS
Fields tlsMajorVersion :: Int tlsMinorVersion :: Int tlsNegotiatedProtocol :: Maybe ByteString The result of Application Layer Protocol Negociation in RFC 7301 tlsChiperID :: Word16 Encrypted channel: TLS or SSL tlsClientCertificate :: Maybe CertificateChain
QUIC
Fields quicNegotiatedProtocol :: Maybe ByteString quicChiperID :: Word16 quicClientCertificate :: Maybe CertificateChain

Stopping the accept loop

data Listener Source #

What the accept loop waits on at the top of each turn, and what it leaves behind when it stops.

A server used to be stopped by closing the listening socket under the thread waiting in accept on it. That takes an IO manager that can wake a thread out of a wait by closing the file descriptor under it, which is what closeFdWith is for, and the IO manager that provides it is not the only one there will be. So the loop waits for the socket and for the shutdown at once and ends on whichever comes first; the socket is closed after it, by which time nothing is waiting on it.

Constructors

Listener

Fields

acceptOrStop :: IO (Maybe (Socket, SockAddr))
Accepts a connection. Nothing instead once the server has been asked to stop: giving up has to be composed with the accept itself, so the accept belongs here rather than beside it.
closeListener :: IO ()
Run once the accept loop has ended and before the connections are waited for: the port is a successor's to take, and a successor should not have to wait out someone else's drain for it.

noListener :: Listener Source #

For a caller that handed warp a connection maker and no socket. There is nothing here to accept and nothing to close, and such a server ends the way it always did: by whatever its maker accepts on being closed.

makeListener :: Settings -> Socket -> IO Listener Source #

data AcceptStopped Source #

Thrown by a connection maker which was told to stop rather than handed a connection, and caught by the accept loop. A maker has to return a connection or throw, so this is how it says that there will not be one.

Constructors

AcceptStopped

Instances

Instances details

Exception AcceptStopped Source #
Instance details Defined in Network.Wai.Handler.Warp.Run Methods toException :: AcceptStopped -> SomeException # fromException :: SomeException -> Maybe AcceptStopped # displayException :: AcceptStopped -> String #
Show AcceptStopped Source #
Instance details Defined in Network.Wai.Handler.Warp.Run Methods showsPrec :: Int -> AcceptStopped -> ShowS # show :: AcceptStopped -> String # showList :: [AcceptStopped] -> ShowS #

Connection

data Connection Source #

Data type to manipulate IO actions for connections. This is used to abstract IO actions for plain HTTP and HTTP over TLS.

Constructors

Connection

Fields

connSendMany :: [ByteString] -> IO ()
This is not used at this moment.
connSendAll :: ByteString -> IO ()
The sending function.
connSendFile :: SendFile
The sending function for files in HTTP/1.1.
connClose :: IO ()
The connection closing function. Warp guarantees it will only be called once. Other functions (like connRecv) may be called after connClose is called.
connRecv :: Recv
The connection receiving function. This returns "" for EOF or exceptions.
connRecvBuf :: RecvBuf
Obsoleted.
connWriteBuffer :: IORef WriteBuffer
Reference to a write buffer. When during sending of a Builder response it's detected the current WriteBuffer is too small it will be freed and a new bigger buffer will be created and written to this reference.
connHTTP2 :: IORef Bool
Is this connection HTTP/2?
connMySockAddr :: SockAddr
connAppsInProgress :: TVar Int
Amount of apps currently in progress on this connection.
HTTP2 can handle more than one request concurrently
Since: 3.4.13

socketConnection :: Settings -> Socket -> IO Connection Source #

Creating Connection for plain HTTP based on a given socket.

(N.B. make sure the Settings have an initialized ServerState to guarantee a graceful shutdown)

Receive

type Recv = IO ByteString #

Type for the receiving function with a buffer pool.

makeGracefulRecv :: Socket -> BufferPool -> ServerState -> TVar Int -> Recv Source #

Create a Recv which stops receiving when the server is shutting down and no Application is still using this Socket.

Nothing is closed and no thread is interrupted to make it return: the read and the shutdown are waited for at once, inside receiveWith.

type RecvBuf = Buffer -> BufSize -> IO Bool Source #

Buffer

type Buffer = Ptr Word8 #

Type for buffer.

type BufSize = Int #

Type for buffer size.

data WriteBuffer Source #

A write buffer of a specified size containing bytes and a way to free the buffer.

Constructors

WriteBuffer
Fields bufBuffer :: Buffer bufSize :: !BufSize The size of the write buffer. bufFree :: IO () Free the allocated buffer. Warp guarantees it will only be called once, and no other functions will be called after it.

createWriteBuffer :: BufSize -> IO WriteBuffer Source #

Allocate a buffer of the given size and wrap it in a WriteBuffer containing that size and a finalizer.

allocateBuffer :: Int -> IO Buffer Source #

Allocating a buffer with malloc().

freeBuffer :: Buffer -> IO () Source #

Releasing a buffer with free().

copy :: Buffer -> ByteString -> IO Buffer #

Copying the bytestring to the buffer. This function returns the point where the next copy should start.

Sendfile

data FileId Source #

Data type to abstract file identifiers. On Unix, a file descriptor would be specified to make use of the file descriptor cache.

Since: 3.1.0

Constructors

FileId
Fields fileIdPath :: FilePath fileIdFd :: Maybe Fd

type SendFile = FileId -> Integer -> Integer -> IO () -> [ByteString] -> IO () Source #

fileid, offset, length, hook action, HTTP headers

Since: 3.1.0

sendFile :: Socket -> Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile Source #

Function to send a file based on sendfile() for Linux/Mac/FreeBSD. This makes use of the file descriptor cache. For other OSes, this is identical to readSendFile.

Since: 3.1.0

readSendFile :: Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile Source #

Function to send a file based on pread()/send() for Unix. This makes use of the file descriptor cache. For Windows, this is emulated by Handle.

Since: 3.1.0

Version

warpVersion :: String Source #

The version of Warp.

Data types

The internals of IndexedHeader have changed since 3.4.15, so we keep exporting it as a type synonym, but it is now a record instead of an array. As such there's no more requestMaxIndex, but we provide a blank defaultIndexRequestHeader.

data InternalInfo Source #

Constructors

InternalInfo
Fields timeoutManager :: Manager getDate :: IO GMTDate getFd :: FilePath -> IO (Maybe Fd, Refresh) getFileInfo :: FilePath -> IO FileInfo

type HeaderValue = ByteString Source #

The type for header value used with HeaderName.

type IndexedHeader = IndexedRequestHeader Source #

defaultIndexRequestHeader :: IndexedRequestHeader Source #

IndexedRequestHeader with no headers set.

Time out manager

In order to provide slowloris protection, Warp provides timeout handlers. We follow these rules:

A timeout is created when a connection is opened.
When all request headers are read, the timeout is tickled.
Every time at least the slowloris size settings number of bytes of the request body are read, the timeout is tickled.
The timeout is paused while executing user code. This will apply to both the application itself, and a ResponseSource response. The timeout is resumed as soon as we return from user code.
Every time data is successfully sent to the client, the timeout is tickled.

module System.TimeManager

File descriptor cache

openFile :: FilePath -> IO Fd Source #

data Fd #

Instances

Instances details

Storable Fd
Instance details Defined in System.Posix.Types Methods sizeOf :: Fd -> Int # alignment :: Fd -> Int # peekElemOff :: Ptr Fd -> Int -> IO Fd # pokeElemOff :: Ptr Fd -> Int -> Fd -> IO () # peekByteOff :: Ptr b -> Int -> IO Fd # pokeByteOff :: Ptr b -> Int -> Fd -> IO () # peek :: Ptr Fd -> IO Fd # poke :: Ptr Fd -> Fd -> IO () #
Bits Fd
Instance details Defined in System.Posix.Types Methods (.&.) :: Fd -> Fd -> Fd # (.\|.) :: Fd -> Fd -> Fd # xor :: Fd -> Fd -> Fd # complement :: Fd -> Fd # shift :: Fd -> Int -> Fd # rotate :: Fd -> Int -> Fd # zeroBits :: Fd # bit :: Int -> Fd # setBit :: Fd -> Int -> Fd # clearBit :: Fd -> Int -> Fd # complementBit :: Fd -> Int -> Fd # testBit :: Fd -> Int -> Bool # bitSizeMaybe :: Fd -> Maybe Int # bitSize :: Fd -> Int # isSigned :: Fd -> Bool # shiftL :: Fd -> Int -> Fd # unsafeShiftL :: Fd -> Int -> Fd # shiftR :: Fd -> Int -> Fd # unsafeShiftR :: Fd -> Int -> Fd # rotateL :: Fd -> Int -> Fd # rotateR :: Fd -> Int -> Fd # popCount :: Fd -> Int #
FiniteBits Fd
Instance details Defined in System.Posix.Types Methods finiteBitSize :: Fd -> Int # countLeadingZeros :: Fd -> Int # countTrailingZeros :: Fd -> Int #
Bounded Fd
Instance details Defined in System.Posix.Types Methods minBound :: Fd # maxBound :: Fd #
Enum Fd
Instance details Defined in System.Posix.Types Methods succ :: Fd -> Fd # pred :: Fd -> Fd # toEnum :: Int -> Fd # fromEnum :: Fd -> Int # enumFrom :: Fd -> [Fd] # enumFromThen :: Fd -> Fd -> [Fd] # enumFromTo :: Fd -> Fd -> [Fd] # enumFromThenTo :: Fd -> Fd -> Fd -> [Fd] #
Ix Fd
Instance details Defined in System.Posix.Types Methods range :: (Fd, Fd) -> [Fd] # index :: (Fd, Fd) -> Fd -> Int # unsafeIndex :: (Fd, Fd) -> Fd -> Int # inRange :: (Fd, Fd) -> Fd -> Bool # rangeSize :: (Fd, Fd) -> Int # unsafeRangeSize :: (Fd, Fd) -> Int #
Num Fd
Instance details Defined in System.Posix.Types Methods (+) :: Fd -> Fd -> Fd # (-) :: Fd -> Fd -> Fd # (*) :: Fd -> Fd -> Fd # negate :: Fd -> Fd # abs :: Fd -> Fd # signum :: Fd -> Fd # fromInteger :: Integer -> Fd #
Read Fd
Instance details Defined in System.Posix.Types Methods readsPrec :: Int -> ReadS Fd # readList :: ReadS [Fd] # readPrec :: ReadPrec Fd # readListPrec :: ReadPrec [Fd] #
Integral Fd
Instance details Defined in System.Posix.Types Methods quot :: Fd -> Fd -> Fd # rem :: Fd -> Fd -> Fd # div :: Fd -> Fd -> Fd # mod :: Fd -> Fd -> Fd # quotRem :: Fd -> Fd -> (Fd, Fd) # divMod :: Fd -> Fd -> (Fd, Fd) # toInteger :: Fd -> Integer #
Real Fd
Instance details Defined in System.Posix.Types Methods toRational :: Fd -> Rational #
Show Fd
Instance details Defined in System.Posix.Types Methods showsPrec :: Int -> Fd -> ShowS # show :: Fd -> String # showList :: [Fd] -> ShowS #
Eq Fd
Instance details Defined in System.Posix.Types Methods (==) :: Fd -> Fd -> Bool # (/=) :: Fd -> Fd -> Bool #
Ord Fd
Instance details Defined in System.Posix.Types Methods compare :: Fd -> Fd -> Ordering # (<) :: Fd -> Fd -> Bool # (<=) :: Fd -> Fd -> Bool # (>) :: Fd -> Fd -> Bool # (>=) :: Fd -> Fd -> Bool # max :: Fd -> Fd -> Fd # min :: Fd -> Fd -> Fd #

closeFile :: Fd -> IO () Source #

withFdCache :: Int -> ((FilePath -> IO (Maybe Fd, Refresh)) -> IO a) -> IO a Source #

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

type Refresh = IO () Source #

An action to activate a Fd cache entry.

setFileCloseOnExec :: Fd -> IO () Source #

File information cache

data FileInfo Source #

File information.

Constructors

FileInfo
Fields fileInfoName :: !FilePath fileInfoSize :: !Integer fileInfoTime :: HTTPDate Modification time fileInfoDate :: ByteString Modification time in the GMT format

Instances

Instances details

Show FileInfo Source #
Instance details Defined in Network.Wai.Handler.Warp.FileInfoCache Methods showsPrec :: Int -> FileInfo -> ShowS # show :: FileInfo -> String # showList :: [FileInfo] -> ShowS #
Eq FileInfo Source #
Instance details Defined in Network.Wai.Handler.Warp.FileInfoCache Methods (==) :: FileInfo -> FileInfo -> Bool # (/=) :: FileInfo -> FileInfo -> Bool #

withFileInfoCache :: Int -> ((FilePath -> IO FileInfo) -> IO a) -> IO a Source #

Creating a file information cache and executing the action in the second argument. The first argument is a cache duration in microseconds.

getInfo :: FilePath -> IO FileInfo Source #

Getting the file information corresponding to the file.

Date

withDateCache :: (IO GMTDate -> IO a) -> IO a Source #

Creating DateCache and executing the action.

type GMTDate = ByteString Source #

The type of the Date header value.

Request and response

data Source Source #

Type for input streaming.

Caveat: a Source is meant to be used in one thread only.

data FirstRequest Source #

first request on this connection?

Constructors

FirstRequest
SubsequentRequest

recvRequest Source #

Arguments

:: FirstRequest
-> Settings
-> Connection
-> InternalInfo
-> Handle
-> SockAddr	Peer's address.
-> Source	Where HTTP request comes from.
-> Transport
-> IO (Request, Maybe (IORef Int), IndexedRequestHeader, IO ByteString)	`Request` passed to `Application`, how many bytes remain to be consumed, if known `IndexedHeader` of HTTP request for internal use, Body producing action used for flushing the request body

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

sendResponse Source #

Arguments

:: Settings
-> Connection
-> InternalInfo
-> Handle
-> Request	HTTP request.
-> IndexedRequestHeader	Indexed header of HTTP request.
-> IO ByteString	source from client, for raw response
-> Response	HTTP response including status code and response header.
-> IO Bool	Returing True if the connection is persistent.

Sending a HTTP response to Connection according to Response.

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

Especially, Applications/middlewares MUST provide a proper Content-Type. They MUST NOT provide 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:

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.
responseFile :: Status -> ResponseHeaders -> FilePath -> Maybe FilePart -> Response: HTTP response body is sent (by sendfile(), if possible) for GET method. HTTP response body is not sent by HEAD method. Content-Length and Content-Range are automatically added into the HTTP response header if necessary. If Content-Length and Content-Range exist in the HTTP response header, they would cause inconsistency. "Accept-Ranges: bytes" is also inserted.

Applications are categorized into simple and sophisticated. Sophisticated applications should specify Just to Maybe FilePart. They should treat the conditional request by themselves. A proper Status (200 or 206) must be provided.

Simple applications should specify Nothing to Maybe FilePart. The size of the specified file is obtained by disk access or from the file info cache. If-Modified-Since, If-Unmodified-Since, If-Range and Range are processed. Since a proper status is chosen, Status is ignored. Last-Modified is inserted.

Platform dependent helper functions

setSocketCloseOnExec :: Socket -> IO () Source #

Set flag FileCloseOnExec flag on a socket (on Unix)

Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs

Since: 3.2.17

windowsThreadBlockHack :: IO a -> IO a Source #

Misc

http2server :: String -> Settings -> InternalInfo -> Transport -> SockAddr -> Application -> Server Source #

Converting WAI application to the server type of http2 library.

Since: 3.3.11

withII :: Settings -> (InternalInfo -> IO a) -> IO a Source #

Running an action with internal info.

Since: 3.3.11

serveConnection :: Connection -> InternalInfo -> Handle -> SockAddr -> Transport -> Settings -> Application -> IO () Source #

pReadMaker :: InternalInfo -> PositionReadMaker Source #

PositionReadMaker based on file descriptor cache.

Since: 3.3.13