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

The Classic recovery implementation. More...

#include "tcp-recovery-ops.h"

+ Inheritance diagram for ns3::TcpClassicRecovery:
+ Collaboration diagram for ns3::TcpClassicRecovery:

Public Member Functions

 TcpClassicRecovery ()
 Constructor. More...
 
 TcpClassicRecovery (const TcpClassicRecovery &recovery)
 Copy constructor. More...
 
virtual ~TcpClassicRecovery () override
 Constructor. More...
 
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...
 
virtual std::string GetName () const override
 Get the name of the recovery algorithm. More...
 
- Public Member Functions inherited from ns3::TcpRecoveryOps
 TcpRecoveryOps ()
 Constructor. More...
 
 TcpRecoveryOps (const TcpRecoveryOps &other)
 Copy constructor. More...
 
virtual ~TcpRecoveryOps ()
 Deconstructor. More...
 
virtual void UpdateBytesSent (uint32_t bytesSent)
 Keeps track of bytes sent during recovery phase. 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::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...
 

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

The Classic recovery implementation.


Introspection did not find any typical Config paths.

Classic recovery refers to the two well-established recovery algorithms, namely, NewReno (RFC 6582) and SACK based recovery (RFC 6675).

The idea of the algorithm is that when we enter recovery, we set the congestion window value to the slow start threshold and maintain it at such value until we are fully recovered (in other words, until the highest sequence transmitted at time of detecting the loss is ACKed by the receiver).

See also
DoRecovery


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

Definition at line 158 of file tcp-recovery-ops.h.

Constructor & Destructor Documentation

◆ TcpClassicRecovery() [1/2]

ns3::TcpClassicRecovery::TcpClassicRecovery ( void  )

Constructor.

Definition at line 79 of file tcp-recovery-ops.cc.

References NS_LOG_FUNCTION.

◆ TcpClassicRecovery() [2/2]

ns3::TcpClassicRecovery::TcpClassicRecovery ( const TcpClassicRecovery recovery)

Copy constructor.

Parameters
recoveryobject to copy.

Definition at line 84 of file tcp-recovery-ops.cc.

References NS_LOG_FUNCTION.

◆ ~TcpClassicRecovery()

ns3::TcpClassicRecovery::~TcpClassicRecovery ( void  )
overridevirtual

Constructor.

Definition at line 90 of file tcp-recovery-ops.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoRecovery()

void ns3::TcpClassicRecovery::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

Implements ns3::TcpRecoveryOps.

Reimplemented in ns3::TcpPrrRecovery.

Definition at line 107 of file tcp-recovery-ops.cc.

References ns3::TcpSocketState::m_cWndInfl, ns3::TcpSocketState::m_segmentSize, NS_LOG_FUNCTION, and NS_UNUSED.

Referenced by ClassicRecoveryTest::DoRun().

+ Here is the caller graph for this function:

◆ EnterRecovery()

void ns3::TcpClassicRecovery::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

Implements ns3::TcpRecoveryOps.

Reimplemented in ns3::TcpPrrRecovery.

Definition at line 96 of file tcp-recovery-ops.cc.

References ns3::TcpSocketState::m_cWnd, ns3::TcpSocketState::m_cWndInfl, ns3::TcpSocketState::m_segmentSize, ns3::TcpSocketState::m_ssThresh, NS_LOG_FUNCTION, and NS_UNUSED.

Referenced by ClassicRecoveryTest::DoRun().

+ Here is the caller graph for this function:

◆ ExitRecovery()

void ns3::TcpClassicRecovery::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

Implements ns3::TcpRecoveryOps.

Reimplemented in ns3::TcpPrrRecovery.

Definition at line 115 of file tcp-recovery-ops.cc.

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

Referenced by ClassicRecoveryTest::DoRun().

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

◆ Fork()

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

Copy the recovery algorithm across socket.

Returns
a pointer of the copied object

Implements ns3::TcpRecoveryOps.

Reimplemented in ns3::TcpPrrRecovery.

Definition at line 133 of file tcp-recovery-ops.cc.

◆ GetName()

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

Get the name of the recovery algorithm.

Returns
A string identifying the name

Implements ns3::TcpRecoveryOps.

Reimplemented in ns3::TcpPrrRecovery.

Definition at line 127 of file tcp-recovery-ops.cc.

Referenced by ClassicRecoveryTest::DoRun().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 69 of file tcp-recovery-ops.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::TcpL4Protocol::GetTypeId().

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

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