A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::FqCobaltFlow Class Reference

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

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

+ Inheritance diagram for ns3::FqCobaltFlow:
+ Collaboration diagram for ns3::FqCobaltFlow:

Public Types

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

Public Member Functions

 FqCobaltFlow ()
 FqCobaltFlow constructor.
 
 ~FqCobaltFlow () override
 
int32_t GetDeficit () const
 Get the deficit for this flow.
 
uint32_t GetIndex () const
 Get the index of this flow.
 
FlowStatus GetStatus () const
 Get the status of this flow.
 
void IncreaseDeficit (int32_t deficit)
 Increase the deficit for this flow.
 
void SetDeficit (uint32_t deficit)
 Set the deficit for this flow.
 
void SetIndex (uint32_t index)
 Set the index for this flow.
 
void SetStatus (FlowStatus status)
 Set the status for this flow.
 
- Public Member Functions inherited from ns3::QueueDiscClass
 QueueDiscClass ()
 
 ~QueueDiscClass () override
 
Ptr< QueueDiscGetQueueDisc () const
 Get the queue disc attached to this class.
 
void SetQueueDisc (Ptr< QueueDisc > qd)
 Set the queue disc attached to this class.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::QueueDiscClass
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

int32_t m_deficit
 the deficit for this flow
 
uint32_t m_index
 the index for this flow
 
FlowStatus m_status
 the status of this flow
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::QueueDiscClass
void DoDispose () override
 Dispose of the object.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

A flow queue used by the FqCobalt 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.
Group: TrafficControl

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

Definition at line 35 of file fq-cobalt-queue-disc.h.

Member Enumeration Documentation

◆ FlowStatus

Used to determine the status of this flow queue.

Enumerator
INACTIVE 
NEW_FLOW 
OLD_FLOW 

Definition at line 54 of file fq-cobalt-queue-disc.h.

Constructor & Destructor Documentation

◆ FqCobaltFlow()

ns3::FqCobaltFlow::FqCobaltFlow ( )

FqCobaltFlow constructor.

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

References NS_LOG_FUNCTION.

◆ ~FqCobaltFlow()

ns3::FqCobaltFlow::~FqCobaltFlow ( )
override

Definition at line 50 of file fq-cobalt-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetDeficit()

int32_t ns3::FqCobaltFlow::GetDeficit ( ) const

Get the deficit for this flow.

Returns
the deficit for this flow

Definition at line 63 of file fq-cobalt-queue-disc.cc.

References m_deficit, and NS_LOG_FUNCTION.

◆ GetIndex()

uint32_t ns3::FqCobaltFlow::GetIndex ( ) const

Get the index of this flow.

Returns
the index of this flow

Definition at line 98 of file fq-cobalt-queue-disc.cc.

References m_index.

◆ GetStatus()

FqCobaltFlow::FlowStatus ns3::FqCobaltFlow::GetStatus ( ) const

Get the status of this flow.

Returns
the status of this flow

Definition at line 84 of file fq-cobalt-queue-disc.cc.

References m_status, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::FqCobaltFlow::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 33 of file fq-cobalt-queue-disc.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IncreaseDeficit()

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

Increase the deficit for this flow.

Parameters
deficitthe amount by which the deficit is to be increased

Definition at line 70 of file fq-cobalt-queue-disc.cc.

References m_deficit, and NS_LOG_FUNCTION.

◆ SetDeficit()

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

Set the deficit for this flow.

Parameters
deficitthe deficit for this flow

Definition at line 56 of file fq-cobalt-queue-disc.cc.

References m_deficit, and NS_LOG_FUNCTION.

◆ SetIndex()

void ns3::FqCobaltFlow::SetIndex ( uint32_t index)

Set the index for this flow.

Parameters
indexthe index for this flow

Definition at line 91 of file fq-cobalt-queue-disc.cc.

References m_index, and NS_LOG_FUNCTION.

◆ SetStatus()

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

Set the status for this flow.

Parameters
statusthe status for this flow

Definition at line 77 of file fq-cobalt-queue-disc.cc.

References m_status, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_deficit

int32_t ns3::FqCobaltFlow::m_deficit
private

the deficit for this flow

Definition at line 98 of file fq-cobalt-queue-disc.h.

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

◆ m_index

uint32_t ns3::FqCobaltFlow::m_index
private

the index for this flow

Definition at line 100 of file fq-cobalt-queue-disc.h.

Referenced by GetIndex(), and SetIndex().

◆ m_status

FlowStatus ns3::FqCobaltFlow::m_status
private

the status of this flow

Definition at line 99 of file fq-cobalt-queue-disc.h.

Referenced by GetStatus(), and SetStatus().


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