toxcore-0.2.12: A Tox protocol implementation in Haskell

Safe Haskell	None
Language	Haskell2010

Tox.Transport.Stream

Synopsis

data StreamState = StreamState {
- ssMinRTT :: Maybe TimeDiff
- ssLastRTT :: Maybe TimeDiff
- ssSendHistory :: Map SeqNum Timestamp
- ssSentLastInterval :: Int
- ssIntervalStart :: Timestamp
- ssSendQueueSizeStart :: Int
- ssCurrentSendRate :: Double
- ssLastCongestion :: Maybe Timestamp
}
initState :: Timestamp -> StreamState
recordPacketSent :: SeqNum -> Timestamp -> StreamState -> StreamState
recordPacketAcked :: SeqNum -> Timestamp -> StreamState -> StreamState
ccInterval :: TimeDiff
congestionMemory :: TimeDiff
updateSendRate :: Int -> Timestamp -> StreamState -> StreamState
recordCongestion :: Timestamp -> StreamState -> StreamState

Documentation

data StreamState Source #

State for Congestion Control (CC) and RTT tracking.

Constructors

Fields

ssMinRTT :: Maybe TimeDiff
Lowest observed RTT
ssLastRTT :: Maybe TimeDiff
Most recent observed RTT
ssSendHistory :: Map SeqNum Timestamp
When each lossless packet was sent
ssSentLastInterval :: Int
Packets sent in the current 1.2s window
ssIntervalStart :: Timestamp
Start of the current 1.2s window
ssSendQueueSizeStart :: Int
Send queue size at start of interval
ssCurrentSendRate :: Double
Packets per second
ssLastCongestion :: Maybe Timestamp
Last time a congestion event occurred

Instances

Instances details

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

initState :: Timestamp -> StreamState Source #

Initial CC state.

recordPacketSent :: SeqNum -> Timestamp -> StreamState -> StreamState Source #

Record when a lossless packet was sent.

recordPacketAcked :: SeqNum -> Timestamp -> StreamState -> StreamState Source #

Record when a packet was acknowledged by the peer. Updates RTT metrics.

ccInterval :: TimeDiff Source #

congestionMemory :: TimeDiff Source #

updateSendRate :: Int -> Timestamp -> StreamState -> StreamState Source #

Periodically update the send rate based on throughput. Should be called approximately every 1.2s.

recordCongestion :: Timestamp -> StreamState -> StreamState Source #

Record a congestion event (e.g. when peer requests many packets).