A FIFO packet queue that drops tail-end packets on overflow. More...

#include "drop-tail-queue.h"

Inheritance diagram for ns3::DropTailQueue:

Collaboration diagram for ns3::DropTailQueue:

Public Member Functions
	DropTailQueue ()
	DropTailQueue Constructor. More...

virtual	~DropTailQueue ()

DropTailQueue::QueueMode	GetMode (void) const
	Get the encapsulation mode of this device. More...

void	SetMode (DropTailQueue::QueueMode mode)
	Set the operating mode of this device. More...

Public Member Functions inherited from ns3::Queue
	Queue ()

virtual	~Queue ()

Ptr< Packet >	Dequeue (void)
	Remove a packet from the front of the Queue. More...

void	DequeueAll (void)
	Flush the queue. More...

bool	Enqueue (Ptr< Packet > p)
	Place a packet into the rear of the Queue. More...

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
	Get a copy of the item at the front of the queue without removing it. More...

void	ResetStatistics (void)
	Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. 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
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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...

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::Queue
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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
virtual Ptr< Packet >	DoDequeue (void)
	Pull a packet from the queue. More...

virtual bool	DoEnqueue (Ptr< Packet > p)
	Push a packet in the queue. More...

virtual Ptr< const Packet >	DoPeek (void) const
	Peek the front packet in the queue. More...

Private Attributes
uint32_t	m_bytesInQueue
	actual bytes in the queue More...

uint32_t	m_maxBytes
	max bytes in the queue More...

uint32_t	m_maxPackets
	max packets in the queue More...

QueueMode	m_mode
	queue mode (packets or bytes limited) More...

std::queue< Ptr< Packet > >	m_packets
	the packets in the queue More...

Additional Inherited Members
Public Types inherited from ns3::Queue
enum	QueueMode { QUEUE_MODE_PACKETS, QUEUE_MODE_BYTES }
	Enumeration of the modes supported in the class. More...

Protected Member Functions inherited from ns3::Queue
void	Drop (Ptr< Packet > packet)
	Drop a packet. 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...

Protected Attributes inherited from ns3::Queue
uint32_t	m_nBytes
	Number of bytes in the queue. More...

uint32_t	m_nPackets
	Number of packets in the queue. More...

uint32_t	m_nTotalDroppedBytes
	Total dropped bytes. More...

uint32_t	m_nTotalDroppedPackets
	Total dropped packets. More...

uint32_t	m_nTotalReceivedBytes
	Total received bytes. More...

uint32_t	m_nTotalReceivedPackets
	Total received packets. More...

TracedCallback< Ptr< const Packet > >	m_traceDequeue
	Traced callback: fired when a packet is dequeued. More...

TracedCallback< Ptr< const Packet > >	m_traceDrop
	Traced callback: fired when a packet is dropped. More...

TracedCallback< Ptr< const Packet > >	m_traceEnqueue
	Traced callback: fired when a packet is enqueued. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

A FIFO packet queue that drops tail-end packets on overflow.

Config Paths

ns3::DropTailQueue is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/TxQueue/$ns3::DropTailQueue"
"/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/TxQueue/$ns3::DropTailQueue"
"/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/TxQueue/$ns3::DropTailQueue"
"/NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Queue/$ns3::DropTailQueue"

Attributes

Mode: Whether to use bytes (see MaxBytes) or packets (see MaxPackets) as the maximum queue size metric.
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: QUEUE_MODE_PACKETS
- Flags: construct write read
MaxPackets: The maximum number of packets accepted by this DropTailQueue.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 100
- Flags: construct write read
MaxBytes: The maximum number of bytes accepted by this DropTailQueue.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 6553500
- Flags: construct write read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::Queue

Enqueue: Enqueue a packet in the queue.
Callback signature: ns3::Packet::TracedCallback
Dequeue: Dequeue a packet from the queue.
Callback signature: ns3::Packet::TracedCallback
Drop: Drop a packet stored in the queue.
Callback signature: ns3::Packet::TracedCallback

Size of this type is 200 bytes (on a 64-bit architecture).

Definition at line 35 of file drop-tail-queue.h.

Constructor & Destructor Documentation

ns3::DropTailQueue::DropTailQueue ( )

DropTailQueue Constructor.

Creates a droptail queue with a maximum size of 100 packets by default

Definition at line 58 of file drop-tail-queue.cc.

References NS_LOG_FUNCTION.

ns3::DropTailQueue::~DropTailQueue ( )

virtual

Definition at line 66 of file drop-tail-queue.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ptr< Packet > ns3::DropTailQueue::DoDequeue ( void )

privatevirtual

Pull a packet from the queue.

Returns: the packet.

Implements ns3::Queue.

Definition at line 114 of file drop-tail-queue.cc.

References ns3::Packet::GetSize(), m_bytesInQueue, m_packets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

bool ns3::DropTailQueue::DoEnqueue ( Ptr< Packet > p )

privatevirtual

Push a packet in the queue.

Parameters

p	the packet to enqueue

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

Implements ns3::Queue.

Definition at line 86 of file drop-tail-queue.cc.

References ns3::Queue::Drop(), ns3::Packet::GetSize(), m_bytesInQueue, m_maxBytes, m_maxPackets, m_mode, m_packets, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.

Here is the call graph for this function:

Ptr< const Packet > ns3::DropTailQueue::DoPeek ( void ) const

privatevirtual

Peek the front packet in the queue.

Returns: the packet.

Implements ns3::Queue.

Definition at line 137 of file drop-tail-queue.cc.

References m_bytesInQueue, m_packets, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

DropTailQueue::QueueMode ns3::DropTailQueue::GetMode ( void ) const

Get the encapsulation mode of this device.

Returns: The encapsulation mode of this device.

Definition at line 79 of file drop-tail-queue.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::DropTailQueue::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 30 of file drop-tail-queue.cc.

References GetMode(), m_maxBytes, m_maxPackets, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeUintegerAccessor(), ns3::Queue::QUEUE_MODE_BYTES, ns3::Queue::QUEUE_MODE_PACKETS, SetMode(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::DropTailQueue::SetMode ( DropTailQueue::QueueMode mode )

Set the operating mode of this device.

Parameters

mode	The operating mode of this device.

Definition at line 72 of file drop-tail-queue.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

uint32_t ns3::DropTailQueue::m_bytesInQueue

private

actual bytes in the queue

Definition at line 74 of file drop-tail-queue.h.

Referenced by DoDequeue(), DoEnqueue(), and DoPeek().

uint32_t ns3::DropTailQueue::m_maxBytes

private

max bytes in the queue

Definition at line 73 of file drop-tail-queue.h.

Referenced by DoEnqueue(), and GetTypeId().

uint32_t ns3::DropTailQueue::m_maxPackets

private

max packets in the queue

Definition at line 72 of file drop-tail-queue.h.

Referenced by DoEnqueue(), and GetTypeId().

QueueMode ns3::DropTailQueue::m_mode

private

queue mode (packets or bytes limited)

Definition at line 75 of file drop-tail-queue.h.

Referenced by DoEnqueue(), GetMode(), and SetMode().

std::queue<Ptr<Packet> > ns3::DropTailQueue::m_packets

private

the packets in the queue

Definition at line 71 of file drop-tail-queue.h.

Referenced by DoDequeue(), DoEnqueue(), and DoPeek().

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

src/network/utils/drop-tail-queue.h
src/network/utils/drop-tail-queue.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources defined in parent class ns3::Queue

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation