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

An implementation of the H-TCP variant of TCP. More...

#include "tcp-htcp.h"

+ Inheritance diagram for ns3::TcpHtcp:
+ Collaboration diagram for ns3::TcpHtcp:

Public Member Functions

 TcpHtcp (void)
 Create an unbound tcp socket. More...
 
 TcpHtcp (const TcpHtcp &sock)
 Copy constructor. More...
 
virtual ~TcpHtcp (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 uint32_t GetSsThresh (Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight)
 Get the slow start threshold after a loss event. 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 void IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
 Try to increase the cWnd following the NewReno specification. More...
 
virtual void ReduceCwnd (Ptr< TcpSocketState > tcb)
 Reduces congestion window on receipt of ECN Echo Flag. 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 (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<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::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)
 NewReno congestion avoidance. 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 Member Functions

void UpdateAlpha (void)
 Updates the additive increase parameter for H-TCP. More...
 
void UpdateBeta (void)
 Updates the multiplicative decrease factor beta for H-TCP. More...
 

Private Attributes

double m_alpha
 AIMD additive increase parameter. More...
 
double m_beta
 AIMD multiplicative decrease factor. More...
 
uint32_t m_dataSent
 Current amount of data sent since last congestion. More...
 
double m_defaultBackoff
 default value when throughput ratio less than default More...
 
Time m_delta
 Time in second that has elapsed since the. More...
 
Time m_deltaL
 Threshold for switching between standard and new increase function. More...
 
Time m_lastCon
 Time of the last congestion for the flow. More...
 
uint32_t m_lastThroughput
 Throughput in last congestion period. More...
 
Time m_maxRtt
 Maximum RTT in each congestion period. More...
 
Time m_minRtt
 Minimum RTT in each congestion period. More...
 
uint32_t m_throughput
 Current throughput since last congestion. More...
 
double m_throughputRatio
 ratio of two consequence throughput More...
 

Additional Inherited Members

Detailed Description

An implementation of the H-TCP variant of TCP.


Introspection did not find any typical Config paths.

This class contains the H-TCP implementation of TCP, according to Internet-Draft draft-leith-tcp-htcp-03 and its related paper, "H-TCP: TCP for high-speed and long-distance networks" H-TCP is a congestion control protocol suitable for high bandwidth-delay product networks. It is fair to similar flows present in the network and also friendly with conventional TCP. It also makes use of free bandwidth when it is available.


Attributes

  • DefaultBackoff: The default AIMD backoff factor
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1
    • Initial value: 0.5
    • Flags: construct write read
  • ThroughputRatio: Threshold value for updating beta
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.2
    • Flags: construct write read
  • DeltaL: Delta_L parameter in increase function
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +1000000000.0ns
    • Flags: construct write read

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

Definition at line 49 of file tcp-htcp.h.

Constructor & Destructor Documentation

◆ TcpHtcp() [1/2]

ns3::TcpHtcp::TcpHtcp ( void  )

Create an unbound tcp socket.

Definition at line 67 of file tcp-htcp.cc.

References NS_LOG_FUNCTION.

◆ TcpHtcp() [2/2]

ns3::TcpHtcp::TcpHtcp ( const TcpHtcp sock)

Copy constructor.

Parameters
sockthe object to copy

Definition at line 82 of file tcp-htcp.cc.

References NS_LOG_FUNCTION.

◆ ~TcpHtcp()

ns3::TcpHtcp::~TcpHtcp ( void  )
virtual

Definition at line 100 of file tcp-htcp.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CongestionAvoidance()

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

NewReno congestion avoidance.

During congestion avoidance, cwnd is incremented by roughly 1 full-sized segment per round-trip time (RTT).

Parameters
tcbinternal congestion state
segmentsAckedcount of segments acked

Reimplemented from ns3::TcpNewReno.

Definition at line 111 of file tcp-htcp.cc.

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

◆ Fork()

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

Copy the congestion control algorithm across sockets.

Returns
a pointer of the copied object

Reimplemented from ns3::TcpNewReno.

Definition at line 105 of file tcp-htcp.cc.

References NS_LOG_FUNCTION.

◆ GetName()

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

Get the name of the congestion control algorithm.

Returns
A string identifying the name

Reimplemented from ns3::TcpNewReno.

Definition at line 62 of file tcp-htcp.cc.

◆ GetSsThresh()

uint32_t ns3::TcpHtcp::GetSsThresh ( Ptr< const TcpSocketState tcb,
uint32_t  bytesInFlight 
)
virtual

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

Reimplemented from ns3::TcpNewReno.

Definition at line 169 of file tcp-htcp.cc.

References m_beta, m_dataSent, m_lastCon, m_lastThroughput, m_maxRtt, m_minRtt, m_throughput, max, ns3::Time::Max(), ns3::Time::Min(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, UpdateAlpha(), and UpdateBeta().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 37 of file tcp-htcp.cc.

References m_defaultBackoff, m_deltaL, m_throughputRatio, ns3::MakeDoubleAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ PktsAcked()

void ns3::TcpHtcp::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 (only one time also for cumulative ACKs) and contains timing information. It is optional (congestion controls need not implement it) and the default implementation does nothing.

Parameters
tcbinternal congestion state
segmentsAckedcount of segments acked
rttlast rtt

Reimplemented from ns3::TcpCongestionOps.

Definition at line 191 of file tcp-htcp.cc.

References ns3::TcpSocketState::CA_OPEN, ns3::Time::GetSeconds(), ns3::TcpSocketState::m_congState, m_dataSent, m_lastCon, m_maxRtt, m_minRtt, ns3::TcpSocketState::m_segmentSize, m_throughput, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and UpdateAlpha().

+ Here is the call graph for this function:

◆ UpdateAlpha()

void ns3::TcpHtcp::UpdateAlpha ( void  )
private

Updates the additive increase parameter for H-TCP.

Definition at line 126 of file tcp-htcp.cc.

References ns3::Time::GetSeconds(), m_alpha, m_beta, m_delta, m_deltaL, m_lastCon, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by GetSsThresh(), and PktsAcked().

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

◆ UpdateBeta()

void ns3::TcpHtcp::UpdateBeta ( void  )
private

Updates the multiplicative decrease factor beta for H-TCP.

Definition at line 151 of file tcp-htcp.cc.

References ns3::Time::GetDouble(), m_beta, m_defaultBackoff, m_lastThroughput, m_maxRtt, m_minRtt, m_throughput, m_throughputRatio, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by GetSsThresh().

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

Member Data Documentation

◆ m_alpha

double ns3::TcpHtcp::m_alpha
private

AIMD additive increase parameter.

Definition at line 91 of file tcp-htcp.h.

Referenced by CongestionAvoidance(), and UpdateAlpha().

◆ m_beta

double ns3::TcpHtcp::m_beta
private

AIMD multiplicative decrease factor.

Definition at line 92 of file tcp-htcp.h.

Referenced by GetSsThresh(), UpdateAlpha(), and UpdateBeta().

◆ m_dataSent

uint32_t ns3::TcpHtcp::m_dataSent
private

Current amount of data sent since last congestion.

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

Referenced by GetSsThresh(), and PktsAcked().

◆ m_defaultBackoff

double ns3::TcpHtcp::m_defaultBackoff
private

default value when throughput ratio less than default

Definition at line 93 of file tcp-htcp.h.

Referenced by GetTypeId(), and UpdateBeta().

◆ m_delta

Time ns3::TcpHtcp::m_delta
private

Time in second that has elapsed since the.

Definition at line 95 of file tcp-htcp.h.

Referenced by UpdateAlpha().

◆ m_deltaL

Time ns3::TcpHtcp::m_deltaL
private

Threshold for switching between standard and new increase function.

Definition at line 97 of file tcp-htcp.h.

Referenced by GetTypeId(), and UpdateAlpha().

◆ m_lastCon

Time ns3::TcpHtcp::m_lastCon
private

Time of the last congestion for the flow.

Definition at line 98 of file tcp-htcp.h.

Referenced by GetSsThresh(), PktsAcked(), and UpdateAlpha().

◆ m_lastThroughput

uint32_t ns3::TcpHtcp::m_lastThroughput
private

Throughput in last congestion period.

Definition at line 102 of file tcp-htcp.h.

Referenced by GetSsThresh(), and UpdateBeta().

◆ m_maxRtt

Time ns3::TcpHtcp::m_maxRtt
private

Maximum RTT in each congestion period.

Definition at line 100 of file tcp-htcp.h.

Referenced by GetSsThresh(), PktsAcked(), and UpdateBeta().

◆ m_minRtt

Time ns3::TcpHtcp::m_minRtt
private

Minimum RTT in each congestion period.

Definition at line 99 of file tcp-htcp.h.

Referenced by GetSsThresh(), PktsAcked(), and UpdateBeta().

◆ m_throughput

uint32_t ns3::TcpHtcp::m_throughput
private

Current throughput since last congestion.

Definition at line 101 of file tcp-htcp.h.

Referenced by GetSsThresh(), PktsAcked(), and UpdateBeta().

◆ m_throughputRatio

double ns3::TcpHtcp::m_throughputRatio
private

ratio of two consequence throughput

Definition at line 94 of file tcp-htcp.h.

Referenced by GetTypeId(), and UpdateBeta().


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