Network.QUIC.Client

This main module provides APIs for QUIC clients. When a new better network interface is up, migration is done automatically.

Running a QUIC client

run :: ClientConfig -> (Connection -> IO a) -> IO a

Running a QUIC client. A UDP socket is created according to ccServerName and ccPortName.

If ccAutoMigration is True, a unconnected socket is made. Otherwise, a connected socket is made. Use the migrate API for the connected socket.

Configration

data ClientConfig

Client configuration.

defaultClientConfig :: ClientConfig

The default value for client configuration.

ccServerName :: ClientConfig -> HostName

Used to create a socket and SNI for TLS.

ccPortName :: ClientConfig -> ServiceName

Used to create a socket.

ccALPN :: ClientConfig -> Version -> IO (Maybe [ByteString])

An ALPN provider.

ccUse0RTT :: ClientConfig -> Bool

Use 0-RTT on the 2nd connection if possible. client original

ccResumption :: ClientConfig -> ResumptionInfo

Use resumption on the 2nd connection if possible.

ccCiphers :: ClientConfig -> [Cipher]

Cipher candidates defined in TLS 1.3.

ccGroups :: ClientConfig -> [Group]

Key exchange group candidates defined in TLS 1.3.

ccVersions :: ClientConfig -> [Version]

Compatible versions with ccVersion in the preferred order.

ccValidate :: ClientConfig -> Bool

Authenticating a server based on its certificate.

ccAutoMigration :: ClientConfig -> Bool

If True, use a unconnected socket for auto migration. Otherwise, use a connected socket.

Resumption

data ResumptionInfo

Information about resumption

Instances

Generic ResumptionInfo

Defined in Network.QUIC.Types.Resumption

Associated Types

type Rep ResumptionInfo :: Type -> Type

Methods

from :: ResumptionInfo -> Rep ResumptionInfo x

to :: Rep ResumptionInfo x -> ResumptionInfo

Show ResumptionInfo

Defined in Network.QUIC.Types.Resumption

Methods

showsPrec :: Int -> ResumptionInfo -> ShowS

show :: ResumptionInfo -> String

showList :: [ResumptionInfo] -> ShowS

Eq ResumptionInfo

Defined in Network.QUIC.Types.Resumption

Methods

(==) :: ResumptionInfo -> ResumptionInfo -> Bool

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

Serialise ResumptionInfo

Defined in Network.QUIC.Types.Resumption

Methods

encode :: ResumptionInfo -> Encoding

decode :: Decoder s ResumptionInfo

encodeList :: [ResumptionInfo] -> Encoding

decodeList :: Decoder s [ResumptionInfo]

type Rep ResumptionInfo

Defined in Network.QUIC.Types.Resumption

type Rep ResumptionInfo = D1 ('MetaData "ResumptionInfo" "Network.QUIC.Types.Resumption" "quic-0.1.25-KqVeOwbQyK15gFEueb8rf4" 'False) (C1 ('MetaCons "ResumptionInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resumptionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Version) :*: S1 ('MetaSel ('Just "resumptionSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (SessionID, SessionData)))) :*: (S1 ('MetaSel ('Just "resumptionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :*: S1 ('MetaSel ('Just "resumptionRetry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

getResumptionInfo :: Connection -> IO ResumptionInfo

Getting information about resumption.

isResumptionPossible :: ResumptionInfo -> Bool

Is resumption possible?

is0RTTPossible :: ResumptionInfo -> Bool

Is 0RTT possible?

Migration

migrate :: Connection -> IO Bool

Creating a new socket and execute a path validation with a new connection ID. Typically, this is used for migration in the case where ccAutoMigration is False. But this can also be used even when the value is True.