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

Network device transmission queue. More...

#include "net-device-queue-interface.h"

+ Inheritance diagram for ns3::NetDeviceQueue:
+ Collaboration diagram for ns3::NetDeviceQueue:

Public Types

typedef Callback< void > WakeCallback
 Callback invoked by netdevices to wake upper layers. More...
 

Public Member Functions

 NetDeviceQueue ()
 
virtual ~NetDeviceQueue ()
 
template<typename QueueType >
void ConnectQueueTraces (Ptr< QueueType > queue)
 Connect the traced callbacks of a queue to the methods providing support for flow control and dynamic queue limits. More...
 
Ptr< QueueLimitsGetQueueLimits ()
 Get queue limits to this queue. More...
 
virtual bool IsStopped (void) const
 Get the status of the device transmission queue. More...
 
void NotifyAggregatedObject (Ptr< NetDeviceQueueInterface > ndqi)
 Notify this NetDeviceQueue that the NetDeviceQueueInterface was aggregated to an object. More...
 
virtual void NotifyQueuedBytes (uint32_t bytes)
 Called by the netdevice to report the number of bytes queued to the device queue. More...
 
virtual void NotifyTransmittedBytes (uint32_t bytes)
 Called by the netdevice to report the number of bytes it is going to transmit. More...
 
template<typename QueueType >
void PacketDequeued (QueueType *queue, Ptr< const typename QueueType::ItemType > item)
 Perform the actions required by flow control and dynamic queue limits when a packet is dequeued (or dropped after dequeue) from the queue of a netdevice. More...
 
template<typename QueueType >
void PacketDiscarded (QueueType *queue, Ptr< const typename QueueType::ItemType > item)
 Perform the actions required by flow control and dynamic queue limits when a packet is dropped before being enqueued in the queue of a netdevice (which likely indicates that the queue is full) More...
 
template<typename QueueType >
void PacketEnqueued (QueueType *queue, Ptr< const typename QueueType::ItemType > item)
 Perform the actions required by flow control and dynamic queue limits when a packet is enqueued in the queue of a netdevice. More...
 
void ResetQueueLimits ()
 Reset queue limits state. More...
 
void SetQueueLimits (Ptr< QueueLimits > ql)
 Set queue limits to this queue. More...
 
virtual void SetWakeCallback (WakeCallback cb)
 Set the wake callback. More...
 
virtual void Start (void)
 Called by the device to start this device transmission queue. More...
 
virtual void Stop (void)
 Called by the device to stop this device transmission queue. More...
 
virtual void Wake (void)
 Called by the device to wake the queue disc associated with this device transmission queue. 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<>
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...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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::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...
 

Private Attributes

Ptr< NetDevicem_device
 the netdevice aggregated to the NetDeviceQueueInterface More...
 
Ptr< QueueLimitsm_queueLimits
 Queue limits object. More...
 
bool m_stoppedByDevice
 True if the queue has been stopped by the device. More...
 
bool m_stoppedByQueueLimits
 True if the queue has been stopped by a queue limits object. More...
 
WakeCallback m_wakeCallback
 Wake callback. More...
 
 NS_LOG_TEMPLATE_DECLARE
 redefinition of the log component More...
 

Additional Inherited Members

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

Detailed Description

Network device transmission queue.

Introspection did not find any typical Config paths.

This class stores information about a single transmission queue of a network device that is exposed to queue discs. Such information includes the state of the transmission queue (whether it has been stopped or not) and data used by techniques such as Byte Queue Limits.

This class roughly models the struct netdev_queue of Linux.


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

Definition at line 56 of file net-device-queue-interface.h.

Member Typedef Documentation

◆ WakeCallback

Callback invoked by netdevices to wake upper layers.

Definition at line 108 of file net-device-queue-interface.h.

Constructor & Destructor Documentation

◆ NetDeviceQueue()

ns3::NetDeviceQueue::NetDeviceQueue ( )

Definition at line 43 of file net-device-queue-interface.cc.

References NS_LOG_FUNCTION.

◆ ~NetDeviceQueue()

ns3::NetDeviceQueue::~NetDeviceQueue ( )
virtual

Definition at line 51 of file net-device-queue-interface.cc.

References m_device, m_queueLimits, m_wakeCallback, NS_LOG_FUNCTION, and ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::Nullify().

+ Here is the call graph for this function:

Member Function Documentation

◆ ConnectQueueTraces()

template<typename QueueType >
void ns3::NetDeviceQueue::ConnectQueueTraces ( Ptr< QueueType >  queue)

Connect the traced callbacks of a queue to the methods providing support for flow control and dynamic queue limits.

Implementation of the templates declared above.

A queue can be any object providing:

  • "Enqueue", "Dequeue", "DropBeforeEnqueue" traces
  • an ItemType typedef for the type of stored items
  • GetCurrentSize and GetMaxSize methods
    Parameters
    queuethe queue

Definition at line 325 of file net-device-queue-interface.h.

References ns3::MakeCallback(), NS_ASSERT, and ns3::PeekPointer().

+ Here is the call graph for this function:

◆ GetQueueLimits()

Ptr< QueueLimits > ns3::NetDeviceQueue::GetQueueLimits ( )

Get queue limits to this queue.

Returns
the queue limits associated to this queue

Definition at line 168 of file net-device-queue-interface.cc.

References m_queueLimits, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 33 of file net-device-queue-interface.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::NetDeviceQueueInterface::GetTypeId().

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

◆ IsStopped()

bool ns3::NetDeviceQueue::IsStopped ( void  ) const
virtual

Get the status of the device transmission queue.

Returns
true if the device transmission queue is stopped.

Called by queue discs to enquire about the status of a given transmission queue. This is the analogous to the netif_xmit_stopped function of the Linux kernel.

Reimplemented in ns3::NetDeviceQueueLock.

Definition at line 61 of file net-device-queue-interface.cc.

References m_stoppedByDevice, m_stoppedByQueueLimits, and NS_LOG_FUNCTION.

Referenced by ns3::NetDeviceQueueLock::IsStopped().

+ Here is the caller graph for this function:

◆ NotifyAggregatedObject()

void ns3::NetDeviceQueue::NotifyAggregatedObject ( Ptr< NetDeviceQueueInterface ndqi)

Notify this NetDeviceQueue that the NetDeviceQueueInterface was aggregated to an object.

Parameters
ndqithe NetDeviceQueueInterface.

This NetDeviceQueue stores a pointer to the NetDevice the NetDeviceQueueInterface was aggregated to.

Definition at line 97 of file net-device-queue-interface.cc.

References m_device, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

◆ NotifyQueuedBytes()

void ns3::NetDeviceQueue::NotifyQueuedBytes ( uint32_t  bytes)
virtual

Called by the netdevice to report the number of bytes queued to the device queue.

Parameters
bytesnumber of bytes queued to the device queue

Reimplemented in ns3::NetDeviceQueueLock.

Definition at line 112 of file net-device-queue-interface.cc.

References m_queueLimits, m_stoppedByQueueLimits, and NS_LOG_FUNCTION.

Referenced by ns3::NetDeviceQueueLock::NotifyQueuedBytes(), and PacketEnqueued().

+ Here is the caller graph for this function:

◆ NotifyTransmittedBytes()

void ns3::NetDeviceQueue::NotifyTransmittedBytes ( uint32_t  bytes)
virtual

Called by the netdevice to report the number of bytes it is going to transmit.

Parameters
bytesnumber of bytes the device is going to transmit

Reimplemented in ns3::NetDeviceQueueLock.

Definition at line 128 of file net-device-queue-interface.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_queueLimits, m_stoppedByQueueLimits, m_wakeCallback, NS_LOG_FUNCTION, and ns3::Simulator::ScheduleNow().

Referenced by ns3::NetDeviceQueueLock::NotifyTransmittedBytes(), and PacketDequeued().

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

◆ PacketDequeued()

template<typename QueueType >
void ns3::NetDeviceQueue::PacketDequeued ( QueueType *  queue,
Ptr< const typename QueueType::ItemType >  item 
)

Perform the actions required by flow control and dynamic queue limits when a packet is dequeued (or dropped after dequeue) from the queue of a netdevice.

Parameters
queuethe device queue
itemthe dequeued packet

This method must be connected to the "Dequeue" traced callback of a Queue object (through a bound callback) in order for a netdevice to support flow control and dynamic queue limits.

Definition at line 363 of file net-device-queue-interface.h.

