Safe Haskell	None
Language	Haskell2010

Network.HTTP2.Client.Internal

Contents

Low level

Synopsis

newtype Request = Request OutObj
newtype Response = Response InpObj
data Config = Config {
- confWriteBuffer :: Buffer
- confBufferSize :: BufferSize
- confSendAll :: ByteString -> IO ()
- confReadN :: Int -> IO ByteString
- confPositionReadMaker :: PositionReadMaker
- confTimeoutManager :: Manager
- confMySockAddr :: SockAddr
- confPeerSockAddr :: SockAddr
- confReadNTimeout :: Bool
- confOnInformational :: StreamId -> TokenHeaderTable -> IO ()
}
data ClientConfig = ClientConfig {
- scheme :: Scheme
- authority :: Authority
- cacheLimit :: Int
- connectionWindowSize :: WindowSize
- settings :: Settings
}
data Settings = Settings {
- headerTableSize :: Int
- enablePush :: Bool
- maxConcurrentStreams :: Maybe Int
- initialWindowSize :: WindowSize
- maxFrameSize :: Int
- maxHeaderListSize :: Maybe Int
- pingRateLimit :: Int
- emptyFrameRateLimit :: Int
- settingsRateLimit :: Int
- rstRateLimit :: Int
}
data Aux = Aux {
- auxPossibleClientStreams :: IO Int
- auxSendPing :: IO ()
}
data Stream
data ClientIO = ClientIO {
- cioMySockAddr :: SockAddr
- cioPeerSockAddr :: SockAddr
- cioWriteRequest :: Request -> IO (StreamId, Stream)
- cioReadResponse :: Stream -> IO Response
- cioWriteBytes :: ByteString -> IO ()
- cioCreateStream :: IO (StreamId, Stream)
}
runIO :: ClientConfig -> Config -> (ClientIO -> IO (IO a)) -> IO a

Documentation

newtype Request #

Request from client.

Constructors

Request OutObj

Instances

Instances details

Show Request
Instance details Defined in Network.HTTP.Semantics.Client.Internal Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #

newtype Response #

Response from server.

Constructors

Response InpObj

Instances

Instances details

Show Response
Instance details Defined in Network.HTTP.Semantics.Client.Internal Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #

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.
confReadNTimeout :: Bool
confOnInformational :: StreamId -> TokenHeaderTable -> IO ()
Client only: called when a 1xx informational response (e.g. 103 Early Hints) is received on the given stream, ahead of the final response. No-op by default.
Since: 5.4.2

data ClientConfig Source #

Client configuration

Constructors

ClientConfig
Fields scheme :: Scheme https or http authority :: Authority Server name cacheLimit :: Int The maximum number of incoming streams on the net connectionWindowSize :: WindowSize The window size of connection. settings :: Settings Settings

Instances

Instances details

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

data Settings Source #

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

Constructors

Settings

Fields

headerTableSize :: Int
SETTINGS_HEADER_TABLE_SIZE
enablePush :: Bool
SETTINGS_ENABLE_PUSH
maxConcurrentStreams :: Maybe Int
SETTINGS_MAX_CONCURRENT_STREAMS
initialWindowSize :: WindowSize
SETTINGS_INITIAL_WINDOW_SIZE
maxFrameSize :: Int
SETTINGS_MAX_FRAME_SIZE
maxHeaderListSize :: Maybe Int
SETTINGS_MAX_HEADER_LIST_SIZE. Our own value is also enforced: a field block whose decoded size (RFC 9113 section 6.5.2: the length of each field's name plus its value plus 32) exceeds it resets the stream. With Nothing, nothing is advertised but a limit of 64 KiB is enforced all the same (CVE-2026-49975).
pingRateLimit :: Int
Maximum number of pings allowed per second (CVE-2019-9512)
emptyFrameRateLimit :: Int
Maximum number of empty data frames allowed per second (CVE-2019-9518)
settingsRateLimit :: Int
Maximum number of settings frames allowed per second (CVE-2019-9515)
rstRateLimit :: Int
Maximum number of streams reset per second, whether by the peer's RST_STREAM (CVE-2023-44487) or by ours in answer to a stream error the peer caused (CVE-2025-8671)

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 #

data Aux #

Additional information.

Constructors

Aux
Fields auxPossibleClientStreams :: IO Int How many streams can be created without blocking. auxSendPing :: IO () Sending a ping.

Low level

data Stream Source #

Instances

Instances details

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

data ClientIO Source #

Constructors

ClientIO
Fields cioMySockAddr :: SockAddr cioPeerSockAddr :: SockAddr cioWriteRequest :: Request -> IO (StreamId, Stream) cioReadResponse :: Stream -> IO Response cioWriteBytes :: ByteString -> IO () cioCreateStream :: IO (StreamId, Stream)

runIO :: ClientConfig -> Config -> (ClientIO -> IO (IO a)) -> IO a Source #

Launching a receiver and a sender.