Safe Haskell	None
Language	GHC2021

LibP2P.Yamux.Frame

Description

Yamux frame header encoding/decoding.

Every Yamux frame has a fixed 12-byte header: Version (1) | Type (1) | Flags (2 BE) | StreamID (4 BE) | Length (4 BE)

Synopsis

data FrameType
- = FrameData
- | FrameWindowUpdate
- | FramePing
- | FrameGoAway
data Flags = Flags {
- flagSYN :: !Bool
- flagACK :: !Bool
- flagFIN :: !Bool
- flagRST :: !Bool
}
data YamuxHeader = YamuxHeader {
- yhVersion :: !Word8
- yhType :: !FrameType
- yhFlags :: !Flags
- yhStreamId :: !Word32
- yhLength :: !Word32
}
data GoAwayCode
- = GoAwayNormal
- | GoAwayProtocol
- | GoAwayInternal
goAwayCodeToWord32 :: GoAwayCode -> Word32
word32ToGoAwayCode :: Word32 -> Maybe GoAwayCode
encodeHeader :: YamuxHeader -> ByteString
decodeHeader :: ByteString -> Either String YamuxHeader
defaultFlags :: Flags
headerSize :: Int
initialWindowSize :: Word32
maxStreamWindowSize :: Word32

Documentation

data FrameType Source #

Yamux frame types.

Constructors

FrameData	0x00: Data frame with payload
FrameWindowUpdate	0x01: Window size increment
FramePing	0x02: Keepalive/latency measurement
FrameGoAway	0x03: Session termination

Instances

Instances details

Show FrameType Source #
Instance details Defined in LibP2P.Yamux.Frame Methods showsPrec :: Int -> FrameType -> ShowS # show :: FrameType -> String # showList :: [FrameType] -> ShowS #
Eq FrameType Source #
Instance details Defined in LibP2P.Yamux.Frame Methods (==) :: FrameType -> FrameType -> Bool # (/=) :: FrameType -> FrameType -> Bool #

data Flags Source #

Frame flags (bitmask).

Constructors

Flags
Fields flagSYN :: !Bool 0x0001: Open a new stream flagACK :: !Bool 0x0002: Acknowledge a new stream flagFIN :: !Bool 0x0004: Half-close the stream flagRST :: !Bool 0x0008: Reset the stream

Instances

Instances details

Show Flags Source #
Instance details Defined in LibP2P.Yamux.Frame Methods showsPrec :: Int -> Flags -> ShowS # show :: Flags -> String # showList :: [Flags] -> ShowS #
Eq Flags Source #
Instance details Defined in LibP2P.Yamux.Frame Methods (==) :: Flags -> Flags -> Bool # (/=) :: Flags -> Flags -> Bool #

data YamuxHeader Source #

Complete Yamux frame header (12 bytes).

Constructors

YamuxHeader
Fields yhVersion :: !Word8 yhType :: !FrameType yhFlags :: !Flags yhStreamId :: !Word32 yhLength :: !Word32

Instances

Instances details

Show YamuxHeader Source #
Instance details Defined in LibP2P.Yamux.Frame Methods showsPrec :: Int -> YamuxHeader -> ShowS # show :: YamuxHeader -> String # showList :: [YamuxHeader] -> ShowS #
Eq YamuxHeader Source #
Instance details Defined in LibP2P.Yamux.Frame Methods (==) :: YamuxHeader -> YamuxHeader -> Bool # (/=) :: YamuxHeader -> YamuxHeader -> Bool #

data GoAwayCode Source #

Go Away error codes.

Constructors

GoAwayNormal	0x00: Normal termination
GoAwayProtocol	0x01: Protocol error
GoAwayInternal	0x02: Internal error

Instances

Instances details

Show GoAwayCode Source #
Instance details Defined in LibP2P.Yamux.Frame Methods showsPrec :: Int -> GoAwayCode -> ShowS # show :: GoAwayCode -> String # showList :: [GoAwayCode] -> ShowS #
Eq GoAwayCode Source #
Instance details Defined in LibP2P.Yamux.Frame Methods (==) :: GoAwayCode -> GoAwayCode -> Bool # (/=) :: GoAwayCode -> GoAwayCode -> Bool #

goAwayCodeToWord32 :: GoAwayCode -> Word32 Source #

Wire encoding of a GoAway code (carried in the Length field).

word32ToGoAwayCode :: Word32 -> Maybe GoAwayCode Source #

Decode a received GoAway code. The spec defines only 0x00-0x02; anything else is Nothing and the receiver decides how to treat it.

encodeHeader :: YamuxHeader -> ByteString Source #

Encode a Yamux header to 12 bytes.

decodeHeader :: ByteString -> Either String YamuxHeader Source #

Decode a Yamux header from 12 bytes.

defaultFlags :: Flags Source #

No flags set.

headerSize :: Int Source #

Yamux header size is always 12 bytes.

initialWindowSize :: Word32 Source #

Default initial window size: 256 KiB (262144 bytes).

maxStreamWindowSize :: Word32 Source #

Absolute upper bound for any receive window (16 MiB), matching go-yamux's MaxStreamWindowSize. No conforming peer may declare a data frame length beyond this, whatever the per-stream window is.