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< Packet >	Dequeue (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 Packet >	Peek (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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (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)
	This method returns the TypeId associated to ns3::Queue.

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	DoStart (void)
virtual void	NotifyNewAggregate (void)

Private Member Functions
virtual Ptr< Packet >	DoDequeue (void)=0
virtual bool	DoEnqueue (Ptr< Packet > p)=0
virtual Ptr< const Packet >	DoPeek (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

Definition at line 45 of file queue.h.

Member Enumeration Documentation

enum ns3::Queue::QueueMode

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

ns3::Queue::~Queue ( )

virtual

Definition at line 55 of file queue.cc.

References NS_LOG_FUNCTION_NOARGS.

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(), ns3::AlohaNoackNetDevice::NotifyTransmissionEnd(), ns3::PointToPointNetDevice::Send(), ns3::EmuNetDevice::SendFrom(), ns3::CsmaNetDevice::SendFrom(), ns3::CsmaNetDevice::TransmitAbort(), ns3::PointToPointNetDevice::TransmitComplete(), and ns3::CsmaNetDevice::TransmitReadyEvent().

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

Referenced by Dequeue().

Here is the caller graph for this function:

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

privatepure virtual

Referenced by Enqueue().

Here is the caller graph for this function:

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

privatepure virtual

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

p	packet 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 ns3::PointToPointNetDevice::Send(), ns3::AlohaNoackNetDevice::SendFrom(), ns3::EmuNetDevice::SendFrom(), and ns3::CsmaNetDevice::SendFrom().

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_NOARGS, 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_NOARGS, and NS_LOG_LOGIC.

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_NOARGS, 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_NOARGS, 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_NOARGS, 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_NOARGS, and NS_LOG_LOGIC.

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: