Safe Haskell	None
Language	Haskell2010

Tox.Transport.Reliability

Synopsis

newtype SeqNum = SeqNum Word32
data ReliablePacket = ReliablePacket {
- rpRecvBufferStart :: SeqNum
- rpPacketNumber :: SeqNum
- rpIsLossless :: Bool
- rpPayload :: ByteString
}
data ReliabilityState = ReliabilityState {
- rsNextSendSeq :: SeqNum
- rsNextRecvSeq :: SeqNum
- rsPeerNextRecvSeq :: SeqNum
- rsSendWindow :: Map SeqNum ByteString
- rsRecvWindow :: Map SeqNum ByteString
}
initState :: ReliabilityState
data PacketRequest = PacketRequest {
- prMissingDeltas :: [Word32]
}
handleIncoming :: ReliablePacket -> ReliabilityState -> (ReliabilityState, [ByteString])
createPacketRequest :: ReliabilityState -> Maybe PacketRequest
extractDeliverable :: SeqNum -> Map SeqNum ByteString -> ([ByteString], Map SeqNum ByteString, SeqNum)
createLossless :: ByteString -> ReliabilityState -> (ReliablePacket, ReliabilityState)
handlePacketRequest :: PacketRequest -> ReliabilityState -> ([ReliablePacket], ReliabilityState)

Documentation

newtype SeqNum Source #

Sequence Number (32-bit with wrap-around).

Constructors

SeqNum Word32

Instances

Instances details

Enum SeqNum Source #
Instance details Defined in Tox.Transport.Reliability Methods succ :: SeqNum -> SeqNum # pred :: SeqNum -> SeqNum # toEnum :: Int -> SeqNum # fromEnum :: SeqNum -> Int # enumFrom :: SeqNum -> [SeqNum] # enumFromThen :: SeqNum -> SeqNum -> [SeqNum] # enumFromTo :: SeqNum -> SeqNum -> [SeqNum] # enumFromThenTo :: SeqNum -> SeqNum -> SeqNum -> [SeqNum] #
Eq SeqNum Source #
Instance details Defined in Tox.Transport.Reliability Methods (==) :: SeqNum -> SeqNum -> Bool # (/=) :: SeqNum -> SeqNum -> Bool #
Num SeqNum Source #
Instance details Defined in Tox.Transport.Reliability Methods (+) :: SeqNum -> SeqNum -> SeqNum # (-) :: SeqNum -> SeqNum -> SeqNum # (*) :: SeqNum -> SeqNum -> SeqNum # negate :: SeqNum -> SeqNum # abs :: SeqNum -> SeqNum # signum :: SeqNum -> SeqNum # fromInteger :: Integer -> SeqNum #
Ord SeqNum Source #	Custom ordering for sequence numbers to handle rollover. A sequence number `a` is considered less than `b` if it is within the first half of the 32-bit space following `a` (circularly).
Instance details Defined in Tox.Transport.Reliability Methods compare :: SeqNum -> SeqNum -> Ordering # (<) :: SeqNum -> SeqNum -> Bool # (<=) :: SeqNum -> SeqNum -> Bool # (>) :: SeqNum -> SeqNum -> Bool # (>=) :: SeqNum -> SeqNum -> Bool # max :: SeqNum -> SeqNum -> SeqNum # min :: SeqNum -> SeqNum -> SeqNum #
Show SeqNum Source #
Instance details Defined in Tox.Transport.Reliability Methods showsPrec :: Int -> SeqNum -> ShowS # show :: SeqNum -> String # showList :: [SeqNum] -> ShowS #
Binary SeqNum Source #
Instance details Defined in Tox.Transport.Reliability Methods put :: SeqNum -> Put # get :: Get SeqNum # putList :: [SeqNum] -> Put #

data ReliablePacket Source #

Header for reliable transport (lossy or lossless).

Constructors

ReliablePacket
Fields rpRecvBufferStart :: SeqNum Our next expected recv packet number rpPacketNumber :: SeqNum This packet's number (lossless) or next seq (lossy) rpIsLossless :: Bool Discriminator for packet type rpPayload :: ByteString

Instances

Instances details

Eq ReliablePacket Source #
Instance details Defined in Tox.Transport.Reliability Methods (==) :: ReliablePacket -> ReliablePacket -> Bool # (/=) :: ReliablePacket -> ReliablePacket -> Bool #
Show ReliablePacket Source #
Instance details Defined in Tox.Transport.Reliability Methods showsPrec :: Int -> ReliablePacket -> ShowS # show :: ReliablePacket -> String # showList :: [ReliablePacket] -> ShowS #
Binary ReliablePacket Source #
Instance details Defined in Tox.Transport.Reliability Methods put :: ReliablePacket -> Put # get :: Get ReliablePacket # putList :: [ReliablePacket] -> Put #

data ReliabilityState Source #

State for the reliability layer.

Constructors

ReliabilityState
Fields rsNextSendSeq :: SeqNum Sequence number for next outgoing lossless packet rsNextRecvSeq :: SeqNum Sequence number of next expected incoming packet rsPeerNextRecvSeq :: SeqNum Highest contiguous sequence peer has received rsSendWindow :: Map SeqNum ByteString Sent packets awaiting ACK rsRecvWindow :: Map SeqNum ByteString Out-of-order received packets

Instances

Instances details

Eq ReliabilityState Source #
Instance details Defined in Tox.Transport.Reliability Methods (==) :: ReliabilityState -> ReliabilityState -> Bool # (/=) :: ReliabilityState -> ReliabilityState -> Bool #
Show ReliabilityState Source #
Instance details Defined in Tox.Transport.Reliability Methods showsPrec :: Int -> ReliabilityState -> ShowS # show :: ReliabilityState -> String # showList :: [ReliabilityState] -> ShowS #

initState :: ReliabilityState Source #

Initial state for a new connection.

data PacketRequest Source #

A request for missing packets.

Constructors

PacketRequest
Fields prMissingDeltas :: [Word32] Deltas from the last missing packet

Instances

Instances details

Eq PacketRequest Source #
Instance details Defined in Tox.Transport.Reliability Methods (==) :: PacketRequest -> PacketRequest -> Bool # (/=) :: PacketRequest -> PacketRequest -> Bool #
Show PacketRequest Source #
Instance details Defined in Tox.Transport.Reliability Methods showsPrec :: Int -> PacketRequest -> ShowS # show :: PacketRequest -> String # showList :: [PacketRequest] -> ShowS #
Binary PacketRequest Source #
Instance details Defined in Tox.Transport.Reliability Methods put :: PacketRequest -> Put # get :: Get PacketRequest # putList :: [PacketRequest] -> Put #

handleIncoming :: ReliablePacket -> ReliabilityState -> (ReliabilityState, [ByteString]) Source #

Process an incoming reliable packet. Returns the updated state and any newly deliverable payloads.

createPacketRequest :: ReliabilityState -> Maybe PacketRequest Source #

Generate a request for all currently missing packets in our recv window.

extractDeliverable :: SeqNum -> Map SeqNum ByteString -> ([ByteString], Map SeqNum ByteString, SeqNum) Source #

Pull contiguous packets from the recv window starting at next.

createLossless :: ByteString -> ReliabilityState -> (ReliablePacket, ReliabilityState) Source #

Create a new outgoing lossless packet.

handlePacketRequest :: PacketRequest -> ReliabilityState -> ([ReliablePacket], ReliabilityState) Source #

Process a packet request from the peer and identify packets to resend. Returns the updated state and the list of packets that should be resent.