Network.QUIC

This main module provides APIs for QUIC.

The -threaded option must be specified to GHC to use this library.

Connection

data Connection

A quic connection to carry multiple streams.

Instances

Connector Connection

Defined in Network.QUIC.Connection.Types

Methods

getRole :: Connection -> Role

getEncryptionLevel :: Connection -> IO EncryptionLevel

getMaxPacketSize :: Connection -> IO Int

getConnectionState :: Connection -> IO ConnectionState

getPacketNumber :: Connection -> IO PacketNumber

getAlive :: Connection -> IO Bool

KeepQlog Connection

Defined in Network.QUIC.Connection.Types

Methods

keepQlog :: Connection -> QLogger

abortConnection :: Connection -> ApplicationProtocolError -> ReasonPhrase -> IO ()

Closing a connection with an application protocol error.

Stream

data Stream

An abstract data type for streams.

Instances

Show Stream

Defined in Network.QUIC.Stream.Types

Methods

showsPrec :: Int -> Stream -> ShowS

show :: Stream -> String

showList :: [Stream] -> ShowS

type StreamId = Int

Stream identifier. This should be 62-bit interger. On 32-bit machines, the total number of stream identifiers is limited.

streamId :: Stream -> StreamId

Getting stream identifier.

Category

isClientInitiatedBidirectional :: StreamId -> Bool

Checking if a stream is client-initiated bidirectional.

isServerInitiatedBidirectional :: StreamId -> Bool

Checking if a stream is server-initiated bidirectional.

isClientInitiatedUnidirectional :: StreamId -> Bool

Checking if a stream is client-initiated unidirectional.

isServerInitiatedUnidirectional :: StreamId -> Bool

Checking if a stream is server-initiated unidirectional.

Opening

stream :: Connection -> IO Stream

Creating a bidirectional stream.

unidirectionalStream :: Connection -> IO Stream

Creating a unidirectional stream.

acceptStream :: Connection -> IO Stream

Accepting a stream initiated by the peer.

Closing

closeStream :: Stream -> IO ()

Closing a stream without an error. This sends FIN if necessary.

shutdownStream :: Stream -> IO ()

Sending FIN in a stream. closeStream should be called later.

resetStream :: Stream -> ApplicationProtocolError -> IO ()

Closing a stream with an error code. This sends RESET_STREAM to the peer. This is an alternative of closeStream.

stopStream :: Stream -> ApplicationProtocolError -> IO ()

Asking the peer to stop sending. This sends STOP_SENDING to the peer and it will send RESET_STREAM back. closeStream should be called later.

IO

recvStream :: Stream -> Int -> IO ByteString

Receiving data in the stream. In the case where a FIN is received an empty bytestring is returned.

sendStream :: Stream -> ByteString -> IO ()

Sending data in the stream.

sendStreamMany :: Stream -> [ByteString] -> IO ()

Sending a list of data in the stream.

Information

data ConnectionInfo

Information about a connection.

Instances

Show ConnectionInfo

Defined in Network.QUIC.Types.Info

Methods

showsPrec :: Int -> ConnectionInfo -> ShowS

show :: ConnectionInfo -> String

showList :: [ConnectionInfo] -> ShowS

getConnectionInfo :: Connection -> IO ConnectionInfo

Getting information about a connection.

version :: ConnectionInfo -> Version

cipher :: ConnectionInfo -> Cipher

alpn :: ConnectionInfo -> Maybe ByteString

handshakeMode :: ConnectionInfo -> HandshakeMode13

retry :: ConnectionInfo -> Bool

localSockAddr :: ConnectionInfo -> SockAddr

remoteSockAddr :: ConnectionInfo -> SockAddr

localCID :: ConnectionInfo -> CID

remoteCID :: ConnectionInfo -> CID

Statistics

data ConnectionStats

Statistics of a connection.

Instances

Show ConnectionStats

Defined in Network.QUIC.Info

Methods

showsPrec :: Int -> ConnectionStats -> ShowS

show :: ConnectionStats -> String

showList :: [ConnectionStats] -> ShowS

Eq ConnectionStats

Defined in Network.QUIC.Info

Methods

(==) :: ConnectionStats -> ConnectionStats -> Bool

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

getConnectionStats :: Connection -> IO ConnectionStats

Getting statistics of a connection.

txBytes :: ConnectionStats -> Int

rxBytes :: ConnectionStats -> Int

Synchronization

wait0RTTReady :: Connection -> IO ()

Waiting until 0-RTT data can be sent.

wait1RTTReady :: Connection -> IO ()

Waiting until 1-RTT data can be sent.

waitEstablished :: Connection -> IO ()

For clients, waiting until HANDSHAKE_DONE is received. For servers, waiting until a TLS stack reports that the handshake is complete.

Exceptions and Errors

data QUICException

User level exceptions for QUIC.

Constructors

ConnectionIsClosed

TransportErrorIsReceived TransportError ReasonPhrase

TransportErrorIsSent TransportError ReasonPhrase

ApplicationProtocolErrorIsReceived ApplicationProtocolError ReasonPhrase

ApplicationProtocolErrorIsSent ApplicationProtocolError ReasonPhrase

ConnectionIsTimeout String

ConnectionIsReset

StreamIsClosed

HandshakeFailed AlertDescription

VersionIsUnknown Word32

NoVersionIsSpecified

VersionNegotiationFailed

BadThingHappen SomeException

Instances

Exception QUICException

Defined in Network.QUIC.Types.Exception

Methods

toException :: QUICException -> SomeException

fromException :: SomeException -> Maybe QUICException

displayException :: QUICException -> String

Show QUICException

Defined in Network.QUIC.Types.Exception

Methods

showsPrec :: Int -> QUICException -> ShowS

show :: QUICException -> String

showList :: [QUICException] -> ShowS

newtype TransportError

Transport errors of QUIC.

Constructors

TransportError Int

Bundled Patterns

pattern NoError :: TransportError

pattern InternalError :: TransportError

pattern ConnectionRefused :: TransportError

pattern FlowControlError :: TransportError

pattern StreamLimitError :: TransportError

pattern StreamStateError :: TransportError

pattern FinalSizeError :: TransportError

pattern FrameEncodingError :: TransportError

pattern TransportParameterError :: TransportError

pattern ConnectionIdLimitError :: TransportError

pattern ProtocolViolation :: TransportError

pattern InvalidToken :: TransportError

pattern ApplicationError :: TransportError

pattern CryptoBufferExceeded :: TransportError

pattern KeyUpdateError :: TransportError

pattern AeadLimitReached :: TransportError

pattern NoViablePath :: TransportError

Instances

Show TransportError

Defined in Network.QUIC.Types.Error

Methods

showsPrec :: Int -> TransportError -> ShowS

show :: TransportError -> String

showList :: [TransportError] -> ShowS

Eq TransportError

Defined in Network.QUIC.Types.Error

Methods

(==) :: TransportError -> TransportError -> Bool

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

cryptoError :: AlertDescription -> TransportError

Converting a TLS alert to a corresponding transport error.

newtype ApplicationProtocolError

Application protocol errors of QUIC.

Constructors

ApplicationProtocolError Int

Instances

Show ApplicationProtocolError

Defined in Network.QUIC.Types.Error

Methods

showsPrec :: Int -> ApplicationProtocolError -> ShowS

show :: ApplicationProtocolError -> String

showList :: [ApplicationProtocolError] -> ShowS

Eq ApplicationProtocolError

Defined in Network.QUIC.Types.Error

Methods

(==) :: ApplicationProtocolError -> ApplicationProtocolError -> Bool

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