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 ()

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

virtual	~Queue ()

Ptr< QueueItem >	Dequeue (void)
	Remove an item from the front of the Queue, counting it as dequeued. More...

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

bool	Enqueue (Ptr< QueueItem > item)
	Place a queue item into the rear of the Queue. More...

uint32_t	GetMaxBytes (void) const

uint32_t	GetMaxPackets (void) const

Queue::QueueMode	GetMode (void) const
	Get the encapsulation mode of this device. 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 QueueItem >	Peek (void) const
	Get a copy of the item at the front of the queue without removing it. More...

Ptr< QueueItem >	Remove (void)
	Remove an item from the front of the Queue, counting it as dropped. More...

void	ResetStatistics (void)
	Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. More...

virtual void	SetDropCallback (DropCallback cb)
	Set the drop callback. More...

void	SetMaxBytes (uint32_t maxBytes)
	Set the maximum amount of bytes that can be stored in this queue. More...

void	SetMaxPackets (uint32_t maxPackets)
	Set the maximum amount of packets that can be stored in this queue. More...

void	SetMode (Queue::QueueMode mode)
	Set the operating mode of this device. 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...

bool	IsInitialized (void) const
	Check if the object has been initialized. 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< QueueItem >	DoDequeue (void)
	Pull the item to dequeue from the queue. More...

virtual bool	DoEnqueue (Ptr< QueueItem > item)
	Push an item in the queue. More...

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

virtual Ptr< QueueItem >	DoRemove (void)
	Pull the item to drop from the queue. More...

Private Attributes
std::queue< Ptr< QueueItem > >	m_packets
	the items in the queue More...

Additional Inherited Members
Public Types inherited from ns3::Queue
typedef Callback< void, Ptr< QueueItem > >	DropCallback
	Callback set by the object (e.g., a queue disc) that wants to be notified of a packet drop. More...

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< QueueItem > item)
	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...

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"

No Attributes are defined for this type.

Attributes defined in parent class ns3::Queue

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 queue.
- 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 queue.
- 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 (for whatever reason).
Callback signature: ns3::Packet::TracedCallback
PacketsInQueue: Number of packets currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32
BytesInQueue: Number of bytes currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32