An implementation of LEDBAT. More...
#include "tcp-ledbat.h"
Inheritance diagram for ns3::TcpLedbat:
Collaboration diagram for ns3::TcpLedbat:Classes | |
| struct | OwdCircBuf |
| Buffer structure to store delays. More... | |
Public Member Functions | |
| TcpLedbat () | |
| Create an unbound tcp socket. | |
| TcpLedbat (const TcpLedbat &sock) | |
| Copy constructor. | |
| ~TcpLedbat () override | |
| Destructor. | |
| Ptr< TcpCongestionOps > | Fork () override |
| Copy the congestion control algorithm across sockets. | |
| std::string | GetName () const override |
| Get the name of the TCP flavour. | |
| void | IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) override |
| Adjust cwnd following LEDBAT algorithm. | |
| void | PktsAcked (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt) override |
| Get information from the acked packet. | |
| void | SetDoSs (SlowStartType doSS) |
| Change the Slow Start Capability. | |
Public Member Functions inherited from ns3::TcpNewReno | |
| TcpNewReno () | |
| TcpNewReno (const TcpNewReno &sock) | |
| Copy constructor. | |
| ~TcpNewReno () override | |
| Ptr< TcpCongestionOps > | Fork () override |
| Copy the congestion control algorithm across sockets. | |
| std::string | GetName () const override |
| Get the name of the congestion control algorithm. | |
| uint32_t | GetSsThresh (Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight) override |
| Get the slow start threshold after a loss event. | |
| void | IncreaseWindow (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) override |
| Try to increase the cWnd following the NewReno specification. | |
Public Member Functions inherited from ns3::TcpCongestionOps | |
| TcpCongestionOps () | |
| TcpCongestionOps (const TcpCongestionOps &other) | |
| Copy constructor. | |
| ~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. | |
| virtual void | CongestionStateSet (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCongState_t newState) |
| Trigger events/calculations specific to a congestion state. | |
| virtual void | CwndEvent (Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event) |
| Trigger events/calculations on occurrence of congestion window event. | |
| virtual bool | HasCongControl () const |
| Returns true when Congestion Control Algorithm implements CongControl. | |
| virtual void | Init (Ptr< TcpSocketState > tcb) |
| Set configuration required by congestion control algorithm. | |
| virtual void | SetRateOps (Ptr< TcpRateOps > rateOps) |
| Set rate operation required by the congestion control algorithm. | |
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::TcpNewReno | |
| static TypeId | GetTypeId () |
| Get the type ID. | |
Static Public Member Functions inherited from ns3::TcpCongestionOps | |
| 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. | |
Protected Member Functions | |
| void | CongestionAvoidance (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) override |
| Reduce Congestion. | |
Protected Member Functions inherited from ns3::TcpNewReno | |
| virtual uint32_t | SlowStart (Ptr< TcpSocketState > tcb, uint32_t segmentsAcked) |
| Tcp NewReno slow start algorithm. | |
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. | |
Private Types | |
| typedef uint32_t(* | FilterFunction) (OwdCircBuf &) |
| Filter function used by LEDBAT for current delay. | |
| enum | SlowStartType { DO_NOT_SLOWSTART , DO_SLOWSTART } |
| The slowstart types. More... | |
| enum | State : uint32_t { LEDBAT_VALID_OWD = (1 << 1) , LEDBAT_CAN_SS = (1 << 3) } |
| The state of LEDBAT. More... | |
Private Member Functions | |
| void | AddDelay (OwdCircBuf &cb, uint32_t owd, uint32_t maxlen) |
| Add new delay to the buffers. | |
| uint32_t | BaseDelay () |
| Return the value of base delay. | |
| uint32_t | CurrentDelay (FilterFunction filter) |
| Return the value of current delay. | |
| void | InitCircBuf (OwdCircBuf &buffer) |
| Initialise a new buffer. | |
| void | UpdateBaseDelay (uint32_t owd) |
| Update the base delay buffer. | |
Static Private Member Functions | |
| static uint32_t | MinCircBuf (OwdCircBuf &b) |
| Return the minimum delay of the buffer. | |
Private Attributes | |
| uint32_t | m_baseHistoLen |
| Length of base delay history buffer. | |
| OwdCircBuf | m_baseHistory |
| Buffer to store the base delay. | |
| SlowStartType | m_doSs |
| Permissible Slow Start State. | |
| uint32_t | m_flag |
| LEDBAT Flag. | |
| double | m_gain |
| GAIN value from RFC. | |
| uint64_t | m_lastRollover |
| Timestamp of last added delay. | |
| uint32_t | m_minCwnd |
| Minimum cWnd value mentioned in RFC 6817. | |
| OwdCircBuf | m_noiseFilter |
| Buffer to store the current delay. | |
| uint32_t | m_noiseFilterLen |
| Length of current delay buffer. | |
| int32_t | m_sndCwndCnt |
| The congestion window addition parameter. | |
| Time | m_target |
| Target Queue Delay. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid () |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
An implementation of LEDBAT.
ns3::TcpLedbat is accessible through the following paths with Config::Set and Config::Connect:
yes|no Time -9.22337e+18ns:+9.22337e+18ns No TraceSources are defined for this type
Group: Internet
Size of this type is 192 bytes (on a 64-bit architecture).
Definition at line 28 of file tcp-ledbat.h.
|
private |
Filter function used by LEDBAT for current delay.
Definition at line 134 of file tcp-ledbat.h.
|
private |
The slowstart types.
| Enumerator | |
|---|---|
| DO_NOT_SLOWSTART | Do not Slow Start. |
| DO_SLOWSTART | Do NewReno Slow Start. |
Definition at line 34 of file tcp-ledbat.h.
|
private |
The state of LEDBAT.
If LEDBAT is not in VALID_OWD state, it falls to default congestion ops.
| Enumerator | |
|---|---|
| LEDBAT_VALID_OWD | If valid timestamps are present. |
| LEDBAT_CAN_SS | If LEDBAT allows Slow Start. |
Definition at line 44 of file tcp-ledbat.h.
| ns3::TcpLedbat::TcpLedbat | ( | ) |
Create an unbound tcp socket.
Definition at line 79 of file tcp-ledbat.cc.
References ns3::TcpNewReno::TcpNewReno(), DO_SLOWSTART, InitCircBuf(), LEDBAT_CAN_SS, m_baseHistoLen, m_baseHistory, m_doSs, m_flag, m_gain, m_lastRollover, m_minCwnd, m_noiseFilter, m_noiseFilterLen, m_sndCwndCnt, m_target, ns3::MilliSeconds(), and NS_LOG_FUNCTION.
Referenced by TcpLedbat().
Here is the call graph for this function:
Here is the caller graph for this function:| ns3::TcpLedbat::TcpLedbat | ( | const TcpLedbat & | sock | ) |
Copy constructor.
| sock | the object to copy |
Definition at line 104 of file tcp-ledbat.cc.
References TcpLedbat(), ns3::TcpNewReno::TcpNewReno(), m_baseHistoLen, m_baseHistory, m_doSs, m_flag, m_gain, m_lastRollover, m_minCwnd, m_noiseFilter, m_noiseFilterLen, m_sndCwndCnt, m_target, and NS_LOG_FUNCTION.
Here is the call graph for this function:
|
override |
|
private |
Add new delay to the buffers.
| cb | The buffer |
| owd | The new delay |
| maxlen | The maximum permitted length |
Definition at line 231 of file tcp-ledbat.cc.
References ns3::TcpLedbat::OwdCircBuf::buffer, ns3::TcpLedbat::OwdCircBuf::min, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by PktsAcked(), and UpdateBaseDelay().
Here is the caller graph for this function:
|
private |
Return the value of base delay.
Definition at line 160 of file tcp-ledbat.cc.
References m_baseHistory, MinCircBuf(), and NS_LOG_FUNCTION.
Referenced by CongestionAvoidance().
Here is the call graph for this function:
Here is the caller graph for this function:
|
overrideprotectedvirtual |
Reduce Congestion.
| tcb | internal congestion state |
| segmentsAcked | count of segments ACKed |
Reimplemented from ns3::TcpNewReno.
Definition at line 186 of file tcp-ledbat.cc.
References BaseDelay(), ns3::TcpNewReno::CongestionAvoidance(), CurrentDelay(), LEDBAT_VALID_OWD, m_flag, m_gain, m_minCwnd, m_sndCwndCnt, m_target, MinCircBuf(), and NS_LOG_FUNCTION.
Referenced by IncreaseWindow().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Return the value of current delay.
| filter | The filter function |
Definition at line 153 of file tcp-ledbat.cc.
References m_noiseFilter, and NS_LOG_FUNCTION.
Referenced by CongestionAvoidance().
Here is the caller graph for this function:
|
overridevirtual |
Copy the congestion control algorithm across sockets.
Implements ns3::TcpCongestionOps.
Definition at line 127 of file tcp-ledbat.cc.
References ns3::CopyObject().
Here is the call graph for this function:
|
overridevirtual |
Get the name of the TCP flavour.
Implements ns3::TcpCongestionOps.
Definition at line 133 of file tcp-ledbat.cc.
|
static |
Get the type ID.
Definition at line 24 of file tcp-ledbat.cc.
References ns3::TcpNewReno::TcpNewReno(), DO_NOT_SLOWSTART, DO_SLOWSTART, m_baseHistoLen, m_gain, m_minCwnd, m_noiseFilterLen, m_target, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::MilliSeconds(), SetDoSs(), and ns3::TypeId::SetParent().
Here is the call graph for this function:
|
overridevirtual |
Adjust cwnd following LEDBAT algorithm.
| tcb | internal congestion state |
| segmentsAcked | count of segments ACKed |
Reimplemented from ns3::TcpCongestionOps.
Definition at line 167 of file tcp-ledbat.cc.
References CongestionAvoidance(), DO_SLOWSTART, LEDBAT_CAN_SS, m_doSs, m_flag, NS_LOG_FUNCTION, and ns3::TcpNewReno::SlowStart().
Here is the call graph for this function:
|
private |
Initialise a new buffer.
| buffer | The buffer to be initialised |
Definition at line 97 of file tcp-ledbat.cc.
References ns3::TcpLedbat::OwdCircBuf::buffer, ns3::TcpLedbat::OwdCircBuf::min, and NS_LOG_FUNCTION.
Referenced by TcpLedbat().
Here is the caller graph for this function:
|
staticprivate |
Return the minimum delay of the buffer.
| b | The buffer |
Definition at line 139 of file tcp-ledbat.cc.
References ns3::TcpLedbat::OwdCircBuf::buffer, ns3::TcpLedbat::OwdCircBuf::min, and NS_LOG_FUNCTION_NOARGS.
Referenced by BaseDelay(), and CongestionAvoidance().
Here is the caller graph for this function:
|
overridevirtual |
Get information from the acked packet.
| tcb | internal congestion state |
| segmentsAcked | count of segments ACKed |
| rtt | The estimated rtt |
Reimplemented from ns3::TcpCongestionOps.
Definition at line 293 of file tcp-ledbat.cc.
References AddDelay(), ns3::Time::IsPositive(), LEDBAT_VALID_OWD, m_flag, m_noiseFilter, m_noiseFilterLen, NS_LOG_FUNCTION, and UpdateBaseDelay().
Here is the call graph for this function:| void ns3::TcpLedbat::SetDoSs | ( | SlowStartType | doSS | ) |
Change the Slow Start Capability.
| doSS | Slow Start Option |
Definition at line 65 of file tcp-ledbat.cc.
References LEDBAT_CAN_SS, m_doSs, m_flag, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
Here is the caller graph for this function:
|
private |
Update the base delay buffer.
| owd | The delay |
Definition at line 263 of file tcp-ledbat.cc.
References AddDelay(), ns3::Time::GetSeconds(), m_baseHistoLen, m_baseHistory, m_lastRollover, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
Referenced by PktsAcked().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Length of base delay history buffer.
Definition at line 178 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), GetTypeId(), and UpdateBaseDelay().
|
private |
Buffer to store the base delay.
Definition at line 182 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), BaseDelay(), and UpdateBaseDelay().
|
private |
Permissible Slow Start State.
Definition at line 177 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), IncreaseWindow(), and SetDoSs().
|
private |
LEDBAT Flag.
Definition at line 184 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), CongestionAvoidance(), IncreaseWindow(), PktsAcked(), and SetDoSs().
|
private |
GAIN value from RFC.
Definition at line 176 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), CongestionAvoidance(), and GetTypeId().
|
private |
Timestamp of last added delay.
Definition at line 180 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), and UpdateBaseDelay().
|
private |
Minimum cWnd value mentioned in RFC 6817.
Definition at line 185 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), CongestionAvoidance(), and GetTypeId().
|
private |
Buffer to store the current delay.
Definition at line 183 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), CurrentDelay(), and PktsAcked().
|
private |
Length of current delay buffer.
Definition at line 179 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), GetTypeId(), and PktsAcked().
|
private |
The congestion window addition parameter.
Definition at line 181 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), and CongestionAvoidance().
|
private |
Target Queue Delay.
Definition at line 175 of file tcp-ledbat.h.
Referenced by TcpLedbat(), TcpLedbat(), CongestionAvoidance(), and GetTypeId().