recovery abstract class More...

#include "tcp-recovery-ops.h"

Inheritance diagram for ns3::TcpRecoveryOps:

Collaboration diagram for ns3::TcpRecoveryOps:

Public Member Functions
	TcpRecoveryOps ()
	Constructor.

	TcpRecoveryOps (const TcpRecoveryOps &other)
	Copy constructor.

	~TcpRecoveryOps () override
	Deconstructor.

virtual void	DoRecovery (Ptr< TcpSocketState > tcb, uint32_t deliveredBytes, bool isDupAck)=0
	Performs recovery based on the recovery algorithm.

virtual void	EnterRecovery (Ptr< TcpSocketState > tcb, uint32_t dupAckCount, uint32_t unAckDataCount, uint32_t deliveredBytes)=0
	Performs variable initialization at the start of recovery.

virtual void	ExitRecovery (Ptr< TcpSocketState > tcb)=0
	Performs cwnd adjustments at the end of recovery.

virtual Ptr< TcpRecoveryOps >	Fork ()=0
	Copy the recovery algorithm across socket.

virtual std::string	GetName () const =0
	Get the name of the recovery algorithm.

virtual void	UpdateBytesSent (uint32_t bytesSent)
	Keeps track of bytes sent during recovery phase.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

recovery abstract class

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:

EnterRecovery (when the first loss is guessed)
DoRecovery (each time a duplicate ACK or an ACK with SACK information is received)
ExitRecovery (when the sequence transmitted when the socket entered the Recovery phase is ACKed, therefore ending phase).

Each condition is represented by a pure virtual method.

See also: TcpClassicRecovery; DoRecovery

Config Paths

ns3::TcpRecoveryOps is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/$ns3::TcpL4Protocol/SocketList/[i]/RecoveryOps"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet

Size of this type is 56 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ TcpRecoveryOps() [1/2]

ns3::TcpRecoveryOps::TcpRecoveryOps ( )

Constructor.

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

References NS_LOG_FUNCTION.

◆ TcpRecoveryOps() [2/2]

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

Copy constructor.

Parameters

other object to copy.

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

References NS_LOG_FUNCTION.

◆ ~TcpRecoveryOps()

ns3::TcpRecoveryOps::~TcpRecoveryOps ( )

override

Deconstructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoRecovery()

virtual void ns3::TcpRecoveryOps::DoRecovery	(	Ptr< TcpSocketState >	tcb,
		uint32_t	deliveredBytes,
		bool	isDupAck )

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. The param isDupAck has been added to align PRR implementation with RFC 6937 bis-08.

Parameters

tcb	internal congestion state
deliveredBytes	bytes (S)ACKed in the last (S)ACK
isDupAck	Indicates if the last acknowledgement was duplicate.

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

◆ EnterRecovery()

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

pure virtual

Performs variable initialization at the start of recovery.

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

Parameters

tcb	internal congestion state
dupAckCount	duplicate acknowledgement count
unAckDataCount	total bytes of data unacknowledged
deliveredBytes	bytes (S)ACKed in the last (S)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

tcb	internal congestion state

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 ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ UpdateBytesSent()

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

virtual

Keeps track of bytes sent during recovery phase.

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

Parameters

bytesSent bytes sent

Reimplemented in ns3::TcpPrrRecovery.

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

References NS_LOG_FUNCTION.

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

src/internet/model/tcp-recovery-ops.h
src/internet/model/tcp-recovery-ops.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Constructor & Destructor Documentation

◆ TcpRecoveryOps() [1/2]

◆ TcpRecoveryOps() [2/2]

◆ ~TcpRecoveryOps()

Member Function Documentation

◆ DoRecovery()

◆ EnterRecovery()

◆ ExitRecovery()

◆ Fork()

◆ GetName()

◆ GetTypeId()

◆ UpdateBytesSent()