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

A flow queue used by the FqCoDel queue disc. More...

#include "fq-codel-queue-disc.h"

+ Inheritance diagram for ns3::FqCoDelFlow:
+ Collaboration diagram for ns3::FqCoDelFlow:

Public Types

enum  FlowStatus { INACTIVE, NEW_FLOW, OLD_FLOW }
 Used to determine the status of this flow queue. More...
 

Public Member Functions

 FqCoDelFlow ()
 FqCoDelFlow constructor. More...
 
virtual ~FqCoDelFlow ()
 
int32_t GetDeficit (void) const
 Get the deficit for this flow. More...
 
FlowStatus GetStatus (void) const
 Get the status of this flow. More...
 
void IncreaseDeficit (int32_t deficit)
 Increase the deficit for this flow. More...
 
void SetDeficit (uint32_t deficit)
 Set the deficit for this flow. More...
 
void SetStatus (FlowStatus status)
 Set the status for this flow. More...
 
- Public Member Functions inherited from ns3::QueueDiscClass
 QueueDiscClass ()
 
virtual ~QueueDiscClass ()
 
Ptr< QueueDiscGetQueueDisc (void) const
 Get the queue disc attached to this class. More...
 
void SetQueueDisc (Ptr< QueueDisc > qd)
 Set the queue disc attached to this class. 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...
 
SimpleRefCountoperator= (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::QueueDiscClass
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 Attributes

int32_t m_deficit
 the deficit for this flow More...
 
FlowStatus m_status
 the status of this flow More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::QueueDiscClass
virtual void DoDispose (void)
 Dispose of the object. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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

A flow queue used by the FqCoDel queue disc.

Introspection did not find any typical Config paths.


No Attributes are defined for this type.

Attributes defined in parent class ns3::QueueDiscClass

No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).

Definition at line 38 of file fq-codel-queue-disc.h.

Constructor & Destructor Documentation

ns3::FqCoDelFlow::FqCoDelFlow ( )

FqCoDelFlow constructor.

Definition at line 42 of file fq-codel-queue-disc.cc.

References NS_LOG_FUNCTION.

ns3::FqCoDelFlow::~FqCoDelFlow ( )
virtual

Definition at line 49 of file fq-codel-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

int32_t ns3::FqCoDelFlow::GetDeficit ( void  ) const

Get the deficit for this flow.

Returns
the deficit for this flow

Definition at line 62 of file fq-codel-queue-disc.cc.

References m_deficit, and NS_LOG_FUNCTION.

FqCoDelFlow::FlowStatus ns3::FqCoDelFlow::GetStatus ( void  ) const

Get the status of this flow.

Returns
the status of this flow

Definition at line 83 of file fq-codel-queue-disc.cc.

References m_status, and NS_LOG_FUNCTION.

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

Get the type ID.

Returns
the object TypeId

Definition at line 32 of file fq-codel-queue-disc.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::FqCoDelFlow::IncreaseDeficit ( int32_t  deficit)

Increase the deficit for this flow.

Parameters
deficitthe amount by which the deficit is to be increased

Definition at line 69 of file fq-codel-queue-disc.cc.

References m_deficit, and NS_LOG_FUNCTION.

void ns3::FqCoDelFlow::SetDeficit ( uint32_t  deficit)

Set the deficit for this flow.

Parameters
deficitthe deficit for this flow

Definition at line 55 of file fq-codel-queue-disc.cc.

References m_deficit, and NS_LOG_FUNCTION.

void ns3::FqCoDelFlow::SetStatus ( FlowStatus  status)

Set the status for this flow.

Parameters
statusthe status for this flow

Definition at line 76 of file fq-codel-queue-disc.cc.

References m_status, and NS_LOG_FUNCTION.

Member Data Documentation

int32_t ns3::FqCoDelFlow::m_deficit
private

the deficit for this flow

Definition at line 90 of file fq-codel-queue-disc.h.

Referenced by GetDeficit(), IncreaseDeficit(), and SetDeficit().

FlowStatus ns3::FqCoDelFlow::m_status
private

the status of this flow

Definition at line 91 of file fq-codel-queue-disc.h.

Referenced by GetStatus(), and SetStatus().


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