Abstract base class for packet Queues. More...

#include "queue.h"

Inheritance diagram for ns3::Queue:

Collaboration diagram for ns3::Queue:

Public Types
typedef Callback< void, Ptr< QueueItem > >	DropCallback
	Callback set by the object (e.g., a queue disc) that wants to be notified of a packet drop. More...

enum	QueueMode { QUEUE_MODE_PACKETS, QUEUE_MODE_BYTES }
	Enumeration of the modes supported in the class. More...

Public Member Functions
	Queue ()

virtual	~Queue ()

Ptr< QueueItem >	Dequeue (void)
	Remove an item from the front of the Queue, counting it as dequeued. More...

void	DequeueAll (void)
	Flush the queue. More...

bool	Enqueue (Ptr< QueueItem > item)
	Place a queue item into the rear of the Queue. More...

uint32_t	GetMaxBytes (void) const

uint32_t	GetMaxPackets (void) const

Queue::QueueMode	GetMode (void) const
	Get the encapsulation mode of this device. More...

uint32_t	GetNBytes (void) const

uint32_t	GetNPackets (void) const

uint32_t	GetTotalDroppedBytes (void) const

uint32_t	GetTotalDroppedPackets (void) const

uint32_t	GetTotalReceivedBytes (void) const

uint32_t	GetTotalReceivedPackets (void) const

bool	IsEmpty (void) const

Ptr< const QueueItem >	Peek (void) const
	Get a copy of the item at the front of the queue without removing it. More...

Ptr< QueueItem >	Remove (void)
	Remove an item from the front of the Queue, counting it as dropped. More...

void	ResetStatistics (void)
	Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. More...

virtual void	SetDropCallback (DropCallback cb)
	Set the drop callback. More...

void	SetMaxBytes (uint32_t maxBytes)
	Set the maximum amount of bytes that can be stored in this queue. More...

void	SetMaxPackets (uint32_t maxPackets)
	Set the maximum amount of packets that can be stored in this queue. More...

void	SetMode (Queue::QueueMode mode)
	Set the operating mode of this device. 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
	Implement the GetInstanceTypeId method defined in ObjectBase. 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 ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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 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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
void	Drop (Ptr< QueueItem > item)
	Drop a packet. More...

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

Private Member Functions
virtual Ptr< QueueItem >	DoDequeue (void)=0
	Pull the item to dequeue from the queue. More...

virtual bool	DoEnqueue (Ptr< QueueItem > item)=0
	Push an item in the queue. More...

virtual Ptr< const QueueItem >	DoPeek (void) const =0
	Peek the front item in the queue. More...

virtual Ptr< QueueItem >	DoRemove (void)=0
	Pull the item to drop from the queue. More...

void	NotifyDrop (Ptr< QueueItem > item)
	Notification of a packet drop. More...

Private Attributes
DropCallback	m_dropCallback
	drop callback More...

uint32_t	m_maxBytes
	max bytes in the queue More...

uint32_t	m_maxPackets
	max packets in the queue More...

QueueMode	m_mode
	queue mode (packets or bytes limited) 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_nTotalDroppedPackets
	Total dropped packets. More...

uint32_t	m_nTotalReceivedBytes
	Total received bytes. More...

uint32_t	m_nTotalReceivedPackets
	Total received packets. More...

TracedCallback< Ptr< const Packet > >	m_traceDequeue
	Traced callback: fired when a packet is dequeued. More...

TracedCallback< Ptr< const Packet > >	m_traceDrop
	Traced callback: fired when a packet is dropped. More...

TracedCallback< Ptr< const Packet > >	m_traceEnqueue
	Traced callback: fired when a packet is enqueued. More...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Abstract base class for packet Queues.

This class defines the base APIs for packet queues in the ns-3 system

Config Paths

ns3::Queue is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/TxQueue"
"/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/TxQueue"
"/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/TxQueue"
"/NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Queue"

