Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.HTTP2.Server

Contents

Runner
Server configuration
HTTP/2 setting
Common configuration

Description

HTTP/2 server library.

Example:

{-# LANGUAGE OverloadedStrings #-}
module Main (main) where

import qualified UnliftIO.Exception as E
import Data.ByteString.Builder (byteString)
import Network.HTTP.Types (ok200)
import Network.Run.TCP (runTCPServer) -- network-run

import Network.HTTP2.Server

main :: IO ()
main = runTCPServer Nothing "80" runHTTP2Server
  where
    runHTTP2Server s = E.bracket (allocSimpleConfig s 4096)
                                 freeSimpleConfig
                                 (\config -> run defaultServerConfig config server)
    server _req _aux sendResponse = sendResponse response []
      where
        response = responseBuilder ok200 header body
        header = [("Content-Type", "text/plain")]
        body = byteString "Hello, world!\n"

Synopsis

run :: ServerConfig -> Config -> Server -> IO ()
data ServerConfig
defaultServerConfig :: ServerConfig
numberOfWorkers :: ServerConfig -> Int
connectionWindowSize :: ServerConfig -> WindowSize
settings :: ServerConfig -> Settings
data Settings
defaultSettings :: Settings
headerTableSize :: Settings -> Int
enablePush :: Settings -> Bool
maxConcurrentStreams :: Settings -> Maybe Int
initialWindowSize :: Settings -> WindowSize
maxFrameSize :: Settings -> Int
maxHeaderListSize :: Settings -> Maybe Int
data Config = Config {
- confWriteBuffer :: Buffer
- confBufferSize :: BufferSize
- confSendAll :: ByteString -> IO ()
- confReadN :: Int -> IO ByteString
- confPositionReadMaker :: PositionReadMaker
- confTimeoutManager :: Manager
- confMySockAddr :: SockAddr
- confPeerSockAddr :: SockAddr
}
allocSimpleConfig :: Socket -> BufferSize -> IO Config
freeSimpleConfig :: Config -> IO ()
module Network.HTTP.Semantics.Server

Runner

run :: ServerConfig -> Config -> Server -> IO () Source #

Running HTTP/2 server.

Server configuration

data ServerConfig Source #

Server configuration

Instances

Instances details

Show ServerConfig Source #
Instance details Defined in Network.HTTP2.Server.Run Methods showsPrec :: Int -> ServerConfig -> ShowS # show :: ServerConfig -> String # showList :: [ServerConfig] -> ShowS #
Eq ServerConfig Source #
Instance details Defined in Network.HTTP2.Server.Run Methods (==) :: ServerConfig -> ServerConfig -> Bool # (/=) :: ServerConfig -> ServerConfig -> Bool #

defaultServerConfig :: ServerConfig Source #

The default server config.

>>> defaultServerConfig
ServerConfig {numberOfWorkers = 8, connectionWindowSize = 1048576, settings = Settings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Just 64, initialWindowSize = 262144, maxFrameSize = 16384, maxHeaderListSize = Nothing, pingRateLimit = 10}}

numberOfWorkers :: ServerConfig -> Int Source #

The number of workers

connectionWindowSize :: ServerConfig -> WindowSize Source #

The window size of incoming streams

settings :: ServerConfig -> Settings Source #

Settings

HTTP/2 setting

data Settings Source #

HTTP/2 settings. See https://datatracker.ietf.org/doc/html/rfc9113#name-defined-settings.

Instances

Instances details

Show Settings Source #
Instance details Defined in Network.HTTP2.H2.Settings Methods showsPrec :: Int -> Settings -> ShowS # show :: Settings -> String # showList :: [Settings] -> ShowS #
Eq Settings Source #
Instance details Defined in Network.HTTP2.H2.Settings Methods (==) :: Settings -> Settings -> Bool # (/=) :: Settings -> Settings -> Bool #

defaultSettings :: Settings Source #

The default settings.

>>> defaultSettings
Settings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Just 64, initialWindowSize = 262144, maxFrameSize = 16384, maxHeaderListSize = Nothing, pingRateLimit = 10}

headerTableSize :: Settings -> Int Source #

SETTINGS_HEADER_TABLE_SIZE

enablePush :: Settings -> Bool Source #

SETTINGS_ENABLE_PUSH

maxConcurrentStreams :: Settings -> Maybe Int Source #

SETTINGS_MAX_CONCURRENT_STREAMS

initialWindowSize :: Settings -> WindowSize Source #

SETTINGS_INITIAL_WINDOW_SIZE

maxFrameSize :: Settings -> Int Source #

SETTINGS_MAX_FRAME_SIZE

maxHeaderListSize :: Settings -> Maybe Int Source #

SETTINGS_MAX_HEADER_LIST_SIZE

Common configuration

data Config Source #

HTTP/2 configuration.

Constructors

Config

Fields

confWriteBuffer :: Buffer
This is used only by frameSender. This MUST be freed after frameSender is terminated.
confBufferSize :: BufferSize
The size of the write buffer. We assume that the read buffer is the same size. So, this value is announced via SETTINGS_MAX_FRAME_SIZE to the peer.
confSendAll :: ByteString -> IO ()
confReadN :: Int -> IO ByteString
confPositionReadMaker :: PositionReadMaker
confTimeoutManager :: Manager
confMySockAddr :: SockAddr
This is copied into Aux, if exist, on server.
confPeerSockAddr :: SockAddr
This is copied into Aux, if exist, on server.

allocSimpleConfig :: Socket -> BufferSize -> IO Config Source #

Making simple configuration whose IO is not efficient. A write buffer is allocated internally.

freeSimpleConfig :: Config -> IO () Source #

Deallocating the resource of the simple configuration.

module Network.HTTP.Semantics.Server