A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
ns3::FifoQueueDisc Class Reference

Simple queue disc implementing the FIFO (First-In First-Out) policy. More...

#include "fifo-queue-disc.h"

+ Inheritance diagram for ns3::FifoQueueDisc:

Public Member Functions

 FifoQueueDisc ()
 FifoQueueDisc constructor. More...
 
virtual ~FifoQueueDisc ()
 
- Public Member Functions inherited from ns3::QueueDisc
 QueueDisc (QueueDiscSizePolicy policy=QueueDiscSizePolicy::SINGLE_INTERNAL_QUEUE)
 Constructor. More...
 
 QueueDisc (QueueDiscSizePolicy policy, QueueSizeUnit unit)
 Constructor. More...
 
virtual ~QueueDisc ()
 
void AddInternalQueue (Ptr< InternalQueue > queue)
 Add an internal queue to the tail of the list of queues. More...
 
void AddPacketFilter (Ptr< PacketFilter > filter)
 Add a packet filter to the tail of the list of filters used to classify packets. More...
 
void AddQueueDiscClass (Ptr< QueueDiscClass > qdClass)
 Add a queue disc class to the tail of the list of classes. More...
 
int32_t Classify (Ptr< QueueDiscItem > item)
 Classify a packet by calling the packet filters, one at a time, until either a filter able to classify the packet is found or all the filters have been processed. More...
 
Ptr< QueueDiscItemDequeue (void)
 Extract from the queue disc the packet that has been dequeued by calling Peek, if any, or call the private DoDequeue method (which must be implemented by derived classes) to dequeue a packet, otherwise. More...
 
bool Enqueue (Ptr< QueueDiscItem > item)
 Pass a packet to store to the queue discipline. More...
 
QueueSize GetCurrentSize (void)
 Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise. More...
 
Ptr< InternalQueueGetInternalQueue (std::size_t i) const
 Get the i-th internal queue. More...
 
QueueSize GetMaxSize (void) const
 Get the maximum size of the queue disc. More...
 
uint32_t GetNBytes (void) const
 Get the amount of bytes stored by the queue disc. More...
 
Ptr< NetDeviceGetNetDevice (void) const
 Get the NetDevice on which this queue discipline is installed. More...
 
std::size_t GetNInternalQueues (void) const
 Get the number of internal queues. More...
 
std::size_t GetNPacketFilters (void) const
 Get the number of packet filters. More...
 
uint32_t GetNPackets (void) const
 Get the number of packets stored by the queue disc. More...
 
std::size_t GetNQueueDiscClasses (void) const
 Get the number of queue disc classes. More...
 
Ptr< PacketFilterGetPacketFilter (std::size_t i) const
 Get the i-th packet filter. More...
 
Ptr< QueueDiscClassGetQueueDiscClass (std::size_t i) const
 Get the i-th queue disc class. More...
 
virtual uint32_t GetQuota (void) const
 Get the maximum number of dequeue operations following a packet enqueue. More...
 
const StatsGetStats (void)
 Retrieve all the collected statistics. More...
 
virtual WakeMode GetWakeMode (void) const
 When setting up the wake callbacks on the netdevice queues, it is necessary to determine which queue disc (the root queue disc or one of its children) should be activated when the netdevice wakes one of its transmission queues. More...
 
Ptr< const QueueDiscItemPeek (void)
 Get a copy of the next packet the queue discipline will extract. More...
 
void Run (void)
 Modelled after the Linux function __qdisc_run (net/sched/sch_generic.c) Dequeues multiple packets, until a quota is exceeded or sending a packet to the device failed. More...
 
bool SetMaxSize (QueueSize size)
 Set the maximum size of the queue disc. More...
 
void SetNetDevice (Ptr< NetDevice > device)
 Set the NetDevice on which this queue discipline is installed. More...
 
virtual void SetQuota (const uint32_t quota)
 Set the maximum number of dequeue operations following a packet enqueue. 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::QueueDisc
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...
 

Static Public Attributes

static constexpr const char * LIMIT_EXCEEDED_DROP = "Queue disc limit exceeded"
 Packet dropped due to queue disc limit exceeded. More...
 
- Static Public Attributes inherited from ns3::QueueDisc
static constexpr const char * CHILD_QUEUE_DISC_DROP = "(Dropped by child queue disc) "
 Packet dropped by a child queue disc. More...
 
static constexpr const char * INTERNAL_QUEUE_DROP = "Dropped by internal queue"
 Packet dropped by an internal queue. More...
 

Private Member Functions

virtual bool CheckConfig (void)
 Check whether the current configuration is correct. More...
 
virtual Ptr< QueueDiscItemDoDequeue (void)
 This function actually extracts a packet from the queue disc. More...
 
virtual bool DoEnqueue (Ptr< QueueDiscItem > item)
 This function actually enqueues a packet into the queue disc. More...
 
virtual Ptr< const QueueDiscItemDoPeek (void)
 Return a copy of the next packet the queue disc will extract. More...
 
