Abstract base class for packet Queues. More...

#include "queue.h"

Inheritance diagram for ns3::QueueBase:

Collaboration diagram for ns3::QueueBase:

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).

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.

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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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

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
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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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

BytesInQueue: Number of bytes currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32
PacketsInQueue: Number of packets currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32

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

Definition at line 54 of file queue.h.

Constructor & Destructor Documentation

◆ QueueBase()

ns3::QueueBase::QueueBase ( )

Definition at line 51 of file queue.cc.

References m_maxSize, NS_LOG_FUNCTION, and ns3::PACKETS.

◆ ~QueueBase()

ns3::QueueBase::~QueueBase ( )

override

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

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

QueueBase::AppendItemTypeIfNotPresent (type, "Packet");

ns3::QueueBase::AppendItemTypeIfNotPresent

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 '>'.

Definition: queue.cc:73

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::CsmaHelper::SetQueue(), ns3::SimpleNetDeviceHelper::SetQueue(), and ns3::PointToPointHelper::SetQueue().

Here is the caller graph for this function:

◆ GetCurrentSize()

QueueSize ns3::QueueBase::GetCurrentSize ( ) 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 ( ) 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::WifiMacQueue::DoDequeue(), ns3::WifiMacQueue::DoEnqueue(), ns3::WifiMacQueue::DoRemove(), ns3::DropTailQueue< Item >::GetTypeId(), ns3::WifiMacQueue::GetTypeId(), and ns3::WifiMacQueue::Insert().

Here is the caller graph for this function:

◆ GetNBytes()

uint32_t ns3::QueueBase::GetNBytes ( ) 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.

◆ GetNPackets()

uint32_t ns3::QueueBase::GetNPackets ( ) 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::Insert().

Here is the caller graph for this function:

◆ GetTotalDroppedBytes()

uint32_t ns3::QueueBase::GetTotalDroppedBytes ( ) 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.

◆ GetTotalDroppedBytesAfterDequeue()

uint32_t ns3::QueueBase::GetTotalDroppedBytesAfterDequeue ( ) 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.

◆ GetTotalDroppedBytesBeforeEnqueue()

uint32_t ns3::QueueBase::GetTotalDroppedBytesBeforeEnqueue ( ) 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.

◆ GetTotalDroppedPackets()

uint32_t ns3::QueueBase::GetTotalDroppedPackets ( ) 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.

◆ GetTotalDroppedPacketsAfterDequeue()

uint32_t ns3::QueueBase::GetTotalDroppedPacketsAfterDequeue ( ) 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.

◆ GetTotalDroppedPacketsBeforeEnqueue()

uint32_t ns3::QueueBase::GetTotalDroppedPacketsBeforeEnqueue ( ) 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.

◆ GetTotalReceivedBytes()

uint32_t ns3::QueueBase::GetTotalReceivedBytes ( ) 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.

◆ GetTotalReceivedPackets()

uint32_t ns3::QueueBase::GetTotalReceivedPackets ( ) 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.

◆ GetTypeId()

TypeId ns3::QueueBase::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 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 ( ) 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 ( )

Resets the counts for dropped packets, dropped bytes, received packets, and received bytes.

Definition at line 186 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.

◆ SetMaxSize()

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

Set the maximum size of this queue.

Trying to set a null size has no effect.

Parameters

size	the 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::WifiMacQueue::DoDequeue(), ns3::WifiMacQueue::DoEnqueue(), ns3::WifiMacQueue::DoRemove(), ns3::DropTailQueue< Item >::GetTypeId(), and ns3::WifiMacQueue::GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WouldOverflow()

bool ns3::QueueBase::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).

Parameters

nPackets	number of additional packets
nBytes	number of additional bytes

Returns: true if the queue should overflow, false otherwise.

Definition at line 224 of file queue.cc.

References ns3::QueueSize::GetUnit(), ns3::QueueSize::GetValue(), m_maxSize, m_nBytes, m_nPackets, and ns3::PACKETS.

Here is the call graph for this function:

Member Data Documentation

◆ m_maxSize

QueueSize ns3::QueueBase::m_maxSize

protected

max queue size

Definition at line 229 of file queue.h.

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

◆ m_nBytes

