A Discrete-Event Network Simulator
API
ns3::QueueLimits Class Referenceabstract

Abstract base class for NetDevice queue length controller. More...

#include "queue-limits.h"

+ Inheritance diagram for ns3::QueueLimits:
+ Collaboration diagram for ns3::QueueLimits:

Public Member Functions

 ~QueueLimits () override
 
virtual int32_t Available () const =0
 Available is called from NotifyTransmittedBytes to calculate the number of bytes that can be passed again to the NetDevice. More...
 
virtual void Completed (uint32_t count)=0
 Record number of completed bytes and recalculate the limit. More...
 
virtual void Queued (uint32_t count)=0
 Record the number of bytes queued. More...
 
virtual void Reset ()=0
 Reset queue limits state. 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::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Additional Inherited Members

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

Detailed Description

Abstract base class for NetDevice queue length controller.

QueueLimits is an abstract base class providing the interface to the NetDevice queue length controller.

Child classes need to implement the methods used for a byte-based measure of the queue length.

The design and implementation of this class is inspired by Linux. For more details, see the queue limits Sphinx documentation.

Definition at line 43 of file queue-limits.h.

Constructor & Destructor Documentation

◆ ~QueueLimits()

ns3::QueueLimits::~QueueLimits ( )
override

Definition at line 39 of file queue-limits.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Available()

virtual int32_t ns3::QueueLimits::Available ( ) const
pure virtual

Available is called from NotifyTransmittedBytes to calculate the number of bytes that can be passed again to the NetDevice.

A negative value means that no packets can be passed to the NetDevice. In this case, NotifyTransmittedBytes stops the transmission queue.

Returns how many bytes can be queued

Returns
the number of bytes that can be queued

Implemented in ns3::DynamicQueueLimits.

◆ Completed()

virtual void ns3::QueueLimits::Completed ( uint32_t  count)
pure virtual

Record number of completed bytes and recalculate the limit.

Parameters
countthe number of completed bytes

Implemented in ns3::DynamicQueueLimits.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 33 of file queue-limits.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Queued()

virtual void ns3::QueueLimits::Queued ( uint32_t  count)
pure virtual

Record the number of bytes queued.

Parameters
countthe number of bytes queued

Implemented in ns3::DynamicQueueLimits.

◆ Reset()

virtual void ns3::QueueLimits::Reset ( )
pure virtual

Reset queue limits state.

Implemented in ns3::DynamicQueueLimits.


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