A Discrete-Event Network Simulator
API
ns3::QueueBase Class Reference

Abstract base class for packet Queues. More...

#include "queue.h"

+ Inheritance diagram for ns3::QueueBase:
+ Collaboration diagram for ns3::QueueBase:

Public Member Functions

 QueueBase ()
 
virtual ~QueueBase ()
 
QueueSize GetCurrentSize (void) const
 
QueueSize GetMaxSize (void) const
 
uint32_t GetNBytes (void) const
 
uint32_t GetNPackets (void) const
 
uint32_t GetTotalDroppedBytes (void) const
 
uint32_t GetTotalDroppedBytesAfterDequeue (void) const
 
uint32_t GetTotalDroppedBytesBeforeEnqueue (void) const
 
uint32_t GetTotalDroppedPackets (void) const
 
uint32_t GetTotalDroppedPacketsAfterDequeue (void) const
 
uint32_t GetTotalDroppedPacketsBeforeEnqueue (void) const
 
uint32_t GetTotalReceivedBytes (void) const
 
uint32_t GetTotalReceivedPackets (void) const
 
bool IsEmpty (void) const
 
void ResetStatistics (void)
 Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. More...
 
void SetMaxSize (QueueSize size)
 Set the maximum size of this queue. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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 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 '>'. More...
 
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

QueueSize m_maxSize
 max queue size More...
 
TracedValue< uint32_t > m_nBytes
 Number of bytes in the queue. More...
 
TracedValue< uint32_t > m_nPackets
 Number of packets in the queue. More...
 
uint32_t m_nTotalDroppedBytes
 Total dropped bytes. More...
 
uint32_t m_nTotalDroppedBytesAfterDequeue
 Total dropped bytes after dequeue. More...
 
uint32_t m_nTotalDroppedBytesBeforeEnqueue
 Total dropped bytes before enqueue. More...
 
uint32_t m_nTotalDroppedPackets
 Total dropped packets. More...
 
uint32_t m_nTotalDroppedPacketsAfterDequeue
 Total dropped packets after dequeue. More...
 
uint32_t m_nTotalDroppedPacketsBeforeEnqueue
 Total dropped packets before enqueue. More...
 
uint32_t m_nTotalReceivedBytes
 Total received bytes. More...
 
uint32_t m_nTotalReceivedPackets
 Total received packets. More...
 

Friends

template<typename Item >
class Queue
 Friend class. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Abstract base class for packet Queues.


Introspection did not find any typical Config paths.

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


No Attributes are defined for this type.

TraceSources

Size of this type is 128 bytes (on a 64-bit architecture).

Definition at line 52 of file queue.h.

Constructor & Destructor Documentation

◆ QueueBase()

ns3::QueueBase::QueueBase ( )

Definition at line 51 of file queue.cc.

References m_maxSize, max, NS_LOG_FUNCTION, and ns3::PACKETS.

◆ ~QueueBase()

ns3::QueueBase::~QueueBase ( )
virtual

Definition at line 67 of file queue.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AppendItemTypeIfNotPresent()

void ns3::QueueBase::AppendItemTypeIfNotPresent ( std::string &  typeId,
const std::string &  itemType 
)
static

Append the item type to the provided type ID if the latter does not end with '>'.

Parameters
typeIdthe type ID
itemTypethe 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 73 of file queue.cc.

Referenced by ns3::TrafficControlHelper::AddInternalQueues(), ns3::SimpleNetDeviceHelper::SetQueue(), ns3::CsmaHelper::SetQueue(), and ns3::PointToPointHelper::SetQueue().

+ Here is the caller graph for this function:

◆ GetCurrentSize()

QueueSize ns3::QueueBase::GetCurrentSize ( void  ) const
Returns
The current size of the Queue in terms of packets, if the maximum size is specified in packets, or bytes, otherwise

Definition at line 106 of file queue.cc.

References ns3::BYTES, ns3::QueueSize::GetUnit(), m_maxSize, m_nBytes, m_nPackets, NS_ABORT_MSG, NS_LOG_FUNCTION, and ns3::PACKETS.

Referenced by SetMaxSize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetMaxSize()

QueueSize ns3::QueueBase::GetMaxSize ( void  ) const
Returns
the maximum size of this queue

Definition at line 217 of file queue.cc.

References m_maxSize, and NS_LOG_FUNCTION.

Referenced by ns3::DropTailQueue< Item >::GetTypeId(), and ns3::WifiMacQueue::GetTypeId().

+ Here is the caller graph for this function:

◆ GetNBytes()

uint32_t ns3::QueueBase::GetNBytes ( void  ) const
Returns
The number of bytes currently occupied by the packets in the Queue

Definition at line 98 of file queue.cc.

References m_nBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

Referenced by ns3::WifiMacQueue::GetNBytes().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetNPackets()

uint32_t ns3::QueueBase::GetNPackets ( void  ) const
Returns
The number of packets currently stored in the Queue

Definition at line 90 of file queue.cc.

References m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

Referenced by ns3::WifiMacQueue::GetNPackets(), and ns3::WifiMacQueue::Insert().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTotalDroppedBytes()

uint32_t ns3::QueueBase::GetTotalDroppedBytes ( void  ) const
Returns
The total number of bytes dropped by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 138 of file queue.cc.

References m_nTotalDroppedBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalDroppedBytesAfterDequeue()

uint32_t ns3::QueueBase::GetTotalDroppedBytesAfterDequeue ( void  ) const
Returns
The total number of bytes dropped after dequeue by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 154 of file queue.cc.

References m_nTotalDroppedBytesAfterDequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalDroppedBytesBeforeEnqueue()

uint32_t ns3::QueueBase::GetTotalDroppedBytesBeforeEnqueue ( void  ) const
Returns
The total number of bytes dropped before enqueue by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 146 of file queue.cc.

References m_nTotalDroppedBytesBeforeEnqueue, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalDroppedPackets()

uint32_t ns3::QueueBase::GetTotalDroppedPackets ( void  ) const
Returns
The total number of packets dropped by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 162 of file queue.cc.

References m_nTotalDroppedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalDroppedPacketsAfterDequeue()

uint32_t ns3::QueueBase::GetTotalDroppedPacketsAfterDequeue ( void  ) const
Returns
The total number of packets dropped after dequeue by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 178 of file queue.cc.

References m_nTotalDroppedPacketsAfterDequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalDroppedPacketsBeforeEnqueue()

uint32_t ns3::QueueBase::GetTotalDroppedPacketsBeforeEnqueue ( void  ) const
Returns
The total number of packets dropped before enqueue by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 170 of file queue.cc.

References m_nTotalDroppedPacketsBeforeEnqueue, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalReceivedBytes()

uint32_t ns3::QueueBase::GetTotalReceivedBytes ( void  ) const
Returns
The total number of bytes received by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 122 of file queue.cc.

References m_nTotalReceivedBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTotalReceivedPackets()

uint32_t ns3::QueueBase::GetTotalReceivedPackets ( void  ) const
Returns
The total number of packets received by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

Definition at line 130 of file queue.cc.

References m_nTotalReceivedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::QueueBase::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 34 of file queue.cc.

References m_nBytes, m_nPackets, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsEmpty()

bool ns3::QueueBase::IsEmpty ( void  ) const
Returns
true if the queue is empty; false otherwise

Definition at line 82 of file queue.cc.

References ns3::TracedValue< T >::Get(), m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ ResetStatistics()

void ns3::QueueBase::ResetStatistics ( void  )

◆ SetMaxSize()

void ns3::QueueBase::SetMaxSize ( QueueSize  size)

Set the maximum size of this queue.

Trying to set a null size has no effect.

Parameters
sizethe maximum size

Definition at line 200 of file queue.cc.

References GetCurrentSize(), ns3::QueueSize::GetValue(), m_maxSize, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by ns3::DropTailQueue< Item >::GetTypeId(), and ns3::WifiMacQueue::GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Queue

template<typename Item >
friend class Queue
friend

Friend class.

Definition at line 222 of file queue.h.

Member Data Documentation

◆ m_maxSize

QueueSize ns3::QueueBase::m_maxSize
private

max queue size

Definition at line 218 of file queue.h.

Referenced by GetCurrentSize(), GetMaxSize(), QueueBase(), and SetMaxSize().

◆ m_nBytes

TracedValue<uint32_t> ns3::QueueBase::m_nBytes
private

Number of bytes in the queue.

Definition at line 207 of file queue.h.

Referenced by GetCurrentSize(), GetNBytes(), and GetTypeId().

◆ m_nPackets

TracedValue<uint32_t> ns3::QueueBase::m_nPackets
private

Number of packets in the queue.

Definition at line 209 of file queue.h.

Referenced by GetCurrentSize(), GetNPackets(), GetTypeId(), and IsEmpty().

◆ m_nTotalDroppedBytes

uint32_t ns3::QueueBase::m_nTotalDroppedBytes
private

Total dropped bytes.

Definition at line 211 of file queue.h.

Referenced by GetTotalDroppedBytes(), and ResetStatistics().

◆ m_nTotalDroppedBytesAfterDequeue

uint32_t ns3::QueueBase::m_nTotalDroppedBytesAfterDequeue
private

Total dropped bytes after dequeue.

Definition at line 213 of file queue.h.

Referenced by GetTotalDroppedBytesAfterDequeue(), and ResetStatistics().

◆ m_nTotalDroppedBytesBeforeEnqueue

uint32_t ns3::QueueBase::m_nTotalDroppedBytesBeforeEnqueue
private

Total dropped bytes before enqueue.

Definition at line 212 of file queue.h.

Referenced by GetTotalDroppedBytesBeforeEnqueue(), and ResetStatistics().

◆ m_nTotalDroppedPackets

uint32_t ns3::QueueBase::m_nTotalDroppedPackets
private

Total dropped packets.

Definition at line 214 of file queue.h.

Referenced by GetTotalDroppedPackets(), and ResetStatistics().

◆ m_nTotalDroppedPacketsAfterDequeue

uint32_t ns3::QueueBase::m_nTotalDroppedPacketsAfterDequeue
private

Total dropped packets after dequeue.

Definition at line 216 of file queue.h.

Referenced by GetTotalDroppedPacketsAfterDequeue(), and ResetStatistics().

◆ m_nTotalDroppedPacketsBeforeEnqueue

uint32_t ns3::QueueBase::m_nTotalDroppedPacketsBeforeEnqueue
private

Total dropped packets before enqueue.

Definition at line 215 of file queue.h.

Referenced by GetTotalDroppedPacketsBeforeEnqueue(), and ResetStatistics().

◆ m_nTotalReceivedBytes

uint32_t ns3::QueueBase::m_nTotalReceivedBytes
private

Total received bytes.

Definition at line 208 of file queue.h.

Referenced by GetTotalReceivedBytes(), and ResetStatistics().

◆ m_nTotalReceivedPackets

uint32_t ns3::QueueBase::m_nTotalReceivedPackets
private

Total received packets.

Definition at line 210 of file queue.h.

Referenced by GetTotalReceivedPackets(), and ResetStatistics().


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