Abstract base class for packet Queues. More...
#include "queue.h"
Public Member Functions | |
QueueBase () | |
~QueueBase () override | |
QueueSize | GetCurrentSize () const |
QueueSize | GetMaxSize () const |
uint32_t | GetNBytes () const |
uint32_t | GetNPackets () const |
uint32_t | GetTotalDroppedBytes () const |
uint32_t | GetTotalDroppedBytesAfterDequeue () const |
uint32_t | GetTotalDroppedBytesBeforeEnqueue () const |
uint32_t | GetTotalDroppedPackets () const |
uint32_t | GetTotalDroppedPacketsAfterDequeue () const |
uint32_t | GetTotalDroppedPacketsBeforeEnqueue () const |
uint32_t | GetTotalReceivedBytes () const |
uint32_t | GetTotalReceivedPackets () const |
bool | IsEmpty () const |
void | ResetStatistics () |
Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. | |
void | SetMaxSize (QueueSize size) |
Set the maximum size of this queue. | |
bool | WouldOverflow (uint32_t nPackets, uint32_t nBytes) const |
Check if the queue would overflow with additional bytes or packets Note: the check is performed according to the queue's operating mode (bytes or packets). | |
![]() | |
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 final |
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. | |
![]() | |
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. | |
![]() | |
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 void | AppendItemTypeIfNotPresent (std::string &typeId, const std::string &itemType) |
Append the item type to the provided type ID if the latter does not end with '>'. | |
static TypeId | GetTypeId () |
Get the type ID. | |
![]() | |
static TypeId | GetTypeId () |
Register this type. | |
![]() | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Attributes | |
QueueSize | m_maxSize |
max queue size | |
TracedValue< uint32_t > | m_nBytes |
Number of bytes in the queue. | |
TracedValue< uint32_t > | m_nPackets |
Number of packets in the queue. | |
uint32_t | m_nTotalDroppedBytes |
Total dropped bytes. | |
uint32_t | m_nTotalDroppedBytesAfterDequeue |
Total dropped bytes after dequeue. | |
uint32_t | m_nTotalDroppedBytesBeforeEnqueue |
Total dropped bytes before enqueue. | |
uint32_t | m_nTotalDroppedPackets |
Total dropped packets. | |
uint32_t | m_nTotalDroppedPacketsAfterDequeue |
Total dropped packets after dequeue. | |
uint32_t | m_nTotalDroppedPacketsBeforeEnqueue |
Total dropped packets before enqueue. | |
uint32_t | m_nTotalReceivedBytes |
Total received bytes. | |
uint32_t | m_nTotalReceivedPackets |
Total received packets. | |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
![]() | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Abstract base class for packet Queues.
Introspection did not find any typical Config paths
No Attributes are defined for this type
This class defines the subset of the base APIs for packet queues in the ns-3 system that is independent of the type of enqueued objects
Group: Network
Size of this type is 168 bytes (on a 64-bit architecture).
ns3::QueueBase::QueueBase | ( | ) |
Definition at line 40 of file queue.cc.
References m_maxSize, m_nBytes, m_nPackets, m_nTotalDroppedBytes, m_nTotalDroppedBytesAfterDequeue, m_nTotalDroppedBytesBeforeEnqueue, m_nTotalDroppedPackets, m_nTotalDroppedPacketsAfterDequeue, m_nTotalDroppedPacketsBeforeEnqueue, m_nTotalReceivedBytes, m_nTotalReceivedPackets, NS_LOG_FUNCTION, and ns3::PACKETS.
Referenced by ns3::Queue< Item, Container >::GetTypeId().
|
override |
Definition at line 56 of file queue.cc.
References NS_LOG_FUNCTION.
|
static |
Append the item type to the provided type ID if the latter does not end with '>'.
typeId | the type ID |
itemType | the item type |
This method is meant to be invoked by helpers to save users from specifying the type of items stored in a queue. For instance, PointToPointHelper::SetQueue calls
where type specifies the queue type (e.g., "ns3::DropTailQueue"). This allows users to call SetQueue ("ns3::DropTailQueue") instead of SetQueue ("ns3::DropTailQueue<Packet>")
Definition at line 62 of file queue.cc.
Referenced by ns3::TrafficControlHelper::AddInternalQueues(), ns3::CsmaHelper::SetQueue(), ns3::PointToPointHelper::SetQueue(), and ns3::SimpleNetDeviceHelper::SetQueue().
QueueSize ns3::QueueBase::GetCurrentSize | ( | ) | const |
Definition at line 95 of file queue.cc.
References ns3::BYTES, m_maxSize, m_nBytes, m_nPackets, NS_ABORT_MSG, NS_LOG_FUNCTION, and ns3::PACKETS.
Referenced by ns3::Queue< Item, Container >::DoEnqueue(), and SetMaxSize().
QueueSize ns3::QueueBase::GetMaxSize | ( | ) | const |
Definition at line 206 of file queue.cc.
References m_maxSize, and NS_LOG_FUNCTION.
Referenced by ns3::WifiMacQueue::DoDequeue(), ns3::Queue< Item, Container >::DoEnqueue(), ns3::WifiMacQueue::DoEnqueue(), ns3::WifiMacQueue::DoRemove(), ns3::DropTailQueue< Item >::GetTypeId(), ns3::WifiMacQueue::GetTypeId(), and ns3::WifiMacQueue::Insert().
uint32_t ns3::QueueBase::GetNBytes | ( | ) | const |
Definition at line 87 of file queue.cc.
References m_nBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetNPackets | ( | ) | const |
Definition at line 79 of file queue.cc.
References m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by ns3::WifiMacQueue::Insert().
uint32_t ns3::QueueBase::GetTotalDroppedBytes | ( | ) | const |
Definition at line 127 of file queue.cc.
References m_nTotalDroppedBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalDroppedBytesAfterDequeue | ( | ) | const |
Definition at line 143 of file queue.cc.
References m_nTotalDroppedBytesAfterDequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalDroppedBytesBeforeEnqueue | ( | ) | const |
Definition at line 135 of file queue.cc.
References m_nTotalDroppedBytesBeforeEnqueue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalDroppedPackets | ( | ) | const |
Definition at line 151 of file queue.cc.
References m_nTotalDroppedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalDroppedPacketsAfterDequeue | ( | ) | const |
Definition at line 167 of file queue.cc.
References m_nTotalDroppedPacketsAfterDequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalDroppedPacketsBeforeEnqueue | ( | ) | const |
Definition at line 159 of file queue.cc.
References m_nTotalDroppedPacketsBeforeEnqueue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalReceivedBytes | ( | ) | const |
Definition at line 111 of file queue.cc.
References m_nTotalReceivedBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
uint32_t ns3::QueueBase::GetTotalReceivedPackets | ( | ) | const |
Definition at line 119 of file queue.cc.
References m_nTotalReceivedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
static |
Get the type ID.
Definition at line 24 of file queue.cc.
References ns3::Object::Object(), m_nBytes, m_nPackets, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
bool ns3::QueueBase::IsEmpty | ( | ) | const |
Definition at line 71 of file queue.cc.
References m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by ns3::Queue< Item, Container >::Flush().
void ns3::QueueBase::ResetStatistics | ( | ) |
Resets the counts for dropped packets, dropped bytes, received packets, and received bytes.
Definition at line 175 of file queue.cc.
References m_nTotalDroppedBytes, m_nTotalDroppedBytesAfterDequeue, m_nTotalDroppedBytesBeforeEnqueue, m_nTotalDroppedPackets, m_nTotalDroppedPacketsAfterDequeue, m_nTotalDroppedPacketsBeforeEnqueue, m_nTotalReceivedBytes, m_nTotalReceivedPackets, and NS_LOG_FUNCTION.
void ns3::QueueBase::SetMaxSize | ( | QueueSize | size | ) |
Set the maximum size of this queue.
Trying to set a null size has no effect.
size | the maximum size |
Definition at line 189 of file queue.cc.
References GetCurrentSize(), ns3::QueueSize::GetValue(), m_maxSize, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.
Referenced by ns3::WifiMacQueue::DoDequeue(), ns3::WifiMacQueue::DoEnqueue(), ns3::WifiMacQueue::DoRemove(), ns3::DropTailQueue< Item >::GetTypeId(), and ns3::WifiMacQueue::GetTypeId().
Check if the queue would overflow with additional bytes or packets Note: the check is performed according to the queue's operating mode (bytes or packets).
nPackets | number of additional packets |
nBytes | number of additional bytes |
Definition at line 213 of file queue.cc.
References m_maxSize, m_nBytes, m_nPackets, and ns3::PACKETS.
|
protected |
max queue size
Definition at line 218 of file queue.h.
Referenced by QueueBase(), GetCurrentSize(), GetMaxSize(), SetMaxSize(), and WouldOverflow().
|
protected |
Number of bytes in the queue.
Definition at line 207 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DoDequeue(), ns3::Queue< Item, Container >::DoEnqueue(), ns3::Queue< Item, Container >::DoRemove(), GetCurrentSize(), GetNBytes(), GetTypeId(), and WouldOverflow().
|
protected |
Number of packets in the queue.
Definition at line 209 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DoDequeue(), ns3::Queue< Item, Container >::DoEnqueue(), ns3::Queue< Item, Container >::DoPeek(), ns3::Queue< Item, Container >::DoRemove(), GetCurrentSize(), GetNPackets(), GetTypeId(), IsEmpty(), and WouldOverflow().
|
protected |
Total dropped bytes.
Definition at line 211 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DropAfterDequeue(), ns3::Queue< Item, Container >::DropBeforeEnqueue(), GetTotalDroppedBytes(), and ResetStatistics().
|
protected |
Total dropped bytes after dequeue.
Definition at line 213 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DropAfterDequeue(), GetTotalDroppedBytesAfterDequeue(), and ResetStatistics().
|
protected |
Total dropped bytes before enqueue.
Definition at line 212 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DropBeforeEnqueue(), GetTotalDroppedBytesBeforeEnqueue(), and ResetStatistics().
|
protected |
Total dropped packets.
Definition at line 214 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DropAfterDequeue(), ns3::Queue< Item, Container >::DropBeforeEnqueue(), GetTotalDroppedPackets(), and ResetStatistics().
|
protected |
Total dropped packets after dequeue.
Definition at line 216 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DropAfterDequeue(), GetTotalDroppedPacketsAfterDequeue(), and ResetStatistics().
|
protected |
Total dropped packets before enqueue.
Definition at line 215 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DropBeforeEnqueue(), GetTotalDroppedPacketsBeforeEnqueue(), and ResetStatistics().
|
protected |
Total received bytes.
Definition at line 208 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DoEnqueue(), GetTotalReceivedBytes(), and ResetStatistics().
|
protected |
Total received packets.
Definition at line 210 of file queue.h.
Referenced by QueueBase(), ns3::Queue< Item, Container >::DoEnqueue(), GetTotalReceivedPackets(), and ResetStatistics().