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

TCP-LP (Low Priority) congestion control algorithm. More...

#include "tcp-lp.h"

+ Inheritance diagram for ns3::TcpLp:
+ Collaboration diagram for ns3::TcpLp:

Public Member Functions

 TcpLp (const TcpLp &sock)
 Copy constructor. More...
 
 TcpLp (void)
 Creates an unbound tcp socket. More...
 
virtual ~TcpLp (void)
 
virtual Ptr< TcpCongestionOpsFork ()
 Copy the congestion control algorithm across sockets. More...
 
virtual std::string GetName () const
 Get the name of the 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::TcpNewReno
 TcpNewReno ()
 
 TcpNewReno (const TcpNewReno &sock)
 Copy constructor. More...
 
 ~TcpNewReno ()
 
virtual uint32_t GetSsThresh (Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight)
 Get the slow start threshold after a loss event. More...
 
virtual void IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
 Try to increase the cWnd following the NewReno specification. More...
 
- Public Member Functions inherited from ns3::TcpCongestionOps
 TcpCongestionOps ()
 
 TcpCongestionOps (const TcpCongestionOps &other)
 Copy constructor. More...
 
virtual ~TcpCongestionOps ()
 
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 ([[maybe_unused]] Ptr< TcpSocketState > tcb)
 Set configuration required by congestion control algorithm. 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<>
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...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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::TcpNewReno
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TcpCongestionOps
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...
 

Protected Member Functions

