A Discrete-Event Network Simulator
API
ns3::QKDKMSQueueLogic Class Reference

Linux pfifo_fast is the default priority queue enabled on Linux systems. More...

#include "qkd-kms-queue-logic.h"

+ Inheritance diagram for ns3::QKDKMSQueueLogic:
+ Collaboration diagram for ns3::QKDKMSQueueLogic:

Classes

struct  QKDKMSQueueEntry
 The KMS Queue elements. More...
 

Public Member Functions

 QKDKMSQueueLogic ()
 Constructor. More...
 
 ~QKDKMSQueueLogic ()
 Destructor. More...
 
QKDKMSQueueLogic::QKDKMSQueueEntry Dequeue (void)
 Pop the element from the queue. More...
 
bool Enqueue (QKDKMSQueueEntry item)
 Add the element to the queue. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

uint32_t m_maxSize
 The queue size. More...
 
TracedValue< uint32_t > m_nPackets
 The number of packets in the queue. More...
 
uint32_t m_numberOfQueues
 The number of queues. More...
 
std::vector< std::vector< QKDKMSQueueEntry > > m_queues
 A list of queues. More...
 
TracedCallback< const HTTPMessagem_traceDequeue
 A trace for the dequeue packet. More...
 
TracedCallback< const HTTPMessagem_traceDroped
 A trace for the dropped packet. More...
 
TracedCallback< const HTTPMessagem_traceEnqueue
 A trace for the enqueued packet. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Linux pfifo_fast is the default priority queue enabled on Linux systems.

Packets are enqueued in three FIFO droptail queues according to three priority bands based on the packet priority.

The system behaves similar to three ns3::DropTail queues operating together, in which packets from higher priority bands are always dequeued before a packet from a lower priority band is dequeued.

The queue disc capacity, i.e., the maximum number of packets that can be enqueued in the queue disc, is set through the limit attribute, which plays the same role as txqueuelen in Linux. If no internal queue is provided, three DropTail queues having each a capacity equal to limit are created by default. User is allowed to provide queues, but they must be three, operate in packet mode and each have a capacity not less than limit.

Note
Additional waiting queues are installed between the L3 and ISO/OSI layer to avoid conflicts in decision making which could lead to inaccurate routing. Experimental testing and usage!

Definition at line 58 of file qkd-kms-queue-logic.h.

Constructor & Destructor Documentation

◆ QKDKMSQueueLogic()

ns3::QKDKMSQueueLogic::QKDKMSQueueLogic ( )

Constructor.

Creates a queue with a depth of 1000 packets per band by default.

Definition at line 63 of file qkd-kms-queue-logic.cc.

References m_numberOfQueues, m_queues, and NS_LOG_FUNCTION.

◆ ~QKDKMSQueueLogic()

ns3::QKDKMSQueueLogic::~QKDKMSQueueLogic ( )

Destructor.

Definition at line 73 of file qkd-kms-queue-logic.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Dequeue()

QKDKMSQueueLogic::QKDKMSQueueEntry ns3::QKDKMSQueueLogic::Dequeue ( void  )

Pop the element from the queue.

Returns
The queue element.

Definition at line 124 of file qkd-kms-queue-logic.cc.

References ns3::QKDKMSQueueLogic::QKDKMSQueueEntry::httpMessage, m_maxSize, m_nPackets, m_numberOfQueues, m_queues, m_traceDequeue, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ Enqueue()

bool ns3::QKDKMSQueueLogic::Enqueue ( QKDKMSQueueEntry  item)

Add the element to the queue.

Parameters
itemThe element.
Returns
The success indicator.

Definition at line 79 of file qkd-kms-queue-logic.cc.

References ns3::HTTPMessage::GetMessageBodyString(), ns3::QKDKMSQueueLogic::QKDKMSQueueEntry::httpMessage, m_maxSize, m_nPackets, m_numberOfQueues, m_queues, m_traceDroped, m_traceEnqueue, NS_FATAL_ERROR, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
The object TypeId.

Definition at line 34 of file qkd-kms-queue-logic.cc.

References m_maxSize, m_nPackets, m_numberOfQueues, m_traceDequeue, m_traceDroped, m_traceEnqueue, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_maxSize

uint32_t ns3::QKDKMSQueueLogic::m_maxSize
private

The queue size.

Definition at line 111 of file qkd-kms-queue-logic.h.

Referenced by Dequeue(), Enqueue(), and GetTypeId().

◆ m_nPackets

TracedValue<uint32_t> ns3::QKDKMSQueueLogic::m_nPackets
private

The number of packets in the queue.

Definition at line 109 of file qkd-kms-queue-logic.h.

Referenced by Dequeue(), Enqueue(), and GetTypeId().

◆ m_numberOfQueues

uint32_t ns3::QKDKMSQueueLogic::m_numberOfQueues
private

The number of queues.

Definition at line 112 of file qkd-kms-queue-logic.h.

Referenced by QKDKMSQueueLogic(), Dequeue(), Enqueue(), and GetTypeId().

◆ m_queues

std::vector<std::vector<QKDKMSQueueEntry> > ns3::QKDKMSQueueLogic::m_queues
private

A list of queues.

Definition at line 114 of file qkd-kms-queue-logic.h.

Referenced by QKDKMSQueueLogic(), Dequeue(), and Enqueue().

◆ m_traceDequeue

TracedCallback<const HTTPMessage > ns3::QKDKMSQueueLogic::m_traceDequeue
private

A trace for the dequeue packet.

Definition at line 106 of file qkd-kms-queue-logic.h.

Referenced by Dequeue(), and GetTypeId().

◆ m_traceDroped

TracedCallback<const HTTPMessage > ns3::QKDKMSQueueLogic::m_traceDroped
private

A trace for the dropped packet.

Definition at line 107 of file qkd-kms-queue-logic.h.

Referenced by Enqueue(), and GetTypeId().

◆ m_traceEnqueue

TracedCallback<const HTTPMessage > ns3::QKDKMSQueueLogic::m_traceEnqueue
private

A trace for the enqueued packet.

Definition at line 105 of file qkd-kms-queue-logic.h.

Referenced by Enqueue(), and GetTypeId().


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