virtual void InitializeParams (void)
 Initialize parameters (if any) before the first packet is enqueued. More...
 

Additional Inherited Members

- Public Types inherited from ns3::QueueDisc
typedef Queue< QueueDiscItemInternalQueue
 Internal queues store QueueDiscItem objects. More...
 
enum  WakeMode { WAKE_ROOT = 0x00, WAKE_CHILD = 0x01 }
 Used to determine whether the queue disc itself or its children must be activated when a netdevice wakes a transmission queue. More...
 
- Protected Member Functions inherited from ns3::QueueDisc
virtual void DoDispose (void)
 Dispose of the object. More...
 
void DoInitialize (void)
 Check whether the configuration is correct and initialize parameters. More...
 
void DropAfterDequeue (Ptr< const QueueDiscItem > item, const char *reason)
 Perform the actions required when the queue disc is notified of a packet dropped after dequeue. More...
 
void DropBeforeEnqueue (Ptr< const QueueDiscItem > item, const char *reason)
 Perform the actions required when the queue disc is notified of a packet dropped before enqueue. More...
 
bool Mark (Ptr< QueueDiscItem > item, const char *reason)
 Marks the given packet and, if successful, updates the counters associated with the given reason. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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

Simple queue disc implementing the FIFO (First-In First-Out) policy.


Introspection did not find any typical Config paths.


Attributes

Attributes defined in parent class ns3::QueueDisc

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::QueueDisc

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

Definition at line 34 of file fifo-queue-disc.h.

Constructor & Destructor Documentation

◆ FifoQueueDisc()

ns3::FifoQueueDisc::FifoQueueDisc ( )

FifoQueueDisc constructor.

Creates a queue with a depth of 1000 packets by default

Definition at line 49 of file fifo-queue-disc.cc.

References NS_LOG_FUNCTION.

◆ ~FifoQueueDisc()

ns3::FifoQueueDisc::~FifoQueueDisc ( )
virtual

Definition at line 55 of file fifo-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckConfig()

bool ns3::FifoQueueDisc::CheckConfig ( void  )
privatevirtual

Check whether the current configuration is correct.

Default objects (such as internal queues) might be created by this method to ensure the configuration is correct.

Returns
true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 116 of file fifo-queue-disc.cc.

References ns3::QueueDisc::AddInternalQueue(), ns3::CreateObjectWithAttributes(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), NS_LOG_ERROR, and NS_LOG_FUNCTION.

◆ DoDequeue()

Ptr< QueueDiscItem > ns3::FifoQueueDisc::DoDequeue ( void  )
privatevirtual

This function actually extracts a packet from the queue disc.

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

Implements ns3::QueueDisc.

Definition at line 84 of file fifo-queue-disc.cc.

References ns3::QueueDisc::GetInternalQueue(), NS_LOG_FUNCTION, and NS_LOG_LOGIC().

◆ DoEnqueue()

bool ns3::FifoQueueDisc::DoEnqueue ( Ptr< QueueDiscItem item)
privatevirtual

This function actually enqueues a packet into the queue disc.

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

Implements ns3::QueueDisc.

Definition at line 61 of file fifo-queue-disc.cc.

References ns3::QueueDisc::DropBeforeEnqueue(), ns3::QueueDisc::GetCurrentSize(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), LIMIT_EXCEEDED_DROP, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

◆ DoPeek()

Ptr< const QueueDiscItem > ns3::FifoQueueDisc::DoPeek ( void  )
privatevirtual

Return a copy of the next packet the queue disc will extract.

The implementation of this method is based on the qdisc_peek_dequeued function of the Linux kernel, which dequeues a packet and retains it in the queue disc as a requeued packet. The packet is not traced as requeued, nor is the total count of requeued packets increased. The packet is still considered to be part of the queue disc and the dequeue trace is fired when Dequeue is called and the packet is actually extracted from the queue disc.

This approach is especially recommended for queue discs for which it is not obvious what is the next packet that will be dequeued (e.g., queue discs having multiple internal queues or child queue discs or queue discs that drop packets after dequeue). Subclasses can however provide their own implementation of this method that overrides the default one.

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

Reimplemented from ns3::QueueDisc.

Definition at line 100 of file fifo-queue-disc.cc.

References ns3::QueueDisc::GetInternalQueue(), NS_LOG_FUNCTION, and NS_LOG_LOGIC().

◆ GetTypeId()

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

◆ InitializeParams()

void ns3::FifoQueueDisc::InitializeParams ( void  )
privatevirtual

Initialize parameters (if any) before the first packet is enqueued.

Implements ns3::QueueDisc.

Definition at line 148 of file fifo-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Data Documentation

◆ LIMIT_EXCEEDED_DROP

constexpr const char* ns3::FifoQueueDisc::LIMIT_EXCEEDED_DROP = "Queue disc limit exceeded"
static

Packet dropped due to queue disc limit exceeded.

Definition at line 51 of file fifo-queue-disc.h.

Referenced by DoEnqueue().


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