An implementation of PRR. More...

#include "tcp-prr-recovery.h"

Inheritance diagram for ns3::TcpPrrRecovery:

Collaboration diagram for ns3::TcpPrrRecovery:

Public Member Functions
	TcpPrrRecovery ()
	Create an unbound tcp socket.

	TcpPrrRecovery (const TcpPrrRecovery &sock)
	Copy constructor.

	~TcpPrrRecovery () override

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

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

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

Ptr< TcpRecoveryOps >	Fork () override
	Copy the recovery algorithm across socket.

std::string	GetName () const override
	Get the name of the recovery algorithm.

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

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

	TcpClassicRecovery (const TcpClassicRecovery &recovery)
	Copy constructor.

	~TcpClassicRecovery () override
	Constructor.

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

	TcpRecoveryOps (const TcpRecoveryOps &other)
	Copy constructor.

	~TcpRecoveryOps () override
	Deconstructor.

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 override
	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::TcpClassicRecovery
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::TcpRecoveryOps
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.

Private Attributes
uint32_t	m_prrDelivered {0}
	total bytes delivered during recovery phase

uint32_t	m_prrOut {0}
	total bytes sent during recovery phase

uint32_t	m_recoveryFlightSize {0}
	value of bytesInFlight at the start of recovery phase

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

An implementation of PRR.

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.

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

Constructor & Destructor Documentation

◆ TcpPrrRecovery() [1/2]

ns3::TcpPrrRecovery::TcpPrrRecovery ( )

Create an unbound tcp socket.

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

References NS_LOG_FUNCTION.

◆ TcpPrrRecovery() [2/2]

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

Copy constructor.

Parameters

sock	the object to copy

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

References NS_LOG_FUNCTION.

◆ ~TcpPrrRecovery()

ns3::TcpPrrRecovery::~TcpPrrRecovery ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoRecovery()

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

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. 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.

Reimplemented from ns3::TcpClassicRecovery.

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

References m_prrDelivered, m_prrOut, m_recoveryFlightSize, and NS_LOG_FUNCTION.

Referenced by 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

tcb	internal congestion state
dupAckCount	duplicate acknowledgement count
unAckDataCount	total bytes of data unacknowledged
deliveredBytes	bytes (S)ACKed in the last (S)ACK

Reimplemented from ns3::TcpClassicRecovery.

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

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

Here is the call 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

tcb	internal congestion state

Reimplemented from ns3::TcpClassicRecovery.

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

References NS_LOG_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.

References ns3::Object::CopyObject.

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

static

Get the type ID.

Returns: the object TypeId

Definition at line 25 of file tcp-prr-recovery.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:

◆ 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

bytesSent bytes sent

Reimplemented from ns3::TcpRecoveryOps.

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

References m_prrOut, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_prrDelivered

uint32_t ns3::TcpPrrRecovery::m_prrDelivered {0}

private

total bytes delivered during recovery phase

Definition at line 69 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 70 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 71 of file tcp-prr-recovery.h.

Referenced by DoRecovery(), and EnterRecovery().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpPrrRecovery() [1/2]

◆ TcpPrrRecovery() [2/2]

◆ ~TcpPrrRecovery()

Member Function Documentation

◆ DoRecovery()

◆ EnterRecovery()

◆ ExitRecovery()

◆ Fork()

◆ GetName()

◆ GetTypeId()

◆ UpdateBytesSent()

Member Data Documentation

◆ m_prrDelivered

◆ m_prrOut

◆ m_recoveryFlightSize