AzNetworking::UdpPacketTracker Class Reference

packet tracking mechanism for sending, acking, and detecting dropped packets. More...

#include <UdpPacketTracker.h>

Public Member Functions
void	Reset ()
	Resets all internal state for this packet tracker.
PacketId	GetNextPacketId ()
bool	ProcessReceived (UdpConnection *connection, UdpPacketHeader &header)
PacketAckState	GetPacketAckStatus (PacketId packetId) const
SequenceId	GetLastReceivedSequenceId () const
BitsetChunk &	GetSequencedAckHistory (BitsetChunk &outWindow) const
const UdpPacketIdWindow &	GetReceivedWindow () const
const UdpPacketIdWindow &	GetAcknowledgedWindow () const

Detailed Description

packet tracking mechanism for sending, acking, and detecting dropped packets.

Member Function Documentation

GetAcknowledgedWindow()

const UdpPacketIdWindow & AzNetworking::UdpPacketTracker::GetAcknowledgedWindow ( ) const

inline

Const access to the packet trackers acknowledged window.

Returns

const reference to the packet trackers acknowledged window

GetLastReceivedSequenceId()

SequenceId AzNetworking::UdpPacketTracker::GetLastReceivedSequenceId ( ) const

inline

Returns the last received remote sequence id.

Returns

the last received remote sequence id

GetNextPacketId()

PacketId AzNetworking::UdpPacketTracker::GetNextPacketId ( )

inline

Returns the next packet id for this UdpPacketTracker instance.

Returns

the next sequence id for this UdpPacketTracker instance

GetPacketAckStatus()

PacketAckState AzNetworking::UdpPacketTracker::GetPacketAckStatus

(

PacketId

packetId

)

const

Returns whether or not a particular packet was confirmed received by the remote connection.

Parameters

sequenceId

the sequence number of the packet to check the ack status of

Returns

boolean true if the requested sequence id was acked, false otherwise

GetReceivedWindow()

const UdpPacketIdWindow & AzNetworking::UdpPacketTracker::GetReceivedWindow ( ) const

inline

Const access to the packet trackers received window.

Returns

const reference to the packet trackers received window

GetSequencedAckHistory()

BitsetChunk & AzNetworking::UdpPacketTracker::GetSequencedAckHistory ( BitsetChunk &  outWindow ) const

inline

Returns a bit sequence representing the last received packets from the remote connection.

Parameters

outWindow

window to store the output bit sequence in

Returns

reference to the output parameter

ProcessReceived()

bool AzNetworking::UdpPacketTracker::ProcessReceived	(	UdpConnection *	connection,
		UdpPacketHeader &	header
	)

Process a received packet header.

Parameters

connection	the connection this packet was received on, used for ack callbacks
header	the packet header received to process

Returns

boolean true on successful handling of the received header

---

The documentation for this class was generated from the following files:

• Code/Framework/AzNetworking/AzNetworking/UdpTransport/UdpPacketTracker.h
• Code/Framework/AzNetworking/AzNetworking/UdpTransport/UdpPacketTracker.inl