Network device transmission queue with lock. More...
#include "netmap-net-device.h"
Public Member Functions | |
NetDeviceQueueLock () | |
virtual | ~NetDeviceQueueLock () |
virtual bool | IsStopped () const |
Get the status of the device transmission queue. 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... | |
virtual void | Start () |
Called by the device to start this device transmission queue. More... | |
virtual void | Stop () |
Called by the device to stop this device transmission queue. More... | |
virtual void | Wake () |
Called by the device to wake the queue disc associated with this device transmission queue. More... | |
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. More... | |
Ptr< QueueLimits > | GetQueueLimits () |
Get queue limits to this queue. More... | |
void | NotifyAggregatedObject (Ptr< NetDeviceQueueInterface > ndqi) |
Notify this NetDeviceQueue that the NetDeviceQueueInterface was aggregated to an object. 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... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () 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< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () 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 () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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 () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::NetDeviceQueue | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Attributes | |
std::mutex | m_mutex |
Mutex to serialize the operations performed on the queue. More... | |
Additional Inherited Members | |
Public Types inherited from ns3::NetDeviceQueue | |
typedef Callback< void > | WakeCallback |
Callback invoked by netdevices to wake upper layers. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoDispose () |
Destructor implementation. More... | |
virtual void | DoInitialize () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
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 45 of file netmap-net-device.h.
ns3::NetDeviceQueueLock::NetDeviceQueueLock | ( | ) |
Definition at line 43 of file netmap-net-device.cc.
|
virtual |
Definition at line 47 of file netmap-net-device.cc.
|
static |
Get the type ID.
Definition at line 34 of file netmap-net-device.cc.
References ns3::TypeId::SetParent().
Referenced by ns3::NetmapNetDeviceHelper::InstallPriv().
|
virtual |
Get the status of the device transmission queue.
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 52 of file netmap-net-device.cc.
References ns3::NetDeviceQueue::IsStopped(), and m_mutex.
|
virtual |
Called by the netdevice to report the number of bytes queued to the device queue.
bytes | number of bytes queued to the device queue |
Reimplemented from ns3::NetDeviceQueue.
Definition at line 85 of file netmap-net-device.cc.
References m_mutex, and ns3::NetDeviceQueue::NotifyQueuedBytes().
|
virtual |
Called by the netdevice to report the number of bytes it is going to transmit.
bytes | number of bytes the device is going to transmit |
Reimplemented from ns3::NetDeviceQueue.
Definition at line 93 of file netmap-net-device.cc.
References m_mutex, and ns3::NetDeviceQueue::NotifyTransmittedBytes().
|
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 61 of file netmap-net-device.cc.
References m_mutex, and ns3::NetDeviceQueue::Start().
|
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 69 of file netmap-net-device.cc.
References m_mutex, and ns3::NetDeviceQueue::Stop().
|
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 77 of file netmap-net-device.cc.
References m_mutex, and ns3::NetDeviceQueue::Wake().
|
mutableprivate |
Mutex to serialize the operations performed on the queue.
Definition at line 98 of file netmap-net-device.h.
Referenced by IsStopped(), NotifyQueuedBytes(), NotifyTransmittedBytes(), Start(), Stop(), and Wake().