Hans.Layer.Tcp.Window

Documentation

data RemoteWindow

Remote window management.

Constructors

RemoteWindow

Fields

rwSegments :: !OutSegments

rwAvailable :: !Word32

rwSize :: !Word32

rwSndWind :: !Word16

rwSndWindScale :: !Int

Instances

Show RemoteWindow

emptyRemoteWindow :: Word16 -> Int -> RemoteWindow

The empty window, seeded with an initial size.

refreshRemoteWindow :: RemoteWindow -> RemoteWindow

Recalculate internal constants of the remote window.

setSndWindScale :: Int -> RemoteWindow -> RemoteWindow

Set the Snd.Wind.Scale variable for the remote window.

setSndWind :: Word16 -> RemoteWindow -> RemoteWindow

Set the Snd.Wind variable for the remote window.

releaseSpace :: Word32 -> RemoteWindow -> RemoteWindow

Adjust the internal available counter.

addSegment :: OutSegment -> RemoteWindow -> RemoteWindow

Add a segment to the window.

receiveAck :: TcpHeader -> RemoteWindow -> Maybe (OutSegment, RemoteWindow)

Process an incoming ack, returning a finalizer, and a new window if there was a matching set of packets waiting for an ack.

genRetransmitSegments :: RemoteWindow -> (OutSegments, RemoteWindow)

Update the RTO timer on all segments waiting for an ack. When the timer runs out, output the segment for retransmission.

clearRetransmit :: RemoteWindow -> RemoteWindow

retransmitEmpty :: RemoteWindow -> Bool

type OutSegments = Seq OutSegment

data OutSegment

A delivered segment.

Constructors

OutSegment

Fields

outAckNum :: !TcpSeqNum

outTime :: !POSIXTime

outFresh :: !Bool

Whether or not this is a retransmission

outRTO :: !Int

Retransmit timer for this segment

outHeader :: !TcpHeader

outBody :: !ByteString

Instances

Show OutSegment

mkOutSegment :: POSIXTime -> Int -> TcpHeader -> ByteString -> OutSegment

ctlLength :: Num len => Bool -> len

outSize :: Num a => OutSegment -> a

outSize' :: Num a => TcpHeader -> ByteString -> a

The size of a segment body.

decrementRTO :: OutSegment -> OutSegment

Decrement the RTO value on a segment by the timer granularity (500ms). Once the RTO value dips below 1, mark the segment as no longer fresh.

data LocalWindow

Local window, containing a buffer of incoming packets, indexed by their sequence number, relative to RCV.NXT.

XXX make this respect the values of size and available

Constructors

LocalWindow

Fields

lwBuffer :: Seq InSegment

lwRcvNxt :: !TcpSeqNum

lwAvailable :: !Word32

lwSize :: !Word32

lwRcvWind :: !Word16

lwRcvWindScale :: !Int

Instances

Show LocalWindow

emptyLocalWindow :: TcpSeqNum -> Word16 -> Int -> LocalWindow

Empty local buffer, with an initial sequence number as the next expected sequence number.

localWindowSackBlocks :: LocalWindow -> Seq SackBlock

Produce a sequence of blocks for the sack option.

refreshLocalWindow :: LocalWindow -> LocalWindow

Recalculate internal constants.

setRcvNxt :: TcpSeqNum -> LocalWindow -> LocalWindow

Update the size of the remote window.

addRcvNxt :: TcpSeqNum -> LocalWindow -> LocalWindow

Add a sequence number to the value of Rcv.Nxt.

setRcvWind :: Word16 -> LocalWindow -> LocalWindow

Set the Rcv.Wind variable for the local window.

setRcvWindScale :: Int -> LocalWindow -> LocalWindow

Set the Rcv.Wind.Scale variable in the local window.

incomingPacket :: TcpHeader -> ByteString -> LocalWindow -> (Seq InSegment, LocalWindow)

Process an incoming packet that needs to pass through the incoming queue.

addInSegment :: TcpHeader -> ByteString -> LocalWindow -> LocalWindow

Queue an incoming packet in the incoming window.

stepWindow :: LocalWindow -> (Seq InSegment, LocalWindow)

Advance the window, if there are packets available to be returned.

data InSegment

Constructors

InSegment

Fields

inRelSeqNum :: !TcpSeqNum

inHeader :: !TcpHeader

inBody :: !ByteString

Instances

Show InSegment

inSeqNum :: InSegment -> TcpSeqNum

inLength :: Num a => InSegment -> a

mkInSegment :: TcpSeqNum -> TcpHeader -> ByteString -> InSegment

Generate an incoming segment, relative to the value of RCV.NXT

mkSackBlock :: InSegment -> SackBlock

module Hans.Layer.Tcp.WaitBuffer