A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Queue Class Referenceabstract

Abstract base class for packet Queues. More...

#include <queue.h>

+ Inheritance diagram for ns3::Queue:
+ Collaboration diagram for ns3::Queue:

Public Types

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

Public Member Functions

 Queue ()
 
virtual ~Queue ()
 
Ptr< PacketDequeue (void)
 
void DequeueAll (void)
 
bool Enqueue (Ptr< Packet > p)
 
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 PacketPeek (void) const
 
void ResetStatistics (void)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Member Functions

void Drop (Ptr< Packet > packet)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Private Member Functions

virtual Ptr< PacketDoDequeue (void)=0
 
virtual bool DoEnqueue (Ptr< Packet > p)=0
 
virtual Ptr< const PacketDoPeek (void) const =0
 

Private Attributes

uint32_t m_nBytes
 
uint32_t m_nPackets
 
uint32_t m_nTotalDroppedBytes
 
uint32_t m_nTotalDroppedPackets
 
uint32_t m_nTotalReceivedBytes
 
uint32_t m_nTotalReceivedPackets
 
TracedCallback< Ptr< const
Packet > > 
m_traceDequeue
 
TracedCallback< Ptr< const
Packet > > 
m_traceDrop
 
TracedCallback< Ptr< const
Packet > > 
m_traceEnqueue
 

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::AlohaNoackNetDevice/Queue
  • /NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/TxQueue
  • /NodeList/[i]/DeviceList/[i]/$ns3::EmuNetDevice/TxQueue
  • /NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/TxQueue

No Attributes are defined for this type.

TraceSources

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

Definition at line 45 of file queue.h.

Member Enumeration Documentation

Enumeration of the modes supported in the class.

Enumerator
QUEUE_MODE_PACKETS 

Use number of packets for maximum queue size

QUEUE_MODE_BYTES 

Use number of bytes for maximum queue size

Definition at line 122 of file queue.h.

Constructor & Destructor Documentation

ns3::Queue::Queue ( )

Definition at line 44 of file queue.cc.

References NS_LOG_FUNCTION.

ns3::Queue::~Queue ( )
virtual

Definition at line 55 of file queue.cc.

References NS_LOG_FUNCTION.

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.

Definition at line 86 of file queue.cc.

References DoDequeue(), ns3::Packet::GetSize(), m_nBytes, m_nPackets, m_traceDequeue, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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

+ 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 107 of file queue.cc.

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

+ Here is the call graph for this function:

virtual Ptr<Packet> ns3::Queue::DoDequeue ( void  )
privatepure virtual

Implemented in ns3::RedQueue, and ns3::DropTailQueue.

Referenced by Dequeue().

+ Here is the caller graph for this function:

virtual bool ns3::Queue::DoEnqueue ( Ptr< Packet p)
privatepure virtual

Implemented in ns3::RedQueue, and ns3::DropTailQueue.

Referenced by Enqueue().

+ Here is the caller graph for this function:

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

Implemented in ns3::RedQueue, and ns3::DropTailQueue.

Referenced by Peek().

+ Here is the caller graph for this function:

void ns3::Queue::Drop ( Ptr< Packet packet)
protected

Definition at line 191 of file queue.cc.

References ns3::Packet::GetSize(), m_nTotalDroppedBytes, m_nTotalDroppedPackets, m_traceDrop, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::DropTailQueue::DoEnqueue(), and ns3::RedQueue::DoEnqueue().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::Queue::Enqueue ( Ptr< Packet p)

Place a packet into the rear of the Queue

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

Definition at line 62 of file queue.cc.

References DoEnqueue(), ns3::Packet::GetSize(), m_nBytes, m_nPackets, m_nTotalReceivedBytes, m_nTotalReceivedPackets, m_traceEnqueue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DropTailQueueTestCase::DoRun(), RedQueueTestCase::Enqueue(), and RedQueueTestCase::RunRedTest().

+ Here is the call graph for this function:

+ 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 133 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 125 of file queue.cc.

References m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by 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 165 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 173 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 149 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 157 of file queue.cc.

References m_nTotalReceivedPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

TypeId ns3::Queue::GetTypeId ( void  )
static

Definition at line 30 of file queue.cc.

References m_traceDequeue, m_traceDrop, m_traceEnqueue, ns3::MakeTraceSourceAccessor(), 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 141 of file queue.cc.

References m_nPackets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DequeueAll().

+ Here is the caller graph for this function:

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.

Definition at line 117 of file queue.cc.

References DoPeek(), and NS_LOG_FUNCTION.

+ 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 181 of file queue.cc.

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

Member Data Documentation

uint32_t ns3::Queue::m_nBytes
private

Definition at line 167 of file queue.h.

Referenced by Dequeue(), Enqueue(), and GetNBytes().

uint32_t ns3::Queue::m_nPackets
private

Definition at line 169 of file queue.h.

Referenced by Dequeue(), Enqueue(), GetNPackets(), and IsEmpty().

uint32_t ns3::Queue::m_nTotalDroppedBytes
private

Definition at line 171 of file queue.h.

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

uint32_t ns3::Queue::m_nTotalDroppedPackets
private

Definition at line 172 of file queue.h.

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

uint32_t ns3::Queue::m_nTotalReceivedBytes
private

Definition at line 168 of file queue.h.

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

uint32_t ns3::Queue::m_nTotalReceivedPackets
private

Definition at line 170 of file queue.h.

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

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

Definition at line 164 of file queue.h.

Referenced by Dequeue(), and GetTypeId().

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

Definition at line 165 of file queue.h.

Referenced by Drop(), and GetTypeId().

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

Definition at line 163 of file queue.h.

Referenced by Enqueue(), and GetTypeId().


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