A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | List of all members
ns3::TcpRecoveryOps Class Referenceabstract

recovery abstract class More...

#include "tcp-recovery-ops.h"

+ Inheritance diagram for ns3::TcpRecoveryOps:

Public Member Functions

 TcpRecoveryOps ()
 Constructor. More...
 
 TcpRecoveryOps (const TcpRecoveryOps &other)
 Copy constructor. More...
 
virtual ~TcpRecoveryOps ()
 Deconstructor. More...
 
virtual void DoRecovery (Ptr< TcpSocketState > tcb, uint32_t lastAckedBytes, uint32_t lastSackedBytes)=0
 Performs recovery based on the recovery algorithm. More...
 
virtual void EnterRecovery (Ptr< TcpSocketState > tcb, uint32_t dupAckCount, uint32_t unAckDataCount, uint32_t lastSackedBytes)=0
 Performs variable initialization at the start of recovery. More...
 
virtual void ExitRecovery (Ptr< TcpSocketState > tcb)=0
 Performs cwnd adjustments at the end of recovery. More...
 
virtual Ptr< TcpRecoveryOpsFork ()=0
 Copy the recovery algorithm across socket. More...
 
virtual std::string GetName () const =0
 Get the name of the recovery algorithm. 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::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

recovery abstract class


Introspection did not find any typical Config paths.

The design is inspired by the TcpCongestionOps class in ns-3. The fast recovery is split from the main socket code, and it is a pluggable component. Subclasses of TcpRecoveryOps should modify TcpSocketState variables upon three condition:

Each condition is represented by a pure virtual method.

See also
TcpClassicRecovery
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 59 of file tcp-recovery-ops.h.

Constructor & Destructor Documentation

◆ TcpRecoveryOps() [1/2]

ns3::TcpRecoveryOps::TcpRecoveryOps ( )

Constructor.

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

References NS_LOG_FUNCTION.

◆ TcpRecoveryOps() [2/2]

ns3::TcpRecoveryOps::TcpRecoveryOps ( const TcpRecoveryOps other)

Copy constructor.

Parameters
otherobject to copy.

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

References NS_LOG_FUNCTION.

◆ ~TcpRecoveryOps()

ns3::TcpRecoveryOps::~TcpRecoveryOps ( )
virtual

Deconstructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoRecovery()

virtual void ns3::TcpRecoveryOps::DoRecovery ( Ptr< TcpSocketState tcb,
uint32_t  lastAckedBytes,
uint32_t  lastSackedBytes 
)
pure virtual

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.

TODO: lastAckedBytes and lastSackedBytes should be one parameter that indicates how much data has been ACKed or SACKed.

Parameters
tcbinternal congestion state
lastAckedBytesbytes acknowledged in the last ACK
lastSackedBytesbytes acknowledged via SACK in the last ACK

Implemented in ns3::TcpClassicRecovery, and ns3::TcpPrrRecovery.

◆ EnterRecovery()

virtual void ns3::TcpRecoveryOps::EnterRecovery ( Ptr< TcpSocketState tcb,
uint32_t  dupAckCount,
uint32_t  unAckDataCount,
uint32_t  lastSackedBytes 
)
pure virtual

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
lastSackedBytesbytes acknowledged via SACK in the last ACK

Implemented in ns3::TcpClassicRecovery, and ns3::TcpPrrRecovery.

◆ ExitRecovery()

virtual void ns3::TcpRecoveryOps::ExitRecovery ( Ptr< TcpSocketState tcb)
pure virtual

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

Implemented in ns3::TcpClassicRecovery, and ns3::TcpPrrRecovery.

◆ Fork()

virtual Ptr<TcpRecoveryOps> ns3::TcpRecoveryOps::Fork ( )
pure virtual

Copy the recovery algorithm across socket.

Returns
a pointer of the copied object

Implemented in ns3::TcpClassicRecovery, and ns3::TcpPrrRecovery.

◆ GetName()

virtual std::string ns3::TcpRecoveryOps::GetName ( ) const
pure virtual

Get the name of the recovery algorithm.

Returns
A string identifying the name

Implemented in ns3::TcpClassicRecovery, and ns3::TcpPrrRecovery.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

◆ UpdateBytesSent()

virtual void ns3::TcpRecoveryOps::UpdateBytesSent ( uint32_t  bytesSent)
inlinevirtual

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 in ns3::TcpPrrRecovery.

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

References NS_UNUSED.


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