Network device transmission queue with lock. More...

#include "netmap-net-device.h"

Inheritance diagram for ns3::NetDeviceQueueLock:

Collaboration diagram for ns3::NetDeviceQueueLock:

Public Member Functions
	NetDeviceQueueLock ()

virtual	~NetDeviceQueueLock ()

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

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.

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

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

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.

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::NetDeviceQueue
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
std::mutex	m_mutex
	Mutex to serialize the operations performed on the queue.

Additional Inherited Members
Public Types inherited from ns3::NetDeviceQueue
typedef Callback< void >	WakeCallback
	Callback invoked by netdevices to wake upper layers.

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

This class stores information about a single transmission queue of a network device that is exposed to queue discs. This class extends the NetDeviceQueue base class by introducing a lock for methods which require mutual exclusion on data access in emulation.

Definition at line 34 of file netmap-net-device.h.

Constructor & Destructor Documentation

◆ NetDeviceQueueLock()

ns3::NetDeviceQueueLock::NetDeviceQueueLock ( )

Definition at line 32 of file netmap-net-device.cc.

◆ ~NetDeviceQueueLock()

ns3::NetDeviceQueueLock::~NetDeviceQueueLock ( )

virtual

Definition at line 36 of file netmap-net-device.cc.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::NetDeviceQueueLock::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 23 of file netmap-net-device.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::NetmapNetDeviceHelper::InstallPriv().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsStopped()

bool ns3::NetDeviceQueueLock::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 from ns3::NetDeviceQueue.

Definition at line 41 of file netmap-net-device.cc.

References ns3::NetDeviceQueue::IsStopped(), and m_mutex.

Here is the call graph for this function:

◆ NotifyQueuedBytes()

void ns3::NetDeviceQueueLock::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 from ns3::NetDeviceQueue.

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

References m_mutex, and ns3::NetDeviceQueue::NotifyQueuedBytes().

Here is the call graph for this function:

◆ NotifyTransmittedBytes()

void ns3::NetDeviceQueueLock::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 from ns3::NetDeviceQueue.

Definition at line 82 of file netmap-net-device.cc.

References m_mutex, and ns3::NetDeviceQueue::NotifyTransmittedBytes().

Here is the call graph for this function:

◆ Start()

void ns3::NetDeviceQueueLock::Start ( )

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 from ns3::NetDeviceQueue.

Definition at line 50 of file netmap-net-device.cc.

References m_mutex, and ns3::NetDeviceQueue::Start().

Here is the call graph for this function:

◆ Stop()

void ns3::NetDeviceQueueLock::Stop ( )

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 from ns3::NetDeviceQueue.

Definition at line 58 of file netmap-net-device.cc.

References m_mutex, and ns3::NetDeviceQueue::Stop().

Here is the call graph for this function:

◆ Wake()

void ns3::NetDeviceQueueLock::Wake ( )

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 from ns3::NetDeviceQueue.

Definition at line 66 of file netmap-net-device.cc.

References m_mutex, and ns3::NetDeviceQueue::Wake().

Here is the call graph for this function:

Member Data Documentation

◆ m_mutex

std::mutex ns3::NetDeviceQueueLock::m_mutex

mutableprivate

Mutex to serialize the operations performed on the queue.

Definition at line 87 of file netmap-net-device.h.

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

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

src/fd-net-device/model/netmap-net-device.h
src/fd-net-device/model/netmap-net-device.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NetDeviceQueueLock()

◆ ~NetDeviceQueueLock()

Member Function Documentation

◆ GetTypeId()

◆ IsStopped()

◆ NotifyQueuedBytes()

◆ NotifyTransmittedBytes()

◆ Start()

◆ Stop()

◆ Wake()

Member Data Documentation

◆ m_mutex