TracedValue<uint32_t> ns3::QueueBase::m_nBytes

protected

Number of bytes in the queue.

Definition at line 218 of file queue.h.

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

◆ m_nPackets

TracedValue<uint32_t> ns3::QueueBase::m_nPackets

protected

Number of packets in the queue.

Definition at line 220 of file queue.h.

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

◆ m_nTotalDroppedBytes

uint32_t ns3::QueueBase::m_nTotalDroppedBytes

protected

Total dropped bytes.

Definition at line 222 of file queue.h.

Referenced by GetTotalDroppedBytes(), and ResetStatistics().

◆ m_nTotalDroppedBytesAfterDequeue

uint32_t ns3::QueueBase::m_nTotalDroppedBytesAfterDequeue

protected

Total dropped bytes after dequeue.

Definition at line 224 of file queue.h.

Referenced by GetTotalDroppedBytesAfterDequeue(), and ResetStatistics().

◆ m_nTotalDroppedBytesBeforeEnqueue

uint32_t ns3::QueueBase::m_nTotalDroppedBytesBeforeEnqueue

protected

Total dropped bytes before enqueue.

Definition at line 223 of file queue.h.

Referenced by GetTotalDroppedBytesBeforeEnqueue(), and ResetStatistics().

◆ m_nTotalDroppedPackets

uint32_t ns3::QueueBase::m_nTotalDroppedPackets

protected

Total dropped packets.

Definition at line 225 of file queue.h.

Referenced by GetTotalDroppedPackets(), and ResetStatistics().

◆ m_nTotalDroppedPacketsAfterDequeue

uint32_t ns3::QueueBase::m_nTotalDroppedPacketsAfterDequeue

protected

Total dropped packets after dequeue.

Definition at line 227 of file queue.h.

Referenced by GetTotalDroppedPacketsAfterDequeue(), and ResetStatistics().

◆ m_nTotalDroppedPacketsBeforeEnqueue

uint32_t ns3::QueueBase::m_nTotalDroppedPacketsBeforeEnqueue

protected

Total dropped packets before enqueue.

Definition at line 226 of file queue.h.

Referenced by GetTotalDroppedPacketsBeforeEnqueue(), and ResetStatistics().

◆ m_nTotalReceivedBytes

uint32_t ns3::QueueBase::m_nTotalReceivedBytes

protected

Total received bytes.

Definition at line 219 of file queue.h.

Referenced by GetTotalReceivedBytes(), and ResetStatistics().

◆ m_nTotalReceivedPackets

uint32_t ns3::QueueBase::m_nTotalReceivedPackets

protected

Total received packets.

Definition at line 221 of file queue.h.

Referenced by GetTotalReceivedPackets(), and ResetStatistics().

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

src/network/utils/queue.h
src/network/utils/queue.cc

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

TraceSources

Constructor & Destructor Documentation

◆ QueueBase()

◆ ~QueueBase()

Member Function Documentation

◆ AppendItemTypeIfNotPresent()

◆ GetCurrentSize()

◆ GetMaxSize()

◆ GetNBytes()

◆ GetNPackets()

◆ GetTotalDroppedBytes()

◆ GetTotalDroppedBytesAfterDequeue()

◆ GetTotalDroppedBytesBeforeEnqueue()

◆ GetTotalDroppedPackets()

◆ GetTotalDroppedPacketsAfterDequeue()

◆ GetTotalDroppedPacketsBeforeEnqueue()

◆ GetTotalReceivedBytes()

◆ GetTotalReceivedPackets()

◆ GetTypeId()

◆ IsEmpty()

◆ ResetStatistics()

◆ SetMaxSize()

◆ WouldOverflow()

Member Data Documentation

◆ m_maxSize

◆ m_nBytes

◆ m_nPackets

◆ m_nTotalDroppedBytes

◆ m_nTotalDroppedBytesAfterDequeue

◆ m_nTotalDroppedBytesBeforeEnqueue

◆ m_nTotalDroppedPackets

◆ m_nTotalDroppedPacketsAfterDequeue

◆ m_nTotalDroppedPacketsBeforeEnqueue

◆ m_nTotalReceivedBytes

◆ m_nTotalReceivedPackets