ProtocolStack::RateManager Class Reference

List of all members.

Public Member Functions
	RateManager (RemoteHostComms remoteHost)
void	ResetConnection ()
RateInfo	GetRateInfoForTx (bool IsAckable)
void	ProcessReceivedSegmentHeaders (ref SegmentHeaders headers, uint dataLength)
void	DecreaseSendCredit (int amount)
bool	WaitForSend (uint datagramSize, int secondsToWait)
bool	CanSend (uint datagramSize)

---

Detailed Description

<summary> Controls the rate at which packets are sent across the network </summary>

Definition at line 9 of file ProtocolStack/RateManager.cs.

---

Constructor & Destructor Documentation

ProtocolStack::RateManager::RateManager (  RemoteHostComms  remoteHost  )  [inline]

Constructors * Definition at line 27 of file ProtocolStack/RateManager.cs. References ProtocolStack::RemoteHostComms::thisStack.

---

Member Function Documentation

bool ProtocolStack::RateManager::CanSend (  uint  datagramSize  )  [inline]

<summary> Determines if there is enough credit to send a datagram </summary> <param name="datagramSize">The number of bytes of data contained in the datagram</param> <returns>True if there is sufficient credit to send, false otherwise</returns> Definition at line 144 of file ProtocolStack/RateManager.cs.

void ProtocolStack::RateManager::DecreaseSendCredit (  int  amount  )  [inline]

<summary> Reduces the amount of send credit available </summary> <param name="amount">number of bytes to decrea</param> Definition at line 109 of file ProtocolStack/RateManager.cs.

RateInfo ProtocolStack::RateManager::GetRateInfoForTx (  bool  IsAckable  )  [inline]

Methods * Definition at line 55 of file ProtocolStack/RateManager.cs.

void ProtocolStack::RateManager::ProcessReceivedSegmentHeaders (  ref SegmentHeaders  headers, uint  dataLength )  [inline]

<summary> Adjusts credit information according to the received segment </summary> <param name="headers"></param> <param name="dataLength"></param> Definition at line 79 of file ProtocolStack/RateManager.cs.

void ProtocolStack::RateManager::ResetConnection (   )  [inline]

<summary> Resets state after a connection goes down </summary> Definition at line 37 of file ProtocolStack/RateManager.cs.

bool ProtocolStack::RateManager::WaitForSend (  uint  datagramSize, int  secondsToWait )  [inline]

<summary> Determines if there is enough credit to send a datagram </summary> <param name="datagramSize">The number of bytes of data contained in the datagram</param> <returns>True if we got the lock back in time, false if timer expired</returns> Definition at line 125 of file ProtocolStack/RateManager.cs.

---

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

• ProtocolStack/RateManager.cs

---