A Discrete-Event Network Simulator
API
ns3::DropTailQueue< Item > Class Template Reference

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

#include "drop-tail-queue.h"

+ Inheritance diagram for ns3::DropTailQueue< Item >:
+ Collaboration diagram for ns3::DropTailQueue< Item >:

Public Member Functions

 DropTailQueue ()
 DropTailQueue Constructor. More...
 
virtual ~DropTailQueue ()
 
virtual Ptr< Item > Dequeue (void)
 Remove an item from the Queue (each subclass defines the position), counting it as dequeued. More...
 
virtual bool Enqueue (Ptr< Item > item)
 Place an item into the Queue (each subclass defines the position) More...
 
virtual Ptr< const Item > Peek (void) const
 Get a copy of an item in the queue (each subclass defines the position) without removing it. More...
 
virtual Ptr< Item > Remove (void)
 Remove an item from the Queue (each subclass defines the position), counting it as dropped. More...
 
- Public Member Functions inherited from ns3::Queue< Item >
 Queue ()
 
virtual ~Queue ()
 
void Flush (void)
 Flush the queue. More...
 
- Public Member Functions inherited from ns3::QueueBase
 QueueBase ()
 
virtual ~QueueBase ()
 
QueueSize GetCurrentSize (void) const
 
QueueSize GetMaxSize (void) const
 
uint32_t GetNBytes (void) const
 
uint32_t GetNPackets (void) const
 
uint32_t GetTotalDroppedBytes (void) const
 
uint32_t GetTotalDroppedBytesAfterDequeue (void) const
 
uint32_t GetTotalDroppedBytesBeforeEnqueue (void) const
 
uint32_t GetTotalDroppedPackets (void) const
 
uint32_t GetTotalDroppedPacketsAfterDequeue (void) const
 
uint32_t GetTotalDroppedPacketsBeforeEnqueue (void) const
 
uint32_t GetTotalReceivedBytes (void) const
 
uint32_t GetTotalReceivedPackets (void) const
 
bool IsEmpty (void) const
 
void ResetStatistics (void)
 Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. More...
 
void SetMaxSize (QueueSize size)
 Set the maximum size of this queue. 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
 Get the most derived TypeId for this Object. 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 ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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< Item >
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::QueueBase
static void AppendItemTypeIfNotPresent (std::string &typeId, const std::string &itemType)
 Append the item type to the provided type ID if the latter does not end with '>'. More...
 
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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

 NS_LOG_TEMPLATE_DECLARE
 redefinition of the log component More...
 

Additional Inherited Members

- Public Types inherited from ns3::Queue< Item >
typedef Item ItemType
 Define ItemType as the type of the stored elements. More...
 
- Protected Types inherited from ns3::Queue< Item >
typedef std::list< Ptr< Item > >::const_iterator ConstIterator
 Const iterator. More...
 
typedef std::list< Ptr< Item > >::iterator Iterator
 Iterator. More...
 
- Protected Member Functions inherited from ns3::Queue< Item >
ConstIterator begin (void) const
 Get a const iterator which refers to the first item in the queue. More...
 
Iterator begin (void)
 Get an iterator which refers to the first item in the queue. More...
 
Ptr< Item > DoDequeue (ConstIterator pos)
 Pull the item to dequeue from the queue. More...
 
bool DoEnqueue (ConstIterator pos, Ptr< Item > item)
 Push an item in the queue. More...
 
Ptr< const Item > DoPeek (ConstIterator pos) const
 Peek the front item in the queue. More...
 
Ptr< Item > DoRemove (ConstIterator pos)
 Pull the item to drop from the queue. More...
 
void DropAfterDequeue (Ptr< Item > item)
 Drop a packet after dequeue. More...
 
void DropBeforeEnqueue (Ptr< Item > item)
 Drop a packet before enqueue. More...
 
ConstIterator end (void) const
 Get a const iterator which indicates past-the-last item in the queue. More...
 
Iterator end (void)
 Get an iterator which indicates past-the-last item in the queue. 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...
 

Detailed Description

template<typename Item>
class ns3::DropTailQueue< Item >

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

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

Constructor & Destructor Documentation

◆ DropTailQueue()

template<typename Item >
ns3::DropTailQueue< Item >::DropTailQueue ( )

DropTailQueue Constructor.

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

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

References NS_LOG_FUNCTION.

◆ ~DropTailQueue()

template<typename Item >
ns3::DropTailQueue< Item >::~DropTailQueue ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Dequeue()

template<typename Item >
Ptr< Item > ns3::DropTailQueue< Item >::Dequeue ( void  )
virtual

Remove an item from the Queue (each subclass defines the position), counting it as dequeued.

Returns
0 if the operation was not successful; the item otherwise.

Implements ns3::Queue< Item >.

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

References NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ Enqueue()

template<typename Item >
bool ns3::DropTailQueue< Item >::Enqueue ( Ptr< Item >  item)
virtual

Place an item into the Queue (each subclass defines the position)

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

Implements ns3::Queue< Item >.

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

References NS_LOG_FUNCTION.

◆ GetTypeId()

template<typename Item >
TypeId ns3::DropTailQueue< Item >::GetTypeId ( void  )
static

Get the type ID.

Implementation of the templates declared above.

Returns
the object TypeId

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

References ns3::QueueBase::GetMaxSize(), ns3::GetTypeParamName(), ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::QueueBase::SetMaxSize(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Peek()

template<typename Item >
Ptr< const Item > ns3::DropTailQueue< Item >::Peek ( void  ) const
virtual

Get a copy of an item in the queue (each subclass defines the position) without removing it.

Returns
0 if the operation was not successful; the item otherwise.

Implements ns3::Queue< Item >.

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

References NS_LOG_FUNCTION.

◆ Remove()

template<typename Item >
Ptr< Item > ns3::DropTailQueue< Item >::Remove ( void  )
virtual

Remove an item from the Queue (each subclass defines the position), counting it as dropped.

Returns
0 if the operation was not successful; the item otherwise.

Implements ns3::Queue< Item >.

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

References NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

Member Data Documentation

◆ NS_LOG_TEMPLATE_DECLARE

template<typename Item >
ns3::DropTailQueue< Item >::NS_LOG_TEMPLATE_DECLARE
private

redefinition of the log component

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


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