Attributes

Mode: Whether to use bytes (see MaxBytes) or packets (see MaxPackets) as the maximum queue size metric.
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: QUEUE_MODE_PACKETS
- Flags: construct write read
MaxPackets: The maximum number of packets accepted by this queue.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 100
- Flags: construct write read
MaxBytes: The maximum number of bytes accepted by this queue.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 6553500
- Flags: construct write read

TraceSources

Enqueue: Enqueue a packet in the queue.
Callback signature: ns3::Packet::TracedCallback
Dequeue: Dequeue a packet from the queue.
Callback signature: ns3::Packet::TracedCallback
Drop: Drop a packet (for whatever reason).
Callback signature: ns3::Packet::TracedCallback
PacketsInQueue: Number of packets currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32
BytesInQueue: Number of bytes currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32

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

Definition at line 44 of file queue.h.

Member Typedef Documentation

typedef Callback<void, Ptr<QueueItem> > ns3::Queue::DropCallback

Callback set by the object (e.g., a queue disc) that wants to be notified of a packet drop.

Definition at line 199 of file queue.h.

Constructor & Destructor Documentation

ns3::Queue::Queue ( )

Definition at line 78 of file queue.cc.

References NS_LOG_FUNCTION.

ns3::Queue::~Queue ( )

virtual

Definition at line 90 of file queue.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ptr< QueueItem > ns3::Queue::Dequeue ( void )

Remove an item from the front of the Queue, counting it as dequeued.

Returns: 0 if the operation was not successful; the item otherwise.

Definition at line 135 of file queue.cc.

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

Referenced by DequeueAll(), and DropTailQueueTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Queue::DequeueAll ( void )

Flush the queue.

Definition at line 188 of file queue.cc.

References Dequeue(), IsEmpty(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

virtual Ptr<QueueItem> ns3::Queue::DoDequeue ( void )

privatepure virtual

Pull the item to dequeue from the queue.

Returns: the item.

Implemented in ns3::DropTailQueue.

Referenced by Dequeue().

Here is the caller graph for this function:

virtual bool ns3::Queue::DoEnqueue ( Ptr< QueueItem > item )

privatepure virtual

Push an item in the queue.

Parameters

item	the item to enqueue

Returns: true if success, false if the packet has been dropped.

Implemented in ns3::DropTailQueue.

Referenced by Enqueue().

Here is the caller graph for this function:

virtual Ptr<const QueueItem> ns3::Queue::DoPeek ( void ) const

privatepure virtual

Peek the front item in the queue.

Returns: the item.

Implemented in ns3::DropTailQueue.

Referenced by Peek().

Here is the caller graph for this function:

virtual Ptr<QueueItem> ns3::Queue::DoRemove ( void )

privatepure virtual

Pull the item to drop from the queue.

Returns: the item.

Implemented in ns3::DropTailQueue.

Referenced by Remove().

Here is the caller graph for this function:

void ns3::Queue::Drop ( Ptr< QueueItem > item )

protected

Drop a packet.

Parameters

item	item that was dropped

This method is called by the base class when a packet is dropped because the queue is full and by the subclasses to notify parent (this class) that a packet has been dropped for other reasons.

Definition at line 364 of file queue.cc.

References m_nTotalDroppedBytes, m_nTotalDroppedPackets, m_traceDrop, NotifyDrop(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Enqueue(), and Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Queue::Enqueue ( Ptr< QueueItem > item )

Place a queue item into the rear of the Queue.

Parameters

item	item to enqueue

Returns: True if the operation was successful; false otherwise

Definition at line 97 of file queue.cc.

References DoEnqueue(), Drop(), ns3::TracedValue< T >::Get(), m_maxBytes, m_maxPackets, m_mode, m_nBytes, m_nPackets, m_nTotalReceivedBytes, m_nTotalReceivedPackets, m_traceEnqueue, NS_LOG_FUNCTION, NS_LOG_LOGIC, QUEUE_MODE_BYTES, and QUEUE_MODE_PACKETS.

Referenced by DropTailQueueTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Queue::GetMaxBytes ( void ) const

Returns: the maximum amount of bytes that can be stored in this queue

Definition at line 340 of file queue.cc.

References m_maxBytes, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint32_t ns3::Queue::GetMaxPackets ( void ) const

Returns: the maximum amount of packets that can be stored in this queue

Definition at line 319 of file queue.cc.

References m_maxPackets, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Queue::QueueMode ns3::Queue::GetMode ( void ) const

Get the encapsulation mode of this device.

Returns: The encapsulation mode of this device.

Definition at line 298 of file queue.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint32_t ns3::Queue::GetNBytes ( void ) const

Returns: The number of bytes currently occupied by the packets in the Queue

Definition at line 221 of file queue.cc.

References m_nBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

uint32_t ns3::Queue::GetNPackets ( void ) const

Returns: The number of packets currently stored in the Queue

Definition at line 213 of file queue.cc.

References m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::DropTailQueue::DoDequeue(), ns3::DropTailQueue::DoEnqueue(), ns3::DropTailQueue::DoPeek(), ns3::DropTailQueue::DoRemove(), and DropTailQueueTestCase::DoRun().

Here is the caller graph for this function:

uint32_t ns3::Queue::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 253 of file queue.cc.

References m_nTotalDroppedBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

uint32_t ns3::Queue::GetTotalDroppedPackets ( 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 261 of file queue.cc.

References m_nTotalDroppedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

uint32_t ns3::Queue::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 237 of file queue.cc.

References m_nTotalReceivedBytes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

uint32_t ns3::Queue::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 245 of file queue.cc.

References m_nTotalReceivedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

TypeId ns3::Queue::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 33 of file queue.cc.

References GetMaxBytes(), GetMaxPackets(), GetMode(), m_nBytes, m_nPackets, m_traceDequeue, m_traceDrop, m_traceEnqueue, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), QUEUE_MODE_BYTES, QUEUE_MODE_PACKETS, SetMaxBytes(), SetMaxPackets(), SetMode(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::Queue::IsEmpty ( void ) const

Returns: true if the queue is empty; false otherwise

Definition at line 229 of file queue.cc.

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

Referenced by DequeueAll().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Queue::NotifyDrop ( Ptr< QueueItem > item )

private

Notification of a packet drop.

Parameters

item	item that was dropped

Definition at line 353 of file queue.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_dropCallback, and NS_LOG_FUNCTION.

Referenced by Drop().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< const QueueItem > ns3::Queue::Peek ( void ) const

Get a copy of the item at the front of the queue without removing it.

Returns: 0 if the operation was not successful; the item otherwise.

Definition at line 198 of file queue.cc.

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

Here is the call graph for this function:

Ptr< QueueItem > ns3::Queue::Remove ( void )

Remove an item from the front of the Queue, counting it as dropped.

Returns: 0 if the operation was not successful; the item otherwise.

Definition at line 162 of file queue.cc.

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

Here is the call graph for this function:

void ns3::Queue::ResetStatistics ( void )

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

Definition at line 269 of file queue.cc.

References m_nTotalDroppedBytes, m_nTotalDroppedPackets, m_nTotalReceivedBytes, m_nTotalReceivedPackets, and NS_LOG_FUNCTION.

void ns3::Queue::SetDropCallback ( DropCallback cb )

virtual

Set the drop callback.

Parameters

cb	the callback to set

Called when a queue is added to a queue disc in order to set a callback to the Drop method of the queue disc.

Definition at line 347 of file queue.cc.

References m_dropCallback.

void ns3::Queue::SetMaxBytes ( uint32_t maxBytes )

Set the maximum amount of bytes that can be stored in this queue.

Parameters

maxBytes amount of bytes

Definition at line 326 of file queue.cc.

References ns3::TracedValue< T >::Get(), m_maxBytes, m_mode, m_nBytes, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, and QUEUE_MODE_BYTES.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Queue::SetMaxPackets ( uint32_t maxPackets )

Set the maximum amount of packets that can be stored in this queue.

Parameters

maxPackets amount of packets

Definition at line 305 of file queue.cc.

References ns3::TracedValue< T >::Get(), m_maxPackets, m_mode, m_nPackets, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, and QUEUE_MODE_PACKETS.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Queue::SetMode ( Queue::QueueMode mode )

Set the operating mode of this device.

Parameters

mode	The operating mode of this device.

Definition at line 279 of file queue.cc.

References ns3::TracedValue< T >::Get(), m_mode, m_nBytes, m_nPackets, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, QUEUE_MODE_BYTES, and QUEUE_MODE_PACKETS.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

DropCallback ns3::Queue::m_dropCallback

private

drop callback

Definition at line 267 of file queue.h.

Referenced by NotifyDrop(), and SetDropCallback().

uint32_t ns3::Queue::m_maxBytes

private

max bytes in the queue

Definition at line 265 of file queue.h.

Referenced by Enqueue(), GetMaxBytes(), and SetMaxBytes().

uint32_t ns3::Queue::m_maxPackets

private

max packets in the queue

Definition at line 264 of file queue.h.

Referenced by Enqueue(), GetMaxPackets(), and SetMaxPackets().

QueueMode ns3::Queue::m_mode

private

queue mode (packets or bytes limited)

Definition at line 266 of file queue.h.

Referenced by Enqueue(), GetMode(), SetMaxBytes(), SetMaxPackets(), and SetMode().

TracedValue<uint32_t> ns3::Queue::m_nBytes

private

Number of bytes in the queue.

Definition at line 257 of file queue.h.

Referenced by Dequeue(), Enqueue(), GetNBytes(), GetTypeId(), Remove(), SetMaxBytes(), and SetMode().

TracedValue<uint32_t> ns3::Queue::m_nPackets

private

Number of packets in the queue.

Definition at line 259 of file queue.h.

Referenced by Dequeue(), Enqueue(), GetNPackets(), GetTypeId(), IsEmpty(), Peek(), Remove(), SetMaxPackets(), and SetMode().

uint32_t ns3::Queue::m_nTotalDroppedBytes

private

Total dropped bytes.

Definition at line 261 of file queue.h.

Referenced by Drop(), GetTotalDroppedBytes(), and ResetStatistics().

uint32_t ns3::Queue::m_nTotalDroppedPackets

private

Total dropped packets.

Definition at line 262 of file queue.h.

Referenced by Drop(), GetTotalDroppedPackets(), and ResetStatistics().

uint32_t ns3::Queue::m_nTotalReceivedBytes

private

Total received bytes.

Definition at line 258 of file queue.h.

Referenced by Enqueue(), GetTotalReceivedBytes(), and ResetStatistics().

uint32_t ns3::Queue::m_nTotalReceivedPackets

private

Total received packets.

Definition at line 260 of file queue.h.

Referenced by Enqueue(), GetTotalReceivedPackets(), and ResetStatistics().

TracedCallback<Ptr<const Packet> > ns3::Queue::m_traceDequeue

private

Traced callback: fired when a packet is dequeued.

Definition at line 253 of file queue.h.

Referenced by Dequeue(), and GetTypeId().

TracedCallback<Ptr<const Packet> > ns3::Queue::m_traceDrop

private

Traced callback: fired when a packet is dropped.

Definition at line 255 of file queue.h.

Referenced by Drop(), and GetTypeId().

TracedCallback<Ptr<const Packet> > ns3::Queue::m_traceEnqueue

private

Traced callback: fired when a packet is enqueued.

Definition at line 251 of file queue.h.

Referenced by Enqueue(), and GetTypeId().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation