Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.HTTP2.TLS.Server

Contents

Runners
Settings
IO backend
Internal

Synopsis

run :: Settings -> Credentials -> HostName -> PortNumber -> Server -> IO ()
runH2C :: Settings -> HostName -> PortNumber -> Server -> IO ()
type Server = Request -> Aux -> (Response -> [PushPromise] -> IO ()) -> IO ()
type HostName = String
data PortNumber
runTLS :: Settings -> Credentials -> HostName -> PortNumber -> ByteString -> (Manager -> IOBackend -> IO a) -> IO a
data Settings
defaultSettings :: Settings
settingsTimeout :: Settings -> Int
settingsSendBufferSize :: Settings -> Int
settingsSlowlorisSize :: Settings -> Int
settingsReadBufferSize :: Settings -> Int
settingsReadBufferLowerLimit :: Settings -> Int
settingsKeyLogger :: Settings -> String -> IO ()
settingsNumberOfWorkers :: Settings -> Int
settingsConcurrentStreams :: Settings -> Int
settingsConnectionWindowSize :: Settings -> Int
settingsStreamWindowSize :: Settings -> Int
settingsSessionManager :: Settings -> SessionManager
settingsOpenServerSocket :: Settings -> AddrInfo -> IO Socket
data IOBackend
send :: IOBackend -> ByteString -> IO ()
sendMany :: IOBackend -> [ByteString] -> IO ()
recv :: IOBackend -> IO ByteString
mySockAddr :: IOBackend -> SockAddr
peerSockAddr :: IOBackend -> SockAddr
runIO :: Settings -> Credentials -> HostName -> PortNumber -> (ServerIO -> IO (IO ())) -> IO ()
runIOH2C :: Settings -> HostName -> PortNumber -> (ServerIO -> IO (IO ())) -> IO ()
data Stream
data ServerIO = ServerIO {
- sioMySockAddr :: SockAddr
- sioPeerSockAddr :: SockAddr
- sioReadRequest :: IO (StreamId, Stream, Request)
- sioWriteResponse :: Stream -> Response -> IO ()
- sioWriteBytes :: ByteString -> IO ()
}

Runners

run :: Settings -> Credentials -> HostName -> PortNumber -> Server -> IO () Source #

Running an HTTP/2 client over TLS (over TCP). ALPN is "h2".

runH2C :: Settings -> HostName -> PortNumber -> Server -> IO () Source #

Running an HTTP/2 client over TCP.

type Server = Request -> Aux -> (Response -> [PushPromise] -> IO ()) -> IO () #

Server type. Server takes a HTTP request, should generate a HTTP response and push promises, then should give them to the sending function. The sending function would throw exceptions so that they can be logged.

type HostName = String #

Either a host name e.g., "haskell.org" or a numeric host address string consisting of a dotted decimal IPv4 address or an IPv6 address e.g., "192.168.0.1".

data PortNumber #

Port number. Use the Num instance (i.e. use a literal) to create a PortNumber value.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1
>>> show (12345 :: PortNumber)
"12345"
>>> 50000 < (51000 :: PortNumber)
True
>>> 50000 < (52000 :: PortNumber)
True
>>> 50000 + (10000 :: PortNumber)
60000

Instances

Instances details

Storable PortNumber
Instance details Defined in Network.Socket.Types Methods sizeOf :: PortNumber -> Int # alignment :: PortNumber -> Int # peekElemOff :: Ptr PortNumber -> Int -> IO PortNumber # pokeElemOff :: Ptr PortNumber -> Int -> PortNumber -> IO () # peekByteOff :: Ptr b -> Int -> IO PortNumber # pokeByteOff :: Ptr b -> Int -> PortNumber -> IO () # peek :: Ptr PortNumber -> IO PortNumber # poke :: Ptr PortNumber -> PortNumber -> IO () #
Bounded PortNumber
Instance details Defined in Network.Socket.Types Methods minBound :: PortNumber # maxBound :: PortNumber #
Enum PortNumber
Instance details Defined in Network.Socket.Types Methods succ :: PortNumber -> PortNumber # pred :: PortNumber -> PortNumber # toEnum :: Int -> PortNumber # fromEnum :: PortNumber -> Int # enumFrom :: PortNumber -> [PortNumber] # enumFromThen :: PortNumber -> PortNumber -> [PortNumber] # enumFromTo :: PortNumber -> PortNumber -> [PortNumber] # enumFromThenTo :: PortNumber -> PortNumber -> PortNumber -> [PortNumber] #
Num PortNumber
Instance details Defined in Network.Socket.Types Methods (+) :: PortNumber -> PortNumber -> PortNumber # (-) :: PortNumber -> PortNumber -> PortNumber # (*) :: PortNumber -> PortNumber -> PortNumber # negate :: PortNumber -> PortNumber # abs :: PortNumber -> PortNumber # signum :: PortNumber -> PortNumber # fromInteger :: Integer -> PortNumber #
Read PortNumber
Instance details Defined in Network.Socket.Types Methods readsPrec :: Int -> ReadS PortNumber # readList :: ReadS [PortNumber] # readPrec :: ReadPrec PortNumber # readListPrec :: ReadPrec [PortNumber] #
Integral PortNumber
Instance details Defined in Network.Socket.Types Methods quot :: PortNumber -> PortNumber -> PortNumber # rem :: PortNumber -> PortNumber -> PortNumber # div :: PortNumber -> PortNumber -> PortNumber # mod :: PortNumber -> PortNumber -> PortNumber # quotRem :: PortNumber -> PortNumber -> (PortNumber, PortNumber) # divMod :: PortNumber -> PortNumber -> (PortNumber, PortNumber) # toInteger :: PortNumber -> Integer #
Real PortNumber
Instance details Defined in Network.Socket.Types Methods toRational :: PortNumber -> Rational #
Show PortNumber
Instance details Defined in Network.Socket.Types Methods showsPrec :: Int -> PortNumber -> ShowS # show :: PortNumber -> String # showList :: [PortNumber] -> ShowS #
Eq PortNumber
Instance details Defined in Network.Socket.Types Methods (==) :: PortNumber -> PortNumber -> Bool # (/=) :: PortNumber -> PortNumber -> Bool #
Ord PortNumber
Instance details Defined in Network.Socket.Types Methods compare :: PortNumber -> PortNumber -> Ordering # (<) :: PortNumber -> PortNumber -> Bool # (<=) :: PortNumber -> PortNumber -> Bool # (>) :: PortNumber -> PortNumber -> Bool # (>=) :: PortNumber -> PortNumber -> Bool # max :: PortNumber -> PortNumber -> PortNumber # min :: PortNumber -> PortNumber -> PortNumber #

runTLS Source #

Arguments

:: Settings
-> Credentials
-> HostName
-> PortNumber
-> ByteString	ALPN
-> (Manager -> IOBackend -> IO a)
-> IO a

Running a TLS client. IOBackend provides sending and receiving functions with timeout based on Settings.

Settings

data Settings Source #

defaultSettings :: Settings Source #

Default settings.

settingsTimeout :: Settings -> Int Source #

Timeout in seconds. (All)

>>> settingsTimeout defaultSettings
30

settingsSendBufferSize :: Settings -> Int Source #

Send buffer size. (H2 and H2c)

>>> settingsSendBufferSize defaultSettings
4096

settingsSlowlorisSize :: Settings -> Int Source #

If the size of receiving data is less than or equal, the timeout is not reset. (All)

>>> settingsSlowlorisSize defaultSettings
50

settingsReadBufferSize :: Settings -> Int Source #

When the size of a read buffer is lower than this limit, the buffer is thrown awany (and is eventually freed). Then a new buffer is allocated. (All)

>>> settingsReadBufferSize defaultSettings
16384

settingsReadBufferLowerLimit :: Settings -> Int Source #

The allocation size for a read buffer. (All)

>>> settingsReadBufferLowerLimit defaultSettings
2048

settingsKeyLogger :: Settings -> String -> IO () Source #

Key logger (defaults to none)

Applications may wish to set this depending on the SSLKEYLOGFILE environment variable. The default is do nothing.

settingsNumberOfWorkers :: Settings -> Int Source #

The number of workers (H2 and H2c)

>>> settingsNumberOfWorkers defaultSettings
8

settingsConcurrentStreams :: Settings -> Int Source #

The maximum number of incoming streams on the net (H2 and H2c)

>>> settingsConcurrentStreams defaultSettings
64

settingsConnectionWindowSize :: Settings -> Int Source #

The window size of a connection (H2 and H2c)

>>> settingsConnectionWindowSize defaultSettings
1048575

settingsStreamWindowSize :: Settings -> Int Source #

The window size of incoming streams (H2 and H2c)

>>> settingsStreamWindowSize defaultSettings
262144

settingsSessionManager :: Settings -> SessionManager Source #

TLS session manager (H2 and TLS)

settingsOpenServerSocket :: Settings -> AddrInfo -> IO Socket Source #

Function to initialize the server socket

Defaults to openServerSocket

IO backend

data IOBackend Source #

Sending and receiving functions. Tiemout is reset when they return. One exception is the slowloris attach prevention. See settingsSlowlorisSize.

send :: IOBackend -> ByteString -> IO () Source #

Sending.

sendMany :: IOBackend -> [ByteString] -> IO () Source #

Sending many.

recv :: IOBackend -> IO ByteString Source #

Receiving.

mySockAddr :: IOBackend -> SockAddr Source #

peerSockAddr :: IOBackend -> SockAddr Source #

Internal

runIO :: Settings -> Credentials -> HostName -> PortNumber -> (ServerIO -> IO (IO ())) -> IO () Source #

runIOH2C :: Settings -> HostName -> PortNumber -> (ServerIO -> IO (IO ())) -> IO () Source #

data Stream #

Instances

Instances details

Show Stream
Instance details Defined in Network.HTTP2.H2.Types Methods showsPrec :: Int -> Stream -> ShowS # show :: Stream -> String # showList :: [Stream] -> ShowS #

data ServerIO #

Constructors

ServerIO
Fields sioMySockAddr :: SockAddr sioPeerSockAddr :: SockAddr sioReadRequest :: IO (StreamId, Stream, Request) sioWriteResponse :: Stream -> Response -> IO () sioWriteBytes :: ByteString -> IO ()