References ns3::NetDevice::GetMtu(), m_device, NotifyTransmittedBytes(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and Wake().

+ Here is the call graph for this function:

◆ PacketDiscarded()

template<typename QueueType >
void ns3::NetDeviceQueue::PacketDiscarded ( QueueType *  queue,
Ptr< const typename QueueType::ItemType >  item 
)

Perform the actions required by flow control and dynamic queue limits when a packet is dropped before being enqueued in the queue of a netdevice (which likely indicates that the queue is full)

Parameters
queuethe device queue
itemthe dropped packet

This method must be connected to the "DropBeforeEnqueue" traced callback of a Queue object (through a bound callback) in order for a netdevice to support flow control and dynamic queue limits.

Definition at line 383 of file net-device-queue-interface.h.

References NS_LOG_ERROR, NS_LOG_FUNCTION, and Stop().

+ Here is the call graph for this function:

◆ PacketEnqueued()

template<typename QueueType >
void ns3::NetDeviceQueue::PacketEnqueued ( QueueType *  queue,
Ptr< const typename QueueType::ItemType >  item 
)

Perform the actions required by flow control and dynamic queue limits when a packet is enqueued in the queue of a netdevice.

Parameters
queuethe device queue
itemthe enqueued packet

This method must be connected to the "Enqueue" traced callback of a Queue object (through a bound callback) in order for a netdevice to support flow control and dynamic queue limits.

Definition at line 342 of file net-device-queue-interface.h.

References ns3::NetDevice::GetMtu(), m_device, NotifyQueuedBytes(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and Stop().

+ Here is the call graph for this function:

◆ ResetQueueLimits()

void ns3::NetDeviceQueue::ResetQueueLimits ( )

Reset queue limits state.

Definition at line 150 of file net-device-queue-interface.cc.

References m_queueLimits, and NS_LOG_FUNCTION.

◆ SetQueueLimits()

void ns3::NetDeviceQueue::SetQueueLimits ( Ptr< QueueLimits ql)

Set queue limits to this queue.

Parameters
qlthe queue limits associated to this queue

Definition at line 161 of file net-device-queue-interface.cc.

References m_queueLimits, and NS_LOG_FUNCTION.

◆ SetWakeCallback()

void ns3::NetDeviceQueue::SetWakeCallback ( WakeCallback  cb)
virtual

Set the wake callback.

Parameters
cbthe callback to set

Called by the traffic control layer to set the wake callback. The wake callback is invoked by the device whenever it is needed to "wake" the upper layers (i.e., solicitate the queue disc associated with this transmission queue (in case of multi-queue aware queue discs) or to the network device (otherwise) to send packets down to the device).

Definition at line 106 of file net-device-queue-interface.cc.

References m_wakeCallback.

◆ Start()

void ns3::NetDeviceQueue::Start ( void  )
virtual

Called by the device to start this device transmission queue.

This is the analogous to the netif_tx_start_queue function of the Linux kernel.

Reimplemented in ns3::NetDeviceQueueLock.

Definition at line 68 of file net-device-queue-interface.cc.

References m_stoppedByDevice, and NS_LOG_FUNCTION.

Referenced by ns3::NetDeviceQueueLock::Start().

+ Here is the caller graph for this function:

◆ Stop()

void ns3::NetDeviceQueue::Stop ( void  )
virtual

Called by the device to stop this device transmission queue.

This is the analogous to the netif_tx_stop_queue function of the Linux kernel.

Reimplemented in ns3::NetDeviceQueueLock.

Definition at line 75 of file net-device-queue-interface.cc.

References m_stoppedByDevice, and NS_LOG_FUNCTION.

Referenced by PacketDiscarded(), PacketEnqueued(), and ns3::NetDeviceQueueLock::Stop().

+ Here is the caller graph for this function:

◆ Wake()

void ns3::NetDeviceQueue::Wake ( void  )
virtual

Called by the device to wake the queue disc associated with this device transmission queue.

This is done by invoking the wake callback. This is the analogous to the netif_tx_wake_queue function of the Linux kernel.

Reimplemented in ns3::NetDeviceQueueLock.

Definition at line 82 of file net-device-queue-interface.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_stoppedByDevice, m_wakeCallback, NS_LOG_FUNCTION, and ns3::Simulator::ScheduleNow().

Referenced by PacketDequeued(), and ns3::NetDeviceQueueLock::Wake().

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

Member Data Documentation

◆ m_device

Ptr<NetDevice> ns3::NetDeviceQueue::m_device
private

the netdevice aggregated to the NetDeviceQueueInterface

Definition at line 211 of file net-device-queue-interface.h.

Referenced by ~NetDeviceQueue(), NotifyAggregatedObject(), PacketDequeued(), and PacketEnqueued().

◆ m_queueLimits

Ptr<QueueLimits> ns3::NetDeviceQueue::m_queueLimits
private

◆ m_stoppedByDevice

bool ns3::NetDeviceQueue::m_stoppedByDevice
private

True if the queue has been stopped by the device.

Definition at line 207 of file net-device-queue-interface.h.

Referenced by IsStopped(), Start(), Stop(), and Wake().

◆ m_stoppedByQueueLimits

bool ns3::NetDeviceQueue::m_stoppedByQueueLimits
private

True if the queue has been stopped by a queue limits object.

Definition at line 208 of file net-device-queue-interface.h.

Referenced by IsStopped(), NotifyQueuedBytes(), and NotifyTransmittedBytes().

◆ m_wakeCallback

WakeCallback ns3::NetDeviceQueue::m_wakeCallback
private

Wake callback.

Definition at line 210 of file net-device-queue-interface.h.

Referenced by ~NetDeviceQueue(), NotifyTransmittedBytes(), SetWakeCallback(), and Wake().

◆ NS_LOG_TEMPLATE_DECLARE

ns3::NetDeviceQueue::NS_LOG_TEMPLATE_DECLARE
private

redefinition of the log component

Definition at line 213 of file net-device-queue-interface.h.


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