Safe Haskell	None
Language	Haskell2010

Network.Transport.QUIC.Internal

Contents

Re-export to generate credentials
Message encoding and decoding

Synopsis

createTransport :: QUICTransportConfig -> IO Transport
data QUICTransportConfig = QUICTransportConfig {
- hostName :: HostName
- serviceName :: ServiceName
- credentials :: NonEmpty Credential
- validateCredentials :: Bool
}
defaultQUICTransportConfig :: HostName -> NonEmpty Credential -> QUICTransportConfig
data QUICAddr = QUICAddr {
- quicBindHost :: !HostName
- quicBindPort :: !ServiceName
- quicEndpointId :: !EndPointId
}
encodeQUICAddr :: QUICAddr -> EndPointAddress
decodeQUICAddr :: EndPointAddress -> Either String QUICAddr
type Credential = (CertificateChain, PrivKey)
credentialLoadX509 :: FilePath -> FilePath -> IO (Either String Credential)
decodeMessage :: (Int -> IO ByteString) -> IO (Either String MessageReceived)
data MessageReceived
- = Message !ClientConnId ![ByteString]
- | CloseConnection !ClientConnId
- | CloseEndPoint
- | StreamClosed
encodeMessage :: ClientConnId -> [ByteString] -> [ByteString]

Documentation

createTransport :: QUICTransportConfig -> IO Transport Source #

Create a new Transport based on the QUIC protocol.

Only a single transport should be created per Haskell process (threads can, and should, create their own endpoints though).

data QUICTransportConfig Source #

Represents the configuration used by the entire transport.

Constructors

QUICTransportConfig

Fields

hostName :: HostName
Host name, which can be an IP address or a domain name.
serviceName :: ServiceName
Port or service name. The default is port 443.
credentials :: NonEmpty Credential
At least one set of credentials is required.
validateCredentials :: Bool
Note that if your credentials is self-signed, you will have to turn off validateCredentials. This should only be set to False in tests, or in a private network.

Instances

Instances details

Show QUICTransportConfig Source #
Instance details Defined in Network.Transport.QUIC.Internal.QUICTransport Methods showsPrec :: Int -> QUICTransportConfig -> ShowS # show :: QUICTransportConfig -> String # showList :: [QUICTransportConfig] -> ShowS #
Eq QUICTransportConfig Source #
Instance details Defined in Network.Transport.QUIC.Internal.QUICTransport Methods (==) :: QUICTransportConfig -> QUICTransportConfig -> Bool # (/=) :: QUICTransportConfig -> QUICTransportConfig -> Bool #

defaultQUICTransportConfig :: HostName -> NonEmpty Credential -> QUICTransportConfig Source #

data QUICAddr Source #

Constructors

QUICAddr
Fields quicBindHost :: !HostName quicBindPort :: !ServiceName quicEndpointId :: !EndPointId

Instances

Instances details

Show QUICAddr Source #
Instance details Defined in Network.Transport.QUIC.Internal.QUICAddr Methods showsPrec :: Int -> QUICAddr -> ShowS # show :: QUICAddr -> String # showList :: [QUICAddr] -> ShowS #
Eq QUICAddr Source #
Instance details Defined in Network.Transport.QUIC.Internal.QUICAddr Methods (==) :: QUICAddr -> QUICAddr -> Bool # (/=) :: QUICAddr -> QUICAddr -> Bool #
Ord QUICAddr Source #
Instance details Defined in Network.Transport.QUIC.Internal.QUICAddr Methods compare :: QUICAddr -> QUICAddr -> Ordering # (<) :: QUICAddr -> QUICAddr -> Bool # (<=) :: QUICAddr -> QUICAddr -> Bool # (>) :: QUICAddr -> QUICAddr -> Bool # (>=) :: QUICAddr -> QUICAddr -> Bool # max :: QUICAddr -> QUICAddr -> QUICAddr # min :: QUICAddr -> QUICAddr -> QUICAddr #

encodeQUICAddr :: QUICAddr -> EndPointAddress Source #

Encode a QUICAddr to EndPointAddress

decodeQUICAddr :: EndPointAddress -> Either String QUICAddr Source #

Decode end point address

Re-export to generate credentials

type Credential = (CertificateChain, PrivKey) #

credentialLoadX509 #

Arguments

:: FilePath	public certificate (X.509 format)
-> FilePath	private key associated
-> IO (Either String Credential)

try to create a new credential object from a public certificate and the associated private key that are stored on the filesystem in PEM format.

Message encoding and decoding

decodeMessage :: (Int -> IO ByteString) -> IO (Either String MessageReceived) Source #

data MessageReceived Source #

Constructors

Message !ClientConnId ![ByteString]
CloseConnection !ClientConnId
CloseEndPoint
StreamClosed

Instances

Instances details

Show MessageReceived Source #
Instance details Defined in Network.Transport.QUIC.Internal.Messaging Methods showsPrec :: Int -> MessageReceived -> ShowS # show :: MessageReceived -> String # showList :: [MessageReceived] -> ShowS #
Eq MessageReceived Source #
Instance details Defined in Network.Transport.QUIC.Internal.Messaging Methods (==) :: MessageReceived -> MessageReceived -> Bool # (/=) :: MessageReceived -> MessageReceived -> Bool #

encodeMessage :: ClientConnId -> [ByteString] -> [ByteString] Source #

Encode a message.

The encoding is composed of a header, and the payloads. The message header is composed of: 1. A control byte, to determine how the message should be parsed. 2. A 32-bit word that encodes the endpoint ID of the destination endpoint; 3. A 32-bit word that encodes the number of frames in the message

The payload frames are each prepended with the length of the frame.