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.

Public Member Functions
	NetDeviceQueue ()

	~NetDeviceQueue () override

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.

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

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

void	NotifyAggregatedObject (Ptr< NetDeviceQueueInterface > ndqi)
	Notify this NetDeviceQueue that the NetDeviceQueueInterface was aggregated to an object.

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

virtual void	NotifyTransmittedBytes (uint32_t bytes)
	Called by the netdevice to report the number of bytes it is going to transmit.

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.

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)

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.

void	ResetQueueLimits ()
	Reset queue limits state.

void	SetQueueLimits (Ptr< QueueLimits > ql)
	Set queue limits to this queue.

virtual void	SetWakeCallback (WakeCallback cb)
	Set the wake callback.

virtual void	Start ()
	Called by the device to start this device transmission queue.

virtual void	Stop ()
	Called by the device to stop this device transmission queue.

virtual void	Wake ()
	Called by the device to wake the queue disc associated with this device transmission queue.

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.

Private Attributes
Ptr< NetDevice >	m_device
	the netdevice aggregated to the NetDeviceQueueInterface

Ptr< QueueLimits >	m_queueLimits
	Queue limits object.

bool	m_stoppedByDevice
	True if the queue has been stopped by the device.

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

WakeCallback	m_wakeCallback
	Wake callback.

	NS_LOG_TEMPLATE_DECLARE
	redefinition of the log component

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.

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 46 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 98 of file net-device-queue-interface.h.

Constructor & Destructor Documentation

◆ NetDeviceQueue()

ns3::NetDeviceQueue::NetDeviceQueue ( )

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

References NS_LOG_FUNCTION.

◆ ~NetDeviceQueue()

ns3::NetDeviceQueue::~NetDeviceQueue ( )

override

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

References m_device, m_queueLimits, m_wakeCallback, NS_LOG_FUNCTION, and ns3::Callback< R, UArgs >::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

queue the queue

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

References ns3::MakeCallback(), NS_ASSERT, PacketDequeued(), PacketDiscarded(), PacketEnqueued(), 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 157 of file net-device-queue-interface.cc.

References m_queueLimits, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::NetDeviceQueue::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 23 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 ( ) 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 50 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

ndqi	the NetDeviceQueueInterface.

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

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

bytes number of bytes queued to the device queue

Reimplemented in ns3::NetDeviceQueueLock.

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

bytes number of bytes the device is going to transmit

Reimplemented in ns3::NetDeviceQueueLock.

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

References ns3::Callback< R, UArgs >::IsNull(), m_queueLimits, m_stoppedByQueueLimits, m_wakeCallback, and NS_LOG_FUNCTION.

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

queue	the device queue
item	the 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 351 of file net-device-queue-interface.h.

References m_device, NotifyTransmittedBytes(), NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and Wake().

Referenced by ConnectQueueTraces().

Here is the call graph for this function:

Here is the caller 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

queue	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 373 of file net-device-queue-interface.h.

References NS_LOG_ERROR, NS_LOG_FUNCTION, and Stop().

Referenced by ConnectQueueTraces().

Here is the call graph for this function:

Here is the caller 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

queue	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 330 of file net-device-queue-interface.h.

References m_device, NotifyQueuedBytes(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and Stop().

Referenced by ConnectQueueTraces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetQueueLimits()

void ns3::NetDeviceQueue::ResetQueueLimits ( )

Reset queue limits state.

Definition at line 139 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 150 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 95 of file net-device-queue-interface.cc.

References m_wakeCallback.