Template class for packet Queues. More...

#include "queue.h"

Inheritance diagram for ns3::Queue< Item >:

Collaboration diagram for ns3::Queue< Item >:

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

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Types
typedef std::list< Ptr< Item > >::const_iterator	ConstIterator
	Const iterator. More...

typedef std::list< Ptr< Item > >::iterator	Iterator
	Iterator. More...

Protected Member Functions
Iterator	begin (void)
	Get an iterator which refers to the first item in the queue. More...

ConstIterator	begin (void) const
	Get a const iterator which refers to the first item in the queue. More...

Ptr< Item >	DoDequeue (ConstIterator pos)
	Pull the item to dequeue from the queue. More...

void	DoDispose (void) override

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

Iterator	end (void)
	Get an iterator which indicates past-the-last item in the queue. More...

ConstIterator	end (void) const
	Get a const iterator which indicates past-the-last item in the queue. More...

Private Attributes
std::list< Ptr< Item > >	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...

Detailed Description

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

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.

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, do not include queue.h but add the following forward declaration in your .h file:

template <typename Item> class Queue;

Then, include queue.h in the corresponding .cc file.

Definition at line 253 of file queue.h.

Member Typedef Documentation

◆ ConstIterator

template<typename Item >

typedef std::list<Ptr<Item> >::const_iterator ns3::Queue< Item >::ConstIterator

protected

Const iterator.

Definition at line 306 of file queue.h.

◆ ItemType

template<typename Item >

typedef Item ns3::Queue< Item >::ItemType

Define ItemType as the type of the stored elements.

Definition at line 301 of file queue.h.

◆ Iterator

template<typename Item >

typedef std::list<Ptr<Item> >::iterator ns3::Queue< Item >::Iterator

protected

Iterator.

Definition at line 308 of file queue.h.

Constructor & Destructor Documentation

◆ Queue()

template<typename Item >

ns3::Queue< Item >::Queue

Definition at line 483 of file queue.h.

◆ ~Queue()

template<typename Item >

ns3::Queue< Item >::~Queue

virtual

Definition at line 489 of file queue.h.

Member Function Documentation

◆ begin() [1/2]

template<typename Item >

Queue< Item >::Iterator ns3::Queue< Item >::begin ( void )

protected

Get an iterator which refers to the first item in the queue.

Subclasses can browse the items in the queue by using an iterator

for (auto i = begin (); i != end (); ++i)
  {
    (*i)->method ();  // some method of the Item class
  }

Returns: an iterator which refers to the first item in the queue.

Definition at line 632 of file queue.h.

◆ begin() [2/2]

template<typename Item >

Queue< Item >::ConstIterator ns3::Queue< Item >::begin ( void ) const

protected

Get a const iterator which refers to the first item in the queue.

Subclasses can browse the items in the queue by using a const iterator

for (auto i = begin (); i != end (); ++i)
  {
    (*i)->method ();  // some const method of the Item class
  }

Returns: a const iterator which refers to the first item in the queue.

Definition at line 626 of file queue.h.

◆ Dequeue()

template<typename Item >

virtual Ptr<Item> ns3::Queue< Item >::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 >.

◆ DoDequeue()

template<typename Item >

Ptr< Item > ns3::Queue< Item >::DoDequeue ( ConstIterator pos )

protected

Pull the item to dequeue from the queue.

Parameters

pos	the position of the item to dequeue

Returns: the item.

Definition at line 531 of file queue.h.

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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

Here is the caller graph for this function:

◆ DoDispose()

template<typename Item >

void ns3::Queue< Item >::DoDispose ( void )

overrideprotected

Definition at line 603 of file queue.h.

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

Here is the call graph for this function:

◆ DoEnqueue() [1/2]

template<typename Item >

bool ns3::Queue< Item >::DoEnqueue	(	ConstIterator	pos,
		Ptr< Item >	item
	)

protected

Push an item in the queue.

Parameters

pos	the position before which the item will be inserted
item	the item to enqueue

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

Definition at line 495 of file queue.h.

◆ DoEnqueue() [2/2]

template<typename Item >

bool ns3::Queue< Item >::DoEnqueue	(	ConstIterator	pos,
		Ptr< Item >	item,
		Iterator &	ret
	)

protected

Push an item in the queue.

Parameters

	pos	the position before which the item will be inserted
	item	the item to enqueue
[out]	ret	an iterator pointing to the inserted value

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

Definition at line 503 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoPeek()

template<typename Item >

Ptr< const Item > ns3::Queue< Item >::DoPeek ( ConstIterator pos ) const

protected

Peek the front item in the queue.

Parameters

pos	the position of the item to peek

Returns: the item.

Definition at line 612 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoRemove()

template<typename Item >

Ptr< Item > ns3::Queue< Item >::DoRemove ( ConstIterator pos )

protected

Pull the item to drop from the queue.

Parameters

pos	the position of the item to remove

Returns: the item.

Definition at line 560 of file queue.h.

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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

Here is the caller graph for this function:

◆ DropAfterDequeue()

template<typename Item >

void ns3::Queue< Item >::DropAfterDequeue ( Ptr< Item > item )

protected

Drop a packet after dequeue.

Parameters

item	item 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 667 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DropBeforeEnqueue()

template<typename Item >

void ns3::Queue< Item >::DropBeforeEnqueue ( Ptr< Item > item )

protected

Drop a packet before enqueue.

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

Definition at line 651 of file queue.h.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ end() [1/2]

template<typename Item >

Queue< Item >::Iterator ns3::Queue< Item >::end ( void )

protected

Get an iterator which indicates past-the-last item in the queue.

Subclasses can browse the items in the queue by using an iterator

for (auto i = begin (); i != end (); ++i)
  {
    (*i)->method ();  // some method of the Item class
  }

Returns: an iterator which indicates past-the-last item in the queue.

Definition at line 644 of file queue.h.

◆ end() [2/2]

template<typename Item >

Queue< Item >::ConstIterator ns3::Queue< Item >::end ( void ) const

protected

Get a const iterator which indicates past-the-last item in the queue.

Subclasses can browse the items in the queue by using a const iterator

for (auto i = begin (); i != end (); ++i)
  {
    (*i)->method ();  // some const method of the Item class
  }

Returns: a const iterator which indicates past-the-last item in the queue.

Definition at line 638 of file queue.h.

◆ Enqueue()

template<typename Item >

virtual bool ns3::Queue< Item >::Enqueue ( Ptr< Item > item )

pure virtual

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

Parameters

item	item to enqueue

Returns: True if the operation was successful; false otherwise

Implemented in ns3::DropTailQueue< Item >.

◆ Flush()

template<typename Item >

void ns3::Queue< Item >::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 592 of file queue.h.

References NS_LOG_FUNCTION.

◆ GetTypeId()

template<typename Item >

TypeId ns3::Queue< Item >::GetTypeId ( void )

static

Get the type ID.

Implementation of the templates declared above.

Returns: the object TypeId

Definition at line 457 of file queue.h.

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

Here is the call graph for this function:

◆ Peek()

template<typename Item >

virtual Ptr<const Item> ns3::Queue< Item >::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 >.

◆ Remove()

template<typename Item >

virtual Ptr<Item> ns3::Queue< Item >::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 >.

Member Data Documentation

◆ m_packets

template<typename Item >

std::list<Ptr<Item> > ns3::Queue< Item >::m_packets

private

the items in the queue

Definition at line 435 of file queue.h.

◆ m_traceDequeue

template<typename Item >

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

private

Traced callback: fired when a packet is dequeued.

Definition at line 441 of file queue.h.

◆ m_traceDrop

template<typename Item >

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

private

Traced callback: fired when a packet is dropped.

Definition at line 443 of file queue.h.

◆ m_traceDropAfterDequeue

template<typename Item >

TracedCallback<Ptr<const Item> > ns3::Queue< Item >::m_traceDropAfterDequeue

private

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

Definition at line 447 of file queue.h.

◆ m_traceDropBeforeEnqueue

template<typename Item >

TracedCallback<Ptr<const Item> > ns3::Queue< Item >::m_traceDropBeforeEnqueue

private

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

Definition at line 445 of file queue.h.

◆ m_traceEnqueue

template<typename Item >

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

private

Traced callback: fired when a packet is enqueued.

Definition at line 439 of file queue.h.

◆ NS_LOG_TEMPLATE_DECLARE

template<typename Item >

ns3::Queue< Item >::NS_LOG_TEMPLATE_DECLARE

private

the log component

Definition at line 436 of file queue.h.

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

src/csma/model/csma-net-device.h
src/network/utils/queue.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ ConstIterator

◆ ItemType

◆ Iterator

Constructor & Destructor Documentation

◆ Queue()

◆ ~Queue()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ Dequeue()

◆ DoDequeue()

◆ DoDispose()

◆ DoEnqueue() [1/2]

◆ DoEnqueue() [2/2]

◆ DoPeek()

◆ DoRemove()

◆ DropAfterDequeue()

◆ DropBeforeEnqueue()

◆ end() [1/2]

◆ end() [2/2]

◆ Enqueue()

◆ Flush()

◆ GetTypeId()

◆ Peek()

◆ Remove()

Member Data Documentation

◆ m_packets

◆ m_traceDequeue

◆ m_traceDrop

◆ m_traceDropAfterDequeue

◆ m_traceDropBeforeEnqueue

◆ m_traceEnqueue

◆ NS_LOG_TEMPLATE_DECLARE

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