virtual void CongestionAvoidance (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
 Invokes Congestion Avoidance of TcpNewReno if TcpLp is not within inference. More...
 
- Protected Member Functions inherited from ns3::TcpNewReno
virtual uint32_t SlowStart (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
 Tcp NewReno slow start algorithm. More...
 
- 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...
 

Private Types

enum  State { LP_VALID_OWD = (1 << 1) , LP_WITHIN_THR = (1 << 3) , LP_WITHIN_INF = (1 << 4) }
 Describes the state of TcpLp. More...
 

Private Member Functions

uint32_t OwdCalculator (Ptr< TcpSocketState > tcb)
 Calculates One-Way Delay using Sender and Receiver timestamps. More...
 
void RttSample (Ptr< TcpSocketState > tcb)
 Estimates minimum and maximum One-Way Delays and calculates the smoothed One-Way Delay. More...
 

Private Attributes

uint32_t m_flag
 TcpLp state flag. More...
 
Time m_inference
 Current inference period. More...
 
Time m_lastDrop
 Last time when cwnd was reduced. More...
 
uint32_t m_owdMax
 Maximum One-Way Delay. More...
 
uint32_t m_owdMaxRsv
 Reserved Maximum One-Way Delay. More...
 
uint32_t m_owdMin
 Minimum One-Way Delay. More...
 
uint32_t m_sOwd
 Smoothed One-Way Delay. More...
 

Additional Inherited Members

Detailed Description

TCP-LP (Low Priority) congestion control algorithm.

Config Paths

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

  • "/NodeList/[i]/$ns3::TcpL4Protocol/SocketList/[i]/CongestionOps/$ns3::TcpNewReno/$ns3::TcpLp"
  • "/NodeList/[i]/$ns3::TcpL4Protocol/SocketList/[i]/CongestionOps/$ns3::TcpLp"

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

Definition at line 40 of file tcp-lp.h.

Member Enumeration Documentation

◆ State

enum ns3::TcpLp::State
private

Describes the state of TcpLp.

Enumerator
LP_VALID_OWD 

Calculated One-Way Delay is valid.

LP_WITHIN_THR 

TcpLp is within Threshold.

LP_WITHIN_INF 

TcpLp is within Inference.

Definition at line 96 of file tcp-lp.h.

Constructor & Destructor Documentation

◆ TcpLp() [1/2]

ns3::TcpLp::TcpLp ( void  )

Creates an unbound tcp socket.

Definition at line 45 of file tcp-lp.cc.

References NS_LOG_FUNCTION.

◆ TcpLp() [2/2]

ns3::TcpLp::TcpLp ( const TcpLp sock)

Copy constructor.

Parameters
sockthe object to copy

Definition at line 58 of file tcp-lp.cc.

References NS_LOG_FUNCTION.

◆ ~TcpLp()

ns3::TcpLp::~TcpLp ( void  )
virtual

Definition at line 71 of file tcp-lp.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CongestionAvoidance()

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

Invokes Congestion Avoidance of TcpNewReno if TcpLp is not within inference.

Parameters
tcbinternal congestion state
segmentsAckedcount of segments acked

Reimplemented from ns3::TcpNewReno.

Definition at line 83 of file tcp-lp.cc.

References ns3::TcpNewReno::CongestionAvoidance(), LP_WITHIN_INF, m_flag, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Fork()

Ptr< TcpCongestionOps > ns3::TcpLp::Fork ( )
virtual

Copy the congestion control algorithm across sockets.

Returns
a pointer of the copied object

Reimplemented from ns3::TcpNewReno.

Definition at line 77 of file tcp-lp.cc.

◆ GetName()

std::string ns3::TcpLp::GetName ( ) const
virtual

Get the name of the congestion control algorithm.

Returns
A string identifying the name

Reimplemented from ns3::TcpNewReno.

Definition at line 234 of file tcp-lp.cc.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file tcp-lp.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ OwdCalculator()

uint32_t ns3::TcpLp::OwdCalculator ( Ptr< TcpSocketState tcb)
private

Calculates One-Way Delay using Sender and Receiver timestamps.

Parameters
tcbinternal congestion state
Returns
One-Way Delay

Definition at line 94 of file tcp-lp.cc.

References LP_VALID_OWD, m_flag, ns3::TcpSocketState::m_rcvTimestampEchoReply, ns3::TcpSocketState::m_rcvTimestampValue, and NS_LOG_FUNCTION.

Referenced by RttSample().

+ Here is the caller graph for this function:

◆ PktsAcked()

void ns3::TcpLp::PktsAcked ( Ptr< TcpSocketState tcb,
uint32_t  segmentsAcked,
const Time rtt 
)
virtual

Timing information on received ACK.

The function is called every time an ACK is received. It determines the state of TcpLp and adjusts the congestion window accordingly.

Parameters
tcbinternal congestion state
segmentsAckedcount of segments acked
rttlast rtt

Reimplemented from ns3::TcpCongestionOps.

Definition at line 168 of file tcp-lp.cc.

References ns3::TracedValue< T >::Get(), ns3::Time::GetMilliSeconds(), ns3::Time::IsZero(), LP_WITHIN_INF, LP_WITHIN_THR, ns3::TcpSocketState::m_cWnd, m_flag, m_inference, m_lastDrop, m_owdMax, m_owdMaxRsv, m_owdMin, ns3::TcpSocketState::m_rcvTimestampEchoReply, ns3::TcpSocketState::m_segmentSize, m_sOwd, max, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and RttSample().

+ Here is the call graph for this function:

◆ RttSample()

void ns3::TcpLp::RttSample ( Ptr< TcpSocketState tcb)
private

Estimates minimum and maximum One-Way Delays and calculates the smoothed One-Way Delay.

Parameters
tcbinternal congestion state

Definition at line 118 of file tcp-lp.cc.

References LP_VALID_OWD, m_flag, m_owdMax, m_owdMaxRsv, m_owdMin, m_sOwd, NS_LOG_FUNCTION, and OwdCalculator().

Referenced by PktsAcked().

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

Member Data Documentation

◆ m_flag

uint32_t ns3::TcpLp::m_flag
private

TcpLp state flag.

Definition at line 103 of file tcp-lp.h.

Referenced by CongestionAvoidance(), OwdCalculator(), PktsAcked(), and RttSample().

◆ m_inference

Time ns3::TcpLp::m_inference
private

Current inference period.

Definition at line 109 of file tcp-lp.h.

Referenced by PktsAcked().

◆ m_lastDrop

Time ns3::TcpLp::m_lastDrop
private

Last time when cwnd was reduced.

Definition at line 108 of file tcp-lp.h.

Referenced by PktsAcked().

◆ m_owdMax

uint32_t ns3::TcpLp::m_owdMax
private

Maximum One-Way Delay.

Definition at line 106 of file tcp-lp.h.

Referenced by PktsAcked(), and RttSample().

◆ m_owdMaxRsv

uint32_t ns3::TcpLp::m_owdMaxRsv
private

Reserved Maximum One-Way Delay.

Definition at line 107 of file tcp-lp.h.

Referenced by PktsAcked(), and RttSample().

◆ m_owdMin

uint32_t ns3::TcpLp::m_owdMin
private

Minimum One-Way Delay.

Definition at line 105 of file tcp-lp.h.

Referenced by PktsAcked(), and RttSample().

◆ m_sOwd

uint32_t ns3::TcpLp::m_sOwd
private

Smoothed One-Way Delay.

Definition at line 104 of file tcp-lp.h.

Referenced by PktsAcked(), and RttSample().


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