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

The same service flow manager class serves both for BS and SS though some functions are exclusive to only one of them. More...

#include "service-flow-manager.h"

+ Inheritance diagram for ns3::ServiceFlowManager:
+ Collaboration diagram for ns3::ServiceFlowManager:

Public Types

enum  ConfirmationCode { CONFIRMATION_CODE_SUCCESS , CONFIRMATION_CODE_REJECT }
 confirmation code enumeration as per Table 384 (not all codes implemented) More...
 

Public Member Functions

 ServiceFlowManager ()
 
 ~ServiceFlowManager () override
 
void AddServiceFlow (ServiceFlow *serviceFlow)
 Add service flow function. More...
 
bool AreServiceFlowsAllocated ()
 
bool AreServiceFlowsAllocated (std::vector< ServiceFlow * > *serviceFlows)
 
bool AreServiceFlowsAllocated (std::vector< ServiceFlow * > serviceFlows)
 
ServiceFlowDoClassify (Ipv4Address SrcAddress, Ipv4Address DstAddress, uint16_t SrcPort, uint16_t DstPort, uint8_t Proto, ServiceFlow::Direction dir) const
 
void DoDispose () override
 Destructor implementation. More...
 
ServiceFlowGetNextServiceFlowToAllocate ()
 
uint32_t GetNrServiceFlows () const
 
ServiceFlowGetServiceFlow (Cid cid) const
 Get service flow by CID. More...
 
ServiceFlowGetServiceFlow (uint32_t sfid) const
 Get service flow by flow id. More...
 
std::vector< ServiceFlow * > GetServiceFlows (ServiceFlow::SchedulingType schedulingType) const
 Get service flows function. 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 ()
 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

std::vector< ServiceFlow * > * m_serviceFlows
 the service flows More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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

The same service flow manager class serves both for BS and SS though some functions are exclusive to only one of them.

Definition at line 45 of file service-flow-manager.h.

Member Enumeration Documentation

◆ ConfirmationCode

confirmation code enumeration as per Table 384 (not all codes implemented)

Enumerator
CONFIRMATION_CODE_SUCCESS 
CONFIRMATION_CODE_REJECT 

Definition at line 49 of file service-flow-manager.h.

Constructor & Destructor Documentation

◆ ServiceFlowManager()

ns3::ServiceFlowManager::ServiceFlowManager ( )

Definition at line 59 of file service-flow-manager.cc.

References m_serviceFlows.

◆ ~ServiceFlowManager()

ns3::ServiceFlowManager::~ServiceFlowManager ( )
override

Definition at line 64 of file service-flow-manager.cc.

Member Function Documentation

◆ AddServiceFlow()

void ns3::ServiceFlowManager::AddServiceFlow ( ServiceFlow serviceFlow)

Add service flow function.

Parameters
serviceFlowthe service flow

Definition at line 80 of file service-flow-manager.cc.

References m_serviceFlows.

Referenced by ns3::BsServiceFlowManager::AddServiceFlow(), and ns3::SsServiceFlowManager::AddServiceFlow().

+ Here is the caller graph for this function:

◆ AreServiceFlowsAllocated() [1/3]

bool ns3::ServiceFlowManager::AreServiceFlowsAllocated ( )
Returns
true if all service flows are allocated, false otherwise

Definition at line 152 of file service-flow-manager.cc.

References m_serviceFlows.

Referenced by AreServiceFlowsAllocated(), and ns3::BsServiceFlowManager::ProcessDsaAck().

+ Here is the caller graph for this function:

◆ AreServiceFlowsAllocated() [2/3]

bool ns3::ServiceFlowManager::AreServiceFlowsAllocated ( std::vector< ServiceFlow * > *  serviceFlows)
Parameters
serviceFlowsvector of pointers to service flows to be checked
Returns
true if all service flows are allocated, false otherwise

Definition at line 158 of file service-flow-manager.cc.

