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

Reno congestion control algorithm. More...

#include "tcp-linux-reno.h"

+ Inheritance diagram for ns3::TcpLinuxReno:
+ Collaboration diagram for ns3::TcpLinuxReno:

Public Member Functions

 TcpLinuxReno ()
 
 TcpLinuxReno (const TcpLinuxReno &sock)
 Copy constructor. More...
 
 ~TcpLinuxReno () override
 
Ptr< TcpCongestionOpsFork () override
 Copy the congestion control algorithm across sockets. More...
 
std::string GetName () const override
 Get the name of the congestion control algorithm. More...
 
uint32_t GetSsThresh (Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight) override
 Get the slow start threshold after a loss event. More...
 
void IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) override
 Congestion avoidance algorithm implementation. More...
 
- Public Member Functions inherited from ns3::TcpCongestionOps
 TcpCongestionOps ()
 
 TcpCongestionOps (const TcpCongestionOps &other)
 Copy constructor. More...
 
 ~TcpCongestionOps () override
 
virtual void CongControl (Ptr< TcpSocketState > tcb, const TcpRateOps::TcpRateConnection &rc, const TcpRateOps::TcpRateSample &rs)
 Called when packets are delivered to update cwnd and pacing rate. More...
 
virtual void CongestionStateSet (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCongState_t newState)
 Trigger events/calculations specific to a congestion state. More...
 
virtual void CwndEvent (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event)
 Trigger events/calculations on occurrence of congestion window event. More...
 
virtual bool HasCongControl () const
 Returns true when Congestion Control Algorithm implements CongControl. More...
 
virtual void Init (Ptr< TcpSocketState > tcb[[maybe_unused]])
 Set configuration required by congestion control algorithm. More...
 
virtual void PktsAcked (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt)
 Timing information on received ACK. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TcpCongestionOps
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

virtual void CongestionAvoidance (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
 Congestion avoidance phase handler. More...
 
virtual uint32_t SlowStart (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
 Slow start phase handler. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Attributes

uint32_t m_cWndCnt {0}
 Linear increase counter. More...
 

Additional Inherited Members

Detailed Description

Reno congestion control algorithm.

This class implement the Reno congestion control type and it mimics the one implemented in the Linux kernel.

Definition at line 39 of file tcp-linux-reno.h.

Constructor & Destructor Documentation

◆ TcpLinuxReno() [1/2]

ns3::TcpLinuxReno::TcpLinuxReno ( )

Definition at line 43 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION.

◆ TcpLinuxReno() [2/2]

ns3::TcpLinuxReno::TcpLinuxReno ( const TcpLinuxReno sock)

Copy constructor.

Parameters
sockobject to copy.

Definition at line 49 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION.

◆ ~TcpLinuxReno()

ns3::TcpLinuxReno::~TcpLinuxReno ( )
override

Definition at line 55 of file tcp-linux-reno.cc.

Member Function Documentation

◆ CongestionAvoidance()

void ns3::TcpLinuxReno::CongestionAvoidance ( Ptr< TcpSocketState tcb,
uint32_t  segmentsAcked 
)
protectedvirtual

Congestion avoidance phase handler.

Parameters
tcbTransmission Control Block of the connection
segmentsAckedcount of segments acked

Definition at line 78 of file tcp-linux-reno.cc.

References two-ray-to-three-gpp-ch-calibration::delta, ns3::TcpSocketState::m_cWnd, m_cWndCnt, ns3::TcpSocketState::m_segmentSize, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by IncreaseWindow().

+ Here is the caller graph for this function:

◆ Fork()

Ptr< TcpCongestionOps > ns3::TcpLinuxReno::Fork ( )
overridevirtual

Copy the congestion control algorithm across sockets.

Returns
a pointer of the copied object

Implements ns3::TcpCongestionOps.

Definition at line 148 of file tcp-linux-reno.cc.

◆ GetName()

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

Get the name of the congestion control algorithm.

Returns
A string identifying the name

Implements ns3::TcpCongestionOps.

Definition at line 133 of file tcp-linux-reno.cc.

◆ GetSsThresh()

uint32_t ns3::TcpLinuxReno::GetSsThresh ( Ptr< const TcpSocketState tcb,
uint32_t  bytesInFlight 
)
overridevirtual

Get the slow start threshold after a loss event.

Is guaranteed that the congestion control state (TcpAckState_t) is changed BEFORE the invocation of this method. The implementer should return the slow start threshold (and not change it directly) because, in the future, the TCP implementation may require to instantly recover from a loss event (e.g. when there is a network with an high reordering factor).

Parameters
tcbinternal congestion state
bytesInFlighttotal bytes in flight
Returns
Slow start threshold

Implements ns3::TcpCongestionOps.

Definition at line 139 of file tcp-linux-reno.cc.

References NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 34 of file tcp-linux-reno.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IncreaseWindow()

void ns3::TcpLinuxReno::IncreaseWindow ( Ptr< TcpSocketState tcb,
uint32_t  segmentsAcked 
)
overridevirtual

Congestion avoidance algorithm implementation.

Mimic the function cong_avoid in Linux. New segments have been ACKed, and the congestion control duty is to update the window.

The function is allowed to change directly cWnd and/or ssThresh.

Parameters
tcbinternal congestion state
segmentsAckedcount of segments acked

Reimplemented from ns3::TcpCongestionOps.

Definition at line 114 of file tcp-linux-reno.cc.

References CongestionAvoidance(), ns3::TcpSocketState::m_cWnd, ns3::TcpSocketState::m_ssThresh, NS_LOG_DEBUG, NS_LOG_FUNCTION, and SlowStart().

+ Here is the call graph for this function:

◆ SlowStart()

uint32_t ns3::TcpLinuxReno::SlowStart ( Ptr< TcpSocketState tcb,
uint32_t  segmentsAcked 
)
protectedvirtual

Slow start phase handler.

Parameters
tcbTransmission Control Block of the connection
segmentsAckedcount of segments acked
Returns
Number of segments acked minus the difference between the receiver and sender Cwnd

Definition at line 60 of file tcp-linux-reno.cc.

References ns3::TcpSocketState::m_cWnd, ns3::TcpSocketState::m_segmentSize, ns3::TcpSocketState::m_ssThresh, min, NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by IncreaseWindow().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cWndCnt

uint32_t ns3::TcpLinuxReno::m_cWndCnt {0}
private

Linear increase counter.

Definition at line 80 of file tcp-linux-reno.h.

Referenced by CongestionAvoidance().


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