A Discrete-Event Network Simulator
API
ns3::Queue< Item, Container > Class Template Referenceabstract

Template class for packet Queues. More...

#include "queue.h"

+ Inheritance diagram for ns3::Queue< Item, Container >:
+ Collaboration diagram for ns3::Queue< Item, Container >:

Classes

struct  MakeGetItem
 Struct providing a static method returning the object stored within the queue that is included in the container element pointed to by the given const iterator. More...
 
struct  MakeGetItem< T, std::void_t< decltype(std::declval< T >().GetItem(std::declval< ConstIterator >()))> >
 Struct providing a static method returning the object stored within the queue that is included in the container element pointed to by the given const iterator. More...
 

Public Types

typedef Item ItemType
 Define ItemType as the type of the stored elements. More...
 

Public Member Functions

 Queue ()
 
virtual ~Queue ()
 
virtual Ptr< Item > Dequeue (void)=0
 Remove an item from the Queue (each subclass defines the position), counting it and tracing it as dequeued. More...
 
virtual bool Enqueue (Ptr< Item > item)=0
 Place an item into the Queue (each subclass defines the position) More...
 
void Flush (void)
 Flush the queue by calling Remove() on each item enqueued. More...
 
virtual Ptr< const Item > Peek (void) const =0
 Get a copy of an item in the queue (each subclass defines the position) without removing it. More...
 
virtual Ptr< Item > Remove (void)=0
 Remove an item from the Queue (each subclass defines the position), counting it and tracing it as both dequeued and dropped. More...
 
- Public Member Functions inherited from ns3::QueueBase
 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...
 
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). 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<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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::QueueBase
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...
 

Protected Types

typedef Container::const_iterator ConstIterator
 Const iterator. More...
 
typedef Container::iterator Iterator
 Iterator. More...
 

Protected Member Functions

Ptr< Item > DoDequeue (ConstIterator pos)
 Pull the item to dequeue from the queue. More...
 
void DoDispose (void) override
 Destructor implementation. More...
 
bool DoEnqueue (ConstIterator pos, Ptr< Item > item)
 Push an item in the queue. More...
 
bool DoEnqueue (ConstIterator pos, Ptr< Item > item, Iterator &ret)
 Push an item in the queue. More...
 
Ptr< const Item > DoPeek (ConstIterator pos) const
 Peek the front item in the queue. More...
 
Ptr< Item > DoRemove (ConstIterator pos)
 Pull the item to drop from the queue. More...
 
void DropAfterDequeue (Ptr< Item > item)
 Drop a packet after dequeue. More...
 
void DropBeforeEnqueue (Ptr< Item > item)
 Drop a packet before enqueue. More...
 
const ContainerGetContainer (void) const
 Get a const reference to the container of queue items. 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 Attributes

Container m_packets
 the items in the queue More...
 
TracedCallback< Ptr< const Item > > m_traceDequeue
 Traced callback: fired when a packet is dequeued. More...
 
TracedCallback< Ptr< const Item > > m_traceDrop
 Traced callback: fired when a packet is dropped. More...
 
TracedCallback< Ptr< const Item > > m_traceDropAfterDequeue
 Traced callback: fired when a packet is dropped after dequeue. More...
 
TracedCallback< Ptr< const Item > > m_traceDropBeforeEnqueue
 Traced callback: fired when a packet is dropped before enqueue. More...
 
TracedCallback< Ptr< const Item > > m_traceEnqueue
 Traced callback: fired when a packet is enqueued. More...
 
 NS_LOG_TEMPLATE_DECLARE
 the log component More...
 

Additional Inherited Members

- Protected Attributes inherited from ns3::QueueBase
QueueSize m_maxSize
 max queue size More...
 
TracedValue< uint32_tm_nBytes
 Number of bytes in the queue. More...
 
TracedValue< uint32_tm_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...
 

Detailed Description

template<typename Item, typename Container>
class ns3::Queue< Item, Container >

Template class for packet Queues.

This class defines the subset of the base APIs for packet queues in the ns-3 system that is dependent on the type of enqueued objects.

Queue is a template class. The type of the objects stored within the queue is specified by the type parameter, which can be any class providing a GetSize () method (e.g., Packet, QueueDiscItem, etc.). Subclasses need to implement the Enqueue, Dequeue, Remove and Peek methods, and are encouraged to leverage the DoEnqueue, DoDequeue, DoRemove, and DoPeek methods in doing so, to ensure that appropriate trace sources are called and statistics are maintained. The template parameter specifies the type of container used internally to store queue items. The container type must provide the methods insert(), erase() and clear() and define the iterator and const_iterator types, following the usual syntax of C++ containers. The default container type is std::list (as defined in queue-fwd.h). In case the container is such that an object stored within the queue is obtained from a container element through an operation other than dereferencing an iterator pointing to the container element, the container has to provide a public method named GetItem that returns the object stored within the queue that is included in the container element pointed to by a given const iterator.

Users of the Queue template class usually hold a queue through a smart pointer, hence forward declaration is recommended to avoid pulling the implementation of the templates included in this file. Thus, include queue-fwd.h, which provides a forward declaration for the Queue class that defines the default value for the template template parameter, instead of queue.h in your .h file. Then, include queue.h in the corresponding .cc file.

Template Parameters
Item[explicit] Type of the objects stored within the queue
Container[explicit] Type of the container that stores queue items

Definition at line 266 of file queue.h.

Member Typedef Documentation

◆ ConstIterator

template<typename Item , typename Container >
typedef Container::const_iterator ns3::Queue< Item, Container >::ConstIterator
protected

Const iterator.

Definition at line 318 of file queue.h.

◆ ItemType

template<typename Item , typename Container >
typedef Item ns3::Queue< Item, Container >::ItemType

Define ItemType as the type of the stored elements.

Definition at line 314 of file queue.h.

◆ Iterator

template<typename Item , typename Container >
typedef Container::iterator ns3::Queue< Item, Container >::Iterator
protected

Iterator.

Definition at line 320 of file queue.h.

Constructor & Destructor Documentation

◆ Queue()

template<typename Item , typename Container >
ns3::Queue< Item, Container >::Queue

Definition at line 483 of file queue.h.

◆ ~Queue()

template<typename Item , typename Container >
ns3::Queue< Item, Container >::~Queue
virtual

Definition at line 489 of file queue.h.

Member Function Documentation

◆ Dequeue()

template<typename Item , typename Container >
virtual Ptr< Item > ns3::Queue< Item, Container >::Dequeue ( void  )
pure virtual

Remove an item from the Queue (each subclass defines the position), counting it and tracing it as dequeued.

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

Implemented in ns3::DropTailQueue< Item >, and ns3::WifiMacQueue.

◆ DoDequeue()

template<typename Item , typename Container >
Ptr< Item > ns3::Queue< Item, Container >::DoDequeue ( ConstIterator  pos)
protected

Pull the item to dequeue from the queue.

Parameters
posthe position of the item to dequeue
Returns
the item.

Definition at line 538 of file queue.h.

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoDispose()

template<typename Item , typename Container >
void ns3::Queue< Item, Container >::DoDispose ( void  )
overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 610 of file queue.h.

References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.

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

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

◆ DoEnqueue() [1/2]

template<typename Item , typename Container >
bool ns3::Queue< Item, Container >::DoEnqueue ( ConstIterator  pos,
Ptr< Item >  item 
)
protected

Push an item in the queue.

Parameters
posthe position before which the item will be inserted
itemthe item to enqueue
Returns
true if success, false if the packet has been dropped.

Definition at line 502 of file queue.h.

◆ DoEnqueue() [2/2]

template<typename Item , typename Container >
bool ns3::Queue< Item, Container >::DoEnqueue ( ConstIterator  pos,
Ptr< Item >  item,
Iterator ret 
)
protected

Push an item in the queue.

Parameters
posthe position before which the item will be inserted
itemthe item to enqueue
[out]retan iterator pointing to the inserted value
Returns
true if success, false if the packet has been dropped.

Definition at line 510 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoPeek()

template<typename Item , typename Container >
Ptr< const Item > ns3::Queue< Item, Container >::DoPeek ( ConstIterator  pos) const
protected

Peek the front item in the queue.

Parameters
posthe position of the item to peek
Returns
the item.

Definition at line 619 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoRemove()

template<typename Item , typename Container >
Ptr< Item > ns3::Queue< Item, Container >::DoRemove ( ConstIterator  pos)
protected

Pull the item to drop from the queue.

Parameters
posthe position of the item to remove
Returns
the item.

Definition at line 567 of file queue.h.

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::WifiMacQueue::DoRemove(), and ns3::WifiMacQueue::WipeAllExpiredMpdus().

+ Here is the caller graph for this function:

◆ DropAfterDequeue()

template<typename Item , typename Container >
void ns3::Queue< Item, Container >::DropAfterDequeue ( Ptr< Item >  item)
protected

Drop a packet after dequeue.

Parameters
itemitem that was dropped

This method is called by the base class when a Remove operation is requested and by the subclasses to notify parent (this class) that a packet has been dropped for other reasons after being dequeued.

Definition at line 650 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DropBeforeEnqueue()

template<typename Item , typename Container >
void ns3::Queue< Item, Container >::DropBeforeEnqueue ( Ptr< Item >  item)
protected

Drop a packet before enqueue.

Parameters
itemitem 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 before being enqueued.

Definition at line 634 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ Enqueue()

template<typename Item , typename Container >
virtual bool ns3::Queue< Item, Container >::Enqueue ( Ptr< Item >  item)
pure virtual

Place an item into the Queue (each subclass defines the position)

Parameters
itemitem to enqueue
Returns
True if the operation was successful; false otherwise

Implemented in ns3::DropTailQueue< Item >, and ns3::WifiMacQueue.

◆ Flush()

template<typename Item , typename Container >
void ns3::Queue< Item, Container >::Flush ( void  )

Flush the queue by calling Remove() on each item enqueued.

Note that this operation will cause dequeue and drop counts to be incremented and traces to be triggered for each Remove() action.

Definition at line 599 of file queue.h.

References NS_LOG_FUNCTION.

◆ GetContainer()

template<typename Item , typename Container >
const Container & ns3::Queue< Item, Container >::GetContainer ( void  ) const
protected

Get a const reference to the container of queue items.

Returns
a const reference to the container of queue items

Definition at line 495 of file queue.h.

◆ GetTypeId()

template<typename Item , typename Container >
TypeId ns3::Queue< Item, Container >::GetTypeId ( void  )
static

Get the type ID.

Implementation of the templates declared above.

Returns
the object TypeId

Definition at line 453 of file queue.h.

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

+ Here is the call graph for this function:

◆ Peek()

template<typename Item , typename Container >
virtual Ptr< const Item > ns3::Queue< Item, Container >::Peek ( void  ) const
pure virtual

Get a copy of an item in the queue (each subclass defines the position) without removing it.

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

Implemented in ns3::DropTailQueue< Item >, and ns3::WifiMacQueue.

◆ Remove()

template<typename Item , typename Container >
virtual Ptr< Item > ns3::Queue< Item, Container >::Remove ( void  )
pure virtual

Remove an item from the Queue (each subclass defines the position), counting it and tracing it as both dequeued and dropped.

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

Implemented in ns3::DropTailQueue< Item >, and ns3::WifiMacQueue.

Member Data Documentation

◆ m_packets

template<typename Item , typename Container >
Container ns3::Queue< Item, Container >::m_packets
private

the items in the queue

Definition at line 431 of file queue.h.

◆ m_traceDequeue

template<typename Item , typename Container >
TracedCallback<Ptr<const Item> > ns3::Queue< Item, Container >::m_traceDequeue
private

Traced callback: fired when a packet is dequeued.

Definition at line 437 of file queue.h.

◆ m_traceDrop

template<typename Item , typename Container >
TracedCallback<Ptr<const Item> > ns3::Queue< Item, Container >::m_traceDrop
private

Traced callback: fired when a packet is dropped.

Definition at line 439 of file queue.h.

◆ m_traceDropAfterDequeue

template<typename Item , typename Container >
TracedCallback<Ptr<const Item> > ns3::Queue< Item, Container >::m_traceDropAfterDequeue
private

Traced callback: fired when a packet is dropped after dequeue.

Definition at line 443 of file queue.h.

◆ m_traceDropBeforeEnqueue

template<typename Item , typename Container >
TracedCallback<Ptr<const Item> > ns3::Queue< Item, Container >::m_traceDropBeforeEnqueue
private

Traced callback: fired when a packet is dropped before enqueue.

Definition at line 441 of file queue.h.

◆ m_traceEnqueue

template<typename Item , typename Container >
TracedCallback<Ptr<const Item> > ns3::Queue< Item, Container >::m_traceEnqueue
private

Traced callback: fired when a packet is enqueued.

Definition at line 435 of file queue.h.

◆ NS_LOG_TEMPLATE_DECLARE

template<typename Item , typename Container >
ns3::Queue< Item, Container >::NS_LOG_TEMPLATE_DECLARE
private

the log component

Definition at line 432 of file queue.h.


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