Network.HTTP2.TLS.Client

Running an HTTP/2 client over TLS.

Runners

run :: Settings -> HostName -> PortNumber -> Client a -> IO a

runH2C :: Settings -> HostName -> PortNumber -> Client a -> IO a

type Client a = SendRequest -> Aux -> IO a

Client type.

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".

type Authority = String

Authority.

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

Storable PortNumber

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

Defined in Network.Socket.Types

Methods

minBound :: PortNumber

maxBound :: PortNumber

Enum PortNumber

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

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

Defined in Network.Socket.Types

Methods

readsPrec :: Int -> ReadS PortNumber

readList :: ReadS [PortNumber]

readPrec :: ReadPrec PortNumber

readListPrec :: ReadPrec [PortNumber]

Integral PortNumber

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

Defined in Network.Socket.Types

Methods

toRational :: PortNumber -> Rational

Show PortNumber

Defined in Network.Socket.Types

Methods

showsPrec :: Int -> PortNumber -> ShowS

show :: PortNumber -> String

showList :: [PortNumber] -> ShowS

Eq PortNumber

Defined in Network.Socket.Types

Methods

(==) :: PortNumber -> PortNumber -> Bool

(/=) :: PortNumber -> PortNumber -> Bool

Ord PortNumber

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

Arguments

:: Settings

-> HostName

-> PortNumber

-> ByteString

ALPN

-> (Context -> SockAddr -> SockAddr -> IO a)

-> IO a

Generalized API

data ClientConfig

Client configuration

Instances

Show ClientConfig

Defined in Network.HTTP2.Client.Run

Methods

showsPrec :: Int -> ClientConfig -> ShowS

show :: ClientConfig -> String

showList :: [ClientConfig] -> ShowS

Eq ClientConfig

Defined in Network.HTTP2.Client.Run

Methods

(==) :: ClientConfig -> ClientConfig -> Bool

(/=) :: ClientConfig -> ClientConfig -> Bool

defaultClientConfig :: Settings -> Authority -> ClientConfig

defaultAuthority :: HostName -> Authority

Default authority

When we connect to a server, we can distinguish between three names, all of which may be different:

1. The HostName, used for the DNS lookup to get the server's IP
2. The HTTP2 :authority pseudo-header
3. The TLS SNI (Server Name Indicator). This is different from (2) only in exceptional circumstances, see settingsServerNameOverride.

In most cases, however, all three names are identical, and so the default Authority is simply equal to the ServerName.

runWithConfig :: ClientConfig -> Settings -> HostName -> PortNumber -> Client a -> IO a

Running an HTTP/2 client over TLS (over TCP).

runH2CWithConfig :: ClientConfig -> HostName -> PortNumber -> Client a -> IO a

Running an HTTP/2 client over TCP.

runTLSWithConfig

Arguments

:: ClientConfig

-> Settings

-> HostName

-> PortNumber

-> ByteString

ALPN

-> (Context -> SockAddr -> SockAddr -> IO a)

-> IO a

Running a TLS client.

Settings

data Settings

defaultSettings :: Settings

Default settings.

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

Key logger (TLS and H2)

Applications may wish to set this depending on the SSLKEYLOGFILE environment variable.

Default: do nothing.

settingsValidateCert :: Settings -> Bool

Should we validate TLS certificates? (TLS and H2)

>>> settingsValidateCert defaultSettings
True

settingsCAStore :: Settings -> CertificateStore

Certificate store used for validation. (TLS and H2)

Default: mempty.

settingsAddrInfoFlags :: Settings -> [AddrInfoFlag]

Obsoleted.

settingsCacheLimit :: Settings -> Int

How many pushed responses are contained in the cache (H2 and H2c)

>>> settingsCacheLimits defaultSettings
64

settingsConcurrentStreams :: Settings -> Int

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

>>> settingsConcurrentStreams defaultSettings
64

settingsConnectionWindowSize :: Settings -> Int

The window size of a connection (H2 and H2c)

>>> settingsConnectionWindowSize defaultSettings
1048575

settingsStreamWindowSize :: Settings -> Int

The window size of incoming streams (H2 and H2c)

>>> settingsStreamWindowSize defaultSettings
262144

settingsServerNameOverride :: Settings -> Maybe HostName

Server name override (H2)

By default, the server name (for TLS SNI) is set based on the authority, corresponding to the HTTP2 :authority pseudo-header. In rare circumstances these two values should be different (for example in the case of domain fronting); settingsServerNameOverride can be used to give SNI a different value than :authority.

settingsSessionManager :: Settings -> SessionManager

TLS session manager (H2 and TLS)

Default: noSessionManager

settingsWantSessionResume :: Settings -> Maybe (SessionID, SessionData)

Try to resume a TLS session (H2 and TLS)

>>> settingsWantSessionResume defaultSettings
Nothing

settingsUseEarlyData :: Settings -> Bool

Try to use 0-RTT (H2 and TLS)

This is only supported for tls >= 2.0.

>>> settingsUseEarlyData defaultSettings
False