Network device transmission queue. More...

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

Inheritance 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 ()

Ptr< QueueLimits >	GetQueueLimits ()
	Get queue limits to this queue. More...

bool	IsStopped (void) const
	Get the status of the device transmission queue. More...

void	NotifyQueuedBytes (uint32_t bytes)
	Called by the netdevice to report the number of bytes queued to the device queue. More...

void	NotifyTransmittedBytes (uint32_t bytes)
	Called by the netdevice to report the number of bytes it is going to transmit. 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::SimpleRefCount< NetDeviceQueue >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Static Public Member Functions
template<typename Item >
static void	PacketDequeued (Ptr< Queue< Item > > queue, Ptr< NetDeviceQueueInterface > ndqi, uint8_t txq, Ptr< const Item > 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 Item >
static void	PacketDiscarded (Ptr< Queue< Item > > queue, Ptr< NetDeviceQueueInterface > ndqi, uint8_t txq, Ptr< const Item > 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 Item >
static void	PacketEnqueued (Ptr< Queue< Item > > queue, Ptr< NetDeviceQueueInterface > ndqi, uint8_t txq, Ptr< const Item > item)
	Perform the actions required by flow control and dynamic queue limits when a packet is enqueued in the queue of a netdevice. More...

Private Attributes
Ptr< QueueLimits >	m_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...

Detailed Description

Network device transmission queue.

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.

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

Member Typedef Documentation

◆ WakeCallback

typedef Callback< void > ns3::NetDeviceQueue::WakeCallback

Callback invoked by netdevices to wake upper layers.

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

Constructor & Destructor Documentation

◆ NetDeviceQueue()

ns3::NetDeviceQueue::NetDeviceQueue ( )

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

References NS_LOG_FUNCTION.

◆ ~NetDeviceQueue()

ns3::NetDeviceQueue::~NetDeviceQueue ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetQueueLimits()

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

Get queue limits to this queue.

Returns: the queue limits associated to this queue

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

References m_queueLimits, and NS_LOG_FUNCTION.

◆ IsStopped()

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

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.

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

References m_stoppedByDevice, m_stoppedByQueueLimits, and NS_LOG_FUNCTION.

◆ NotifyQueuedBytes()

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

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

Parameters

bytes number of bytes queued to the device queue

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

References m_queueLimits, m_stoppedByQueueLimits, and NS_LOG_FUNCTION.

◆ NotifyTransmittedBytes()

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

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

Parameters

bytes number of bytes the device is going to transmit

Definition at line 102 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().

◆ PacketDequeued()

template<typename Item >

void ns3::NetDeviceQueue::PacketDequeued	(	Ptr< Queue< Item > >	queue,
		Ptr< NetDeviceQueueInterface >	ndqi,
		uint8_t	txq,
		Ptr< const Item >	item
	)

static

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

queue	the device queue
ndqi	the NetDeviceQueueInterface object aggregated to the device
txq	the index of the transmission queue associated with the device queue
item	the dequeued (or dropped after dequeue) packet

This method must be connected to the "Dequeue" and "DropAfterDequeue" traced callbacks 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_FUNCTION, and NS_LOG_STATIC_TEMPLATE_DEFINE.

◆ PacketDiscarded()

template<typename Item >

void ns3::NetDeviceQueue::PacketDiscarded	(	Ptr< Queue< Item > >	queue,
		Ptr< NetDeviceQueueInterface >	ndqi,
		uint8_t	txq,
		Ptr< const Item >	item
	)

static

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

queue	the device queue
ndqi	the NetDeviceQueueInterface object aggregated to the device
txq	the index of the transmission queue associated with the device queue
item	the 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 408 of file net-device-queue-interface.h.

References NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_STATIC_TEMPLATE_DEFINE.

◆ PacketEnqueued()

template<typename Item >

void ns3::NetDeviceQueue::PacketEnqueued	(	Ptr< Queue< Item > >	queue,
		Ptr< NetDeviceQueueInterface >	ndqi,
		uint8_t	txq,
		Ptr< const Item >	item
	)

static

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

Parameters

queue	the device queue
ndqi	the NetDeviceQueueInterface object aggregated to the device
txq	the index of the transmission queue associated with the device queue
item	the 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 357 of file net-device-queue-interface.h.

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_STATIC_TEMPLATE_DEFINE.

◆ ResetQueueLimits()

void ns3::NetDeviceQueue::ResetQueueLimits ( )

Reset queue limits state.

Definition at line 124 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

ql	the queue limits associated to this queue

Definition at line 135 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

cb	the 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 80 of file net-device-queue-interface.cc.

References m_wakeCallback.