A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::MqQueueDisc Class Reference

mq is a classful multi-queue aware dummy scheduler. More...

#include "mq-queue-disc.h"

+ Inheritance diagram for ns3::MqQueueDisc:
+ Collaboration diagram for ns3::MqQueueDisc:

Public Member Functions

 MqQueueDisc ()
 MqQueueDisc constructor.
 
 ~MqQueueDisc () override
 
WakeMode GetWakeMode () const override
 Return the wake mode adopted by this queue disc.
 
- Public Member Functions inherited from ns3::QueueDisc
 QueueDisc (const QueueDisc &)=delete
 
 QueueDisc (QueueDiscSizePolicy policy, QueueSizeUnit unit)
 Constructor.
 
 QueueDisc (QueueDiscSizePolicy policy=QueueDiscSizePolicy::SINGLE_INTERNAL_QUEUE)
 Constructor.
 
 ~QueueDisc () override
 
void AddInternalQueue (Ptr< InternalQueue > queue)
 Add an internal queue to the tail of the list of queues.
 
void AddPacketFilter (Ptr< PacketFilter > filter)
 Add a packet filter to the tail of the list of filters used to classify packets.
 
void AddQueueDiscClass (Ptr< QueueDiscClass > qdClass)
 Add a queue disc class to the tail of the list of classes.
 
int32_t Classify (Ptr< QueueDiscItem > item)
 Classify a packet by calling the packet filters, one at a time, until either a filter able to classify the packet is found or all the filters have been processed.
 
Ptr< QueueDiscItemDequeue ()
 Extract from the queue disc the packet that has been dequeued by calling Peek, if any, or call the private DoDequeue method (which must be implemented by derived classes) to dequeue a packet, otherwise.
 
bool Enqueue (Ptr< QueueDiscItem > item)
 Pass a packet to store to the queue discipline.
 
QueueSize GetCurrentSize ()
 Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise.
 
Ptr< InternalQueueGetInternalQueue (std::size_t i) const
 Get the i-th internal queue.
 
QueueSize GetMaxSize () const
 Get the maximum size of the queue disc.
 
uint32_t GetNBytes () const
 Get the amount of bytes stored by the queue disc.
 
Ptr< NetDeviceQueueInterfaceGetNetDeviceQueueInterface () const
 
std::size_t GetNInternalQueues () const
 Get the number of internal queues.
 
std::size_t GetNPacketFilters () const
 Get the number of packet filters.
 
uint32_t GetNPackets () const
 Get the number of packets stored by the queue disc.
 
std::size_t GetNQueueDiscClasses () const
 Get the number of queue disc classes.
 
Ptr< PacketFilterGetPacketFilter (std::size_t i) const
 Get the i-th packet filter.
 
Ptr< QueueDiscClassGetQueueDiscClass (std::size_t i) const
 Get the i-th queue disc class.
 
virtual uint32_t GetQuota () const
 Get the maximum number of dequeue operations following a packet enqueue.
 
SendCallback GetSendCallback () const
 
const StatsGetStats ()
 Retrieve all the collected statistics.
 
virtual WakeMode GetWakeMode () const
 When setting up the wake callbacks on the netdevice queues, it is necessary to determine which queue disc (the root queue disc or one of its children) should be activated when the netdevice wakes one of its transmission queues.
 
QueueDiscoperator= (const QueueDisc &)=delete
 
Ptr< const QueueDiscItemPeek ()
 Get a copy of the next packet the queue discipline will extract.
 
void Run ()
 Modelled after the Linux function __qdisc_run (net/sched/sch_generic.c) Dequeues multiple packets, until a quota is exceeded or sending a packet to the device failed.
 
bool SetMaxSize (QueueSize size)
 Set the maximum size of the queue disc.
 
void SetNetDeviceQueueInterface (Ptr< NetDeviceQueueInterface > ndqi)
 
virtual void SetQuota (const uint32_t quota)
 Set the maximum number of dequeue operations following a packet enqueue.
 
void SetSendCallback (SendCallback func)
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
- 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.
 
SimpleRefCountoperator= (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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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::QueueDisc
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.
 

Private Member Functions

bool CheckConfig () override
 Check whether the current configuration is correct.
 
Ptr< QueueDiscItemDoDequeue () override
 This function actually extracts a packet from the queue disc.
 
bool DoEnqueue (Ptr< QueueDiscItem > item) override
 This function actually enqueues a packet into the queue disc.
 
Ptr< const QueueDiscItemDoPeek () override
 Return a copy of the next packet the queue disc will extract.
 
void InitializeParams () override
 Initialize parameters (if any) before the first packet is enqueued.
 

Additional Inherited Members

- Public Types inherited from ns3::QueueDisc
typedef Queue< QueueDiscItemInternalQueue
 Internal queues store QueueDiscItem objects.
 
typedef std::function< void(Ptr< QueueDiscItem >)> SendCallback
 Callback invoked to send a packet to the receiving object when Run is called.
 
enum  WakeMode { WAKE_ROOT = 0x00 , WAKE_CHILD = 0x01 }
 Used to determine whether the queue disc itself or its children must be activated when a netdevice wakes a transmission queue. More...
 
- Static Public Attributes inherited from ns3::QueueDisc
static constexpr const char * CHILD_QUEUE_DISC_DROP
 Packet dropped by a child queue disc.
 
static constexpr const char * CHILD_QUEUE_DISC_MARK
 Packet marked by a child queue disc.
 
static constexpr const char * INTERNAL_QUEUE_DROP
 Packet dropped by an internal queue.
 
- Protected Member Functions inherited from ns3::QueueDisc
void DoDispose () override
 Dispose of the object.
 
void DoInitialize () override
 Check whether the configuration is correct and initialize parameters.
 
void DropAfterDequeue (Ptr< const QueueDiscItem > item, const char *reason)
 Perform the actions required when the queue disc is notified of a packet dropped after dequeue.
 
void DropBeforeEnqueue (Ptr< const QueueDiscItem > item, const char *reason)
 Perform the actions required when the queue disc is notified of a packet dropped before enqueue.
 
bool Mark (Ptr< QueueDiscItem > item, const char *reason)
 Marks the given packet and, if successful, updates the counters associated with the given reason.
 
- 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.
 

Detailed Description

mq is a classful multi-queue aware dummy scheduler.

Introspection did not find any typical Config paths.

It has as many child queue discs as the number of device transmission queues. Packets are directly enqueued into and dequeued from child queue discs.


No Attributes are defined for this type.

Attributes defined in parent class ns3::QueueDisc

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::QueueDisc

Size of this type is 968 bytes (on a 64-bit architecture).

Definition at line 36 of file mq-queue-disc.h.

Constructor & Destructor Documentation

◆ MqQueueDisc()

ns3::MqQueueDisc::MqQueueDisc ( )

MqQueueDisc constructor.

Definition at line 42 of file mq-queue-disc.cc.

References NS_LOG_FUNCTION.

◆ ~MqQueueDisc()

ns3::MqQueueDisc::~MqQueueDisc ( )
override

Definition at line 48 of file mq-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckConfig()

bool ns3::MqQueueDisc::CheckConfig ( )
overrideprivatevirtual

Check whether the current configuration is correct.

Default objects (such as internal queues) might be created by this method to ensure the configuration is correct. This method is automatically called at simulation initialization time, and it is called before the InitializeParams () method. It is appropriate to promote parameter initialization to this method if it aids in checking for correct configuration.

See also
QueueDisc::InitializeParams
Returns
true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 78 of file mq-queue-disc.cc.

References ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), NS_LOG_ERROR, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoDequeue()

Ptr< QueueDiscItem > ns3::MqQueueDisc::DoDequeue ( )
overrideprivatevirtual

This function actually extracts a packet from the queue disc.

Returns
0 if the operation was not successful; the item otherwise.

Implements ns3::QueueDisc.

Definition at line 66 of file mq-queue-disc.cc.

References NS_FATAL_ERROR.

◆ DoEnqueue()

bool ns3::MqQueueDisc::DoEnqueue ( Ptr< QueueDiscItem item)
overrideprivatevirtual

This function actually enqueues a packet into the queue disc.

Parameters
itemitem to enqueue
Returns
True if the operation was successful; false otherwise

Implements ns3::QueueDisc.

Definition at line 60 of file mq-queue-disc.cc.

References NS_FATAL_ERROR.

◆ DoPeek()

Ptr< const QueueDiscItem > ns3::MqQueueDisc::DoPeek ( )
overrideprivatevirtual

Return a copy of the next packet the queue disc will extract.

The implementation of this method is based on the qdisc_peek_dequeued function of the Linux kernel, which dequeues a packet and retains it in the queue disc as a requeued packet. The packet is not traced as requeued, nor is the total count of requeued packets increased. The packet is still considered to be part of the queue disc and the dequeue trace is fired when Dequeue is called and the packet is actually extracted from the queue disc.

This approach is especially recommended for queue discs for which it is not obvious what is the next packet that will be dequeued (e.g., queue discs having multiple internal queues or child queue discs or queue discs that drop packets after dequeue). Subclasses can however provide their own implementation of this method that overrides the default one.

Returns
0 if the operation was not successful; the packet otherwise.

Reimplemented from ns3::QueueDisc.

Definition at line 72 of file mq-queue-disc.cc.

References NS_FATAL_ERROR.

◆ GetTypeId()

TypeId ns3::MqQueueDisc::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 33 of file mq-queue-disc.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetWakeMode()

MqQueueDisc::WakeMode ns3::MqQueueDisc::GetWakeMode ( ) const
overridevirtual

Return the wake mode adopted by this queue disc.

Returns
the wake mode adopted by this queue disc.

Reimplemented from ns3::QueueDisc.

Definition at line 54 of file mq-queue-disc.cc.

References ns3::QueueDisc::WAKE_CHILD.

◆ InitializeParams()

void ns3::MqQueueDisc::InitializeParams ( )
overrideprivatevirtual

Initialize parameters (if any) before the first packet is enqueued.

This method is automatically called at simulation initialization time, after the CheckConfig() method has been called.

See also
QueueDisc::CheckConfig

Implements ns3::QueueDisc.

Definition at line 98 of file mq-queue-disc.cc.

References NS_LOG_FUNCTION.


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