A Discrete-Event Network Simulator
API
ns3::TcpPrrRecovery Class Reference

An implementation of PRR. More...

#include "tcp-prr-recovery.h"

+ Inheritance diagram for ns3::TcpPrrRecovery:
+ Collaboration diagram for ns3::TcpPrrRecovery:

Public Types

enum  ReductionBound_t { CRB, SSRB }
 Reduction Bound variant (CRB or SSRB) More...
 

Public Member Functions

 TcpPrrRecovery (void)
 Create an unbound tcp socket. More...
 
 TcpPrrRecovery (const TcpPrrRecovery &sock)
 Copy constructor. More...
 
virtual ~TcpPrrRecovery (void) override
 
virtual void DoRecovery (Ptr< TcpSocketState > tcb, uint32_t deliveredBytes) override
 Performs recovery based on the recovery algorithm. More...
 
virtual void EnterRecovery (Ptr< TcpSocketState > tcb, uint32_t dupAckCount, uint32_t unAckDataCount, uint32_t deliveredBytes) override
 Performs variable initialization at the start of recovery. More...
 
virtual void ExitRecovery (Ptr< TcpSocketState > tcb) override
 Performs cwnd adjustments at the end of recovery. More...
 
virtual Ptr< TcpRecoveryOpsFork () override
 Copy the recovery algorithm across socket. More...
 
std::string GetName () const override
 Get the name of the recovery algorithm. More...
 
virtual void UpdateBytesSent (uint32_t bytesSent) override
 Keeps track of bytes sent during recovery phase. More...
 
- Public Member Functions inherited from ns3::TcpClassicRecovery
 TcpClassicRecovery ()
 Constructor. More...
 
 TcpClassicRecovery (const TcpClassicRecovery &recovery)
 Copy constructor. More...
 
virtual ~TcpClassicRecovery () override
 Constructor. More...
 
- Public Member Functions inherited from ns3::TcpRecoveryOps
 TcpRecoveryOps ()
 Constructor. More...
 
 TcpRecoveryOps (const TcpRecoveryOps &other)
 Copy constructor. More...
 
virtual ~TcpRecoveryOps ()
 Deconstructor. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TcpClassicRecovery
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TcpRecoveryOps
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint32_t m_prrDelivered {0}
 total bytes delivered during recovery phase More...
 
uint32_t m_prrOut {0}
 total bytes sent during recovery phase More...
 
uint32_t m_recoveryFlightSize {0}
 value of bytesInFlight at the start of recovery phase More...
 
ReductionBound_t m_reductionBoundMode {SSRB}
 mode of Reduction Bound to be used More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

An implementation of PRR.


Introspection did not find any typical Config paths.

PRR is an algorithm that determines TCP's sending rate in fast recovery. PRR avoids excessive window reductions and aims for the actual congestion window size at the end of recovery to be as close as possible to the window determined by the congestion control algorithm. PRR also improves accuracy of the amount of data sent during loss recovery.


Attributes

  • ReductionBound: Type of Reduction Bound
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: SSRB
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).

Definition at line 42 of file tcp-prr-recovery.h.

Member Enumeration Documentation

◆ ReductionBound_t

Reduction Bound variant (CRB or SSRB)

Enumerator
CRB 

Conservative Reduction Bound.

SSRB 

Slow Start Reduction Bound.

Definition at line 67 of file tcp-prr-recovery.h.

Constructor & Destructor Documentation

◆ TcpPrrRecovery() [1/2]

ns3::TcpPrrRecovery::TcpPrrRecovery ( void  )

Create an unbound tcp socket.

Definition at line 50 of file tcp-prr-recovery.cc.

References NS_LOG_FUNCTION.

◆ TcpPrrRecovery() [2/2]

ns3::TcpPrrRecovery::TcpPrrRecovery ( const TcpPrrRecovery sock)

Copy constructor.

Parameters
sockthe object to copy

Definition at line 56 of file tcp-prr-recovery.cc.

References NS_LOG_FUNCTION.

◆ ~TcpPrrRecovery()

ns3::TcpPrrRecovery::~TcpPrrRecovery ( void  )
overridevirtual

Definition at line 66 of file tcp-prr-recovery.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoRecovery()

void ns3::TcpPrrRecovery::DoRecovery ( Ptr< TcpSocketState tcb,
uint32_t  deliveredBytes 
)
overridevirtual

Performs recovery based on the recovery algorithm.

The function is called on arrival of every ack when TcpSocketState is set to CA_RECOVERY. It performs the necessary cwnd changes as per the recovery algorithm.

Parameters
tcbinternal congestion state
deliveredBytesbytes (S)ACKed in the last (S)ACK

Reimplemented from ns3::TcpClassicRecovery.

Definition at line 86 of file tcp-prr-recovery.cc.

References CRB, ns3::TcpSocketState::m_bytesInFlight, ns3::TcpSocketState::m_cWnd, ns3::TcpSocketState::m_cWndInfl, m_prrDelivered, m_prrOut, m_recoveryFlightSize, m_reductionBoundMode, ns3::TcpSocketState::m_segmentSize, ns3::TcpSocketState::m_ssThresh, max, min, NS_LOG_FUNCTION, and SSRB.

Referenced by PrrRecoveryTest::DoRun(), and EnterRecovery().

+ Here is the caller graph for this function:

◆ EnterRecovery()

void ns3::TcpPrrRecovery::EnterRecovery ( Ptr< TcpSocketState tcb,
uint32_t  dupAckCount,
uint32_t  unAckDataCount,
uint32_t  deliveredBytes 
)
overridevirtual

Performs variable initialization at the start of recovery.

The function is called when the TcpSocketState is changed to CA_RECOVERY.

Parameters
tcbinternal congestion state
dupAckCountduplicate acknowldgement count
unAckDataCounttotal bytes of data unacknowledged
deliveredBytesbytes (S)ACKed in the last (S)ACK

Reimplemented from ns3::TcpClassicRecovery.

Definition at line 72 of file tcp-prr-recovery.cc.

References DoRecovery(), m_prrDelivered, m_prrOut, m_recoveryFlightSize, NS_LOG_FUNCTION, and NS_UNUSED.

Referenced by PrrRecoveryTest::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ExitRecovery()

void ns3::TcpPrrRecovery::ExitRecovery ( Ptr< TcpSocketState tcb)
overridevirtual

Performs cwnd adjustments at the end of recovery.

The function is called when the TcpSocketState is changed from CA_RECOVERY.

Parameters
tcbinternal congestion state
isSackEnabled

Reimplemented from ns3::TcpClassicRecovery.

Definition at line 117 of file tcp-prr-recovery.cc.

References ns3::TracedValue< T >::Get(), ns3::TcpSocketState::m_cWnd, ns3::TcpSocketState::m_cWndInfl, ns3::TcpSocketState::m_ssThresh, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Fork()

Ptr< TcpRecoveryOps > ns3::TcpPrrRecovery::Fork ( )
overridevirtual

Copy the recovery algorithm across socket.

Returns
a pointer of the copied object

Reimplemented from ns3::TcpClassicRecovery.

Definition at line 132 of file tcp-prr-recovery.cc.

◆ GetName()

std::string ns3::TcpPrrRecovery::GetName ( ) const
overridevirtual

Get the name of the recovery algorithm.

Returns
A string identifying the name

Reimplemented from ns3::TcpClassicRecovery.

Definition at line 138 of file tcp-prr-recovery.cc.

◆ GetTypeId()

TypeId ns3::TcpPrrRecovery::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file tcp-prr-recovery.cc.

References CRB, m_reductionBoundMode, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::TypeId::SetParent(), and SSRB.

+ Here is the call graph for this function:

◆ UpdateBytesSent()

void ns3::TcpPrrRecovery::UpdateBytesSent ( uint32_t  bytesSent)
overridevirtual

Keeps track of bytes sent during recovery phase.

The function is called whenever a data packet is sent during recovery phase (optional).

Parameters
bytesSentbytes sent

Reimplemented from ns3::TcpRecoveryOps.

Definition at line 125 of file tcp-prr-recovery.cc.

References m_prrOut, and NS_LOG_FUNCTION.

Referenced by PrrRecoveryTest::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_prrDelivered

uint32_t ns3::TcpPrrRecovery::m_prrDelivered {0}
private

total bytes delivered during recovery phase

Definition at line 87 of file tcp-prr-recovery.h.

Referenced by DoRecovery(), and EnterRecovery().

◆ m_prrOut

uint32_t ns3::TcpPrrRecovery::m_prrOut {0}
private

total bytes sent during recovery phase

Definition at line 88 of file tcp-prr-recovery.h.

Referenced by DoRecovery(), EnterRecovery(), and UpdateBytesSent().

◆ m_recoveryFlightSize

uint32_t ns3::TcpPrrRecovery::m_recoveryFlightSize {0}
private

value of bytesInFlight at the start of recovery phase

Definition at line 89 of file tcp-prr-recovery.h.

Referenced by DoRecovery(), and EnterRecovery().

◆ m_reductionBoundMode

ReductionBound_t ns3::TcpPrrRecovery::m_reductionBoundMode {SSRB}
private

mode of Reduction Bound to be used

Definition at line 90 of file tcp-prr-recovery.h.

Referenced by DoRecovery(), and GetTypeId().


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