Abstract base class for NetDevice queue length controller. More...
#include "queue-limits.h"
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. | |
virtual void | Completed (uint32_t count)=0 |
Record number of completed bytes and recalculate the limit. | |
virtual void | Queued (uint32_t count)=0 |
Record the number of bytes queued. | |
virtual void | Reset ()=0 |
Reset queue limits state. | |
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 override |
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::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Additional Inherited Members | |
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. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Abstract base class for NetDevice queue length controller.
Introspection did not find any typical Config paths.
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.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Network
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 32 of file queue-limits.h.
|
override |
Definition at line 28 of file queue-limits.cc.
References NS_LOG_FUNCTION.
|
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
Implemented in ns3::DynamicQueueLimits.
|
pure virtual |
Record number of completed bytes and recalculate the limit.
count | the number of completed bytes |
Implemented in ns3::DynamicQueueLimits.
|
static |
Get the type ID.
Definition at line 22 of file queue-limits.cc.
References ns3::TypeId::SetParent().
|
pure virtual |
Record the number of bytes queued.
count | the number of bytes queued |
Implemented in ns3::DynamicQueueLimits.
|
pure virtual |
Reset queue limits state.
Implemented in ns3::DynamicQueueLimits.