ns3::NetDeviceQueue Class Reference

Network device transmission queue. More...

#include "net-device.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 ()
virtual bool	HasWakeCallbackSet (void) const
	Check whether a wake callback has been set on this device queue. More...
bool	IsStopped (void) const
	Get the status of the device transmission queue. More...
virtual void	SetWakeCallback (WakeCallback cb)
	Set the wake callback. More...
virtual void	Start (void)
	Called by the device to start this (hardware) transmission queue. More...
virtual void	Stop (void)
	Called by the device to stop this (hardware) transmission queue. More...
virtual void	Wake (void)
	Called by the device to wake the queue disc associated with this (hardware) transmission queue. More...
Public Member Functions inherited from ns3::SimpleRefCount< NetDeviceQueue >
	SimpleRefCount ()
	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. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) const
	Decrement the reference count. More...

Private Attributes
bool	m_stopped
	Status of the transmission queue. More...
WakeCallback	m_wakeCallback
	Wake callback. More...

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< NetDeviceQueue >
static void	Cleanup (void)
	Noop. 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.

Todo:

Implement BQL

Definition at line 140 of file net-device.h.

Member Typedef Documentation

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

Callback invoked by netdevices to wake upper layers.

Definition at line 175 of file net-device.h.

Constructor & Destructor Documentation

ns3::NetDeviceQueue::NetDeviceQueue

(

)

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

References NS_LOG_FUNCTION.

ns3::NetDeviceQueue::~NetDeviceQueue ( )

virtual

Definition at line 74 of file net-device.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

virtual

Check whether a wake callback has been set on this device queue.

Returns

true if the wake callback has been set.

Definition at line 116 of file net-device.cc.

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

Here is the call graph for this function:

bool ns3::NetDeviceQueue::IsStopped

(

void

)

const

Get the status of the device transmission queue.

Returns

true if the (hardware) 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_tx_queue_stopped function of the Linux kernel.

Definition at line 80 of file net-device.cc.

References m_stopped.

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 110 of file net-device.cc.

References m_wakeCallback.

void ns3::NetDeviceQueue::Start ( void  )

virtual

Called by the device to start this (hardware) transmission queue.

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

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

References m_stopped.

Referenced by Wake().

Here is the caller graph for this function:

void ns3::NetDeviceQueue::Stop ( void  )

virtual

Called by the device to stop this (hardware) transmission queue.

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

Definition at line 92 of file net-device.cc.

References m_stopped.

void ns3::NetDeviceQueue::Wake ( void  )

virtual

Called by the device to wake the queue disc associated with this (hardware) 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.

Definition at line 98 of file net-device.cc.

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

Here is the call graph for this function:

Member Data Documentation

bool ns3::NetDeviceQueue::m_stopped

private

Status of the transmission queue.

Definition at line 196 of file net-device.h.

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

WakeCallback ns3::NetDeviceQueue::m_wakeCallback

private

Wake callback.

Definition at line 197 of file net-device.h.

Referenced by HasWakeCallbackSet(), SetWakeCallback(), and Wake().

---

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

• src/network/model/net-device.h
• src/network/model/net-device.cc