A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 }
 

Public Member Functions

 ServiceFlowManager ()
 
 ~ServiceFlowManager (void)
 
void AddServiceFlow (ServiceFlow *serviceFlow)
 
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 (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
ServiceFlowGetNextServiceFlowToAllocate ()
 
uint32_t GetNrServiceFlows (void) const
 
ServiceFlowGetServiceFlow (uint32_t sfid) const
 
ServiceFlowGetServiceFlow (Cid cid) const
 
std::vector< ServiceFlow * > GetServiceFlows (enum ServiceFlow::SchedulingType schedulingType) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- 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

std::vector< ServiceFlow * > * m_serviceFlows
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. 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.

Config Paths

ns3::ServiceFlowManager is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager

No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Member Enumeration Documentation

Enumerator
CONFIRMATION_CODE_SUCCESS 
CONFIRMATION_CODE_REJECT 

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

Constructor & Destructor Documentation

ns3::ServiceFlowManager::ServiceFlowManager ( )

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

References m_serviceFlows.

ns3::ServiceFlowManager::~ServiceFlowManager ( void  )

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

Member Function Documentation

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

Definition at line 76 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:

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

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

References m_serviceFlows.

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

+ Here is the caller graph for this function:

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

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

References AreServiceFlowsAllocated().

+ Here is the call graph for this function:

bool ns3::ServiceFlowManager::AreServiceFlowsAllocated ( std::vector< ServiceFlow * >  serviceFlows)
Parameters
serviceFlowsthe list of the 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.

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 81 of file service-flow-manager.cc.

References m_serviceFlows.

void ns3::ServiceFlowManager::DoDispose ( void  )
virtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 65 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:

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

Definition at line 171 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:

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

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

References m_serviceFlows.

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

Definition at line 102 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:

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

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

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

+ Here is the call graph for this function:

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

Definition at line 132 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:

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

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation


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