References AreServiceFlowsAllocated().

+ Here is the call graph for this function:

◆ AreServiceFlowsAllocated() [3/3]

bool ns3::ServiceFlowManager::AreServiceFlowsAllocated ( std::vector< ServiceFlow * >  serviceFlows)
Parameters
serviceFlowsvector of pointers to service flows to be checked
Returns
true if all service flows are allocated, false otherwise

Definition at line 164 of file service-flow-manager.cc.

◆ DoClassify()

ServiceFlow * ns3::ServiceFlowManager::DoClassify ( Ipv4Address  SrcAddress,
Ipv4Address  DstAddress,
uint16_t  SrcPort,
uint16_t  DstPort,
uint8_t  Proto,
ServiceFlow::Direction  dir 
) const
Parameters
SrcAddressthe source ip address
DstAddressthe destination ip address
SrcPortthe source port
DstPortthe destination port
Protothe protocol
dirthe direction of the service flow
Returns
the service flow to which this ip flow is associated

Definition at line 86 of file service-flow-manager.cc.

References dir, and m_serviceFlows.

◆ DoDispose()

void ns3::ServiceFlowManager::DoDispose ( void  )
overridevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Reimplemented in ns3::SsServiceFlowManager.

Definition at line 69 of file service-flow-manager.cc.

References m_serviceFlows.

Referenced by ns3::BsServiceFlowManager::DoDispose(), and ns3::SsServiceFlowManager::DoDispose().

+ Here is the caller graph for this function:

◆ GetNextServiceFlowToAllocate()

ServiceFlow * ns3::ServiceFlowManager::GetNextServiceFlowToAllocate ( )
Returns
pointer to the next service flow to be allocated

Definition at line 177 of file service-flow-manager.cc.

References m_serviceFlows.

Referenced by ns3::SsServiceFlowManager::InitiateServiceFlows(), and ns3::SsServiceFlowManager::ProcessDsaRsp().

+ Here is the caller graph for this function:

◆ GetNrServiceFlows()

uint32_t ns3::ServiceFlowManager::GetNrServiceFlows ( ) const
Returns
the number of all service flows

Definition at line 190 of file service-flow-manager.cc.

References m_serviceFlows.

◆ GetServiceFlow() [1/2]

ServiceFlow * ns3::ServiceFlowManager::GetServiceFlow ( Cid  cid) const

Get service flow by CID.

Parameters
cidthe CID
Returns
pointer to the service flow object corresponding to the CID

Definition at line 122 of file service-flow-manager.cc.

References ns3::Cid::GetIdentifier(), m_serviceFlows, and NS_LOG_DEBUG.

+ Here is the call graph for this function:

◆ GetServiceFlow() [2/2]

ServiceFlow * ns3::ServiceFlowManager::GetServiceFlow ( uint32_t  sfid) const

Get service flow by flow id.

Parameters
sfidthe service flow id
Returns
pointer to the service flow object corresponding to the flow id

Definition at line 107 of file service-flow-manager.cc.

References m_serviceFlows, and NS_LOG_DEBUG.

Referenced by ns3::BsServiceFlowManager::GetServiceFlow().

+ Here is the caller graph for this function:

◆ GetServiceFlows()

std::vector< ServiceFlow * > ns3::ServiceFlowManager::GetServiceFlows ( ServiceFlow::SchedulingType  schedulingType) const

Get service flows function.

Parameters
schedulingTypethe scheduling type
Returns
vector of pointers to service flows corresponding to the scheduling type

Definition at line 137 of file service-flow-manager.cc.

References m_serviceFlows, and ns3::ServiceFlow::SF_TYPE_ALL.

Referenced by ns3::BsServiceFlowManager::GetServiceFlows().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 53 of file service-flow-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_serviceFlows

std::vector<ServiceFlow*>* ns3::ServiceFlowManager::m_serviceFlows
private

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