ns3::Queue Class Reference
[Queue]

Abstract base class for packet Queues. More...

#include <queue.h>

Inheritance diagram for ns3::Queue:

[legend]

Collaboration diagram for ns3::Queue:

[legend]

List of all members.

Public Member Functions
bool	IsEmpty (void) const
bool	Enqueue (Ptr< Packet > p)
Ptr< Packet >	Dequeue (void)
Ptr< const Packet >	Peek (void) const
void	DequeueAll (void)
uint32_t	GetNPackets (void) const
uint32_t	GetNBytes (void) const
uint32_t	GetTotalReceivedBytes (void) const
uint32_t	GetTotalReceivedPackets (void) const
uint32_t	GetTotalDroppedBytes (void) const
uint32_t	GetTotalDroppedPackets (void) const
void	ResetStatistics (void)
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Queue.

---

Detailed Description

Abstract base class for packet Queues.

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

---

Member Function Documentation

Ptr<Packet> ns3::Queue::Dequeue

(

void

)

Remove a packet from the front of the Queue

Returns:

0 if the operation was not successful; the packet otherwise.

void ns3::Queue::DequeueAll

(

void

)

Flush the queue.

bool ns3::Queue::Enqueue

(

Ptr< Packet >

p

)

Place a packet into the rear of the Queue

Returns:

True if the operation was successful; false otherwise

uint32_t ns3::Queue::GetNBytes

(

void

)

const

Returns:

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

uint32_t ns3::Queue::GetNPackets

(

void

)

const

Returns:

The number of packets currently stored in the Queue

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

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

uint32_t ns3::Queue::GetTotalReceivedBytes

(

void

)

const

Returns:

The total number of bytes recieved by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

uint32_t ns3::Queue::GetTotalReceivedPackets

(

void

)

const

Returns:

The total number of packets recieved by this Queue since the simulation began, or since ResetStatistics was called, according to whichever happened more recently

static TypeId ns3::Queue::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::Queue.

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/TxQueue
• /NodeList/[i]/DeviceList/[i]/$ns3::EmuNetDevice/TxQueue
• /NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/TxQueue

No Attributes defined for this type.
TraceSources defined for this type:

• Enqueue: Enqueue a packet in the queue.
• Dequeue: Dequeue a packet from the queue.
• Drop: Drop a packet stored in the queue.

Reimplemented from ns3::Object.

Reimplemented in ns3::DropTailQueue.

bool ns3::Queue::IsEmpty

(

void

)

const

Returns:

true if the queue is empty; false otherwise

Ptr<const Packet> 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 packet otherwise.

void ns3::Queue::ResetStatistics

(

void

)

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

---

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

• src/node/queue.h
• doc/introspected-doxygen.h