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

#include "ss-service-flow-manager.h"

+ Inheritance diagram for ns3::SsServiceFlowManager:
+ Collaboration diagram for ns3::SsServiceFlowManager:

Public Types

enum  ConfirmationCode { CONFIRMATION_CODE_SUCCESS, CONFIRMATION_CODE_REJECT }
 
- Public Types inherited from ns3::ServiceFlowManager
enum  ConfirmationCode { CONFIRMATION_CODE_SUCCESS, CONFIRMATION_CODE_REJECT }
 

Public Member Functions

 SsServiceFlowManager (Ptr< SubscriberStationNetDevice > device)
 creates a service flow manager and attaches it to a device More...
 
 ~SsServiceFlowManager (void)
 
void AddServiceFlow (ServiceFlow *serviceFlow)
 add a service flow to the list More...
 
void AddServiceFlow (ServiceFlow serviceFlow)
 add a service flow to the list More...
 
Ptr< PacketCreateDsaAck (void)
 
DsaReq CreateDsaReq (const ServiceFlow *serviceFlow)
 
void DoDispose (void)
 Destructor implementation. More...
 
EventId GetDsaAckTimeoutEvent (void) const
 
EventId GetDsaRspTimeoutEvent (void) const
 
uint8_t GetMaxDsaReqRetries (void) const
 
void InitiateServiceFlows (void)
 
void ProcessDsaRsp (const DsaRsp &dsaRsp)
 
void ScheduleDsaReq (const ServiceFlow *serviceFlow)
 
void SetMaxDsaReqRetries (uint8_t maxDsaReqRetries)
 sets the maximum retries on DSA request message More...
 
- Public Member Functions inherited from ns3::ServiceFlowManager
 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
 
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 ()
 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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ServiceFlowManager
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

uint16_t m_currentTransactionId
 
Ptr< SubscriberStationNetDevicem_device
 
DsaAck m_dsaAck
 
EventId m_dsaAckTimeoutEvent
 
DsaReq m_dsaReq
 
uint8_t m_dsaReqRetries
 
EventId m_dsaRspTimeoutEvent
 
uint8_t m_maxDsaReqRetries
 
ServiceFlowm_pendingServiceFlow
 
uint16_t m_transactionIdIndex
 

Additional Inherited Members

- 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

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

Constructor & Destructor Documentation

ns3::SsServiceFlowManager::SsServiceFlowManager ( Ptr< SubscriberStationNetDevice device)

creates a service flow manager and attaches it to a device

Parameters
devicethe device to which the service flow manager will be attached

Definition at line 46 of file ss-service-flow-manager.cc.

ns3::SsServiceFlowManager::~SsServiceFlowManager ( void  )

Definition at line 58 of file ss-service-flow-manager.cc.

Member Function Documentation

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

add a service flow to the list

Parameters
serviceFlowthe service flow to add

Definition at line 113 of file ss-service-flow-manager.cc.

References ns3::ServiceFlowManager::AddServiceFlow().

+ Here is the call graph for this function:

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

add a service flow to the list

Parameters
serviceFlowthe service flow to add

Definition at line 105 of file ss-service-flow-manager.cc.

References ns3::ServiceFlowManager::AddServiceFlow(), and ns3::ServiceFlow::CopyParametersFrom().

+ Here is the call graph for this function:

Ptr< Packet > ns3::SsServiceFlowManager::CreateDsaAck ( void  )
DsaReq ns3::SsServiceFlowManager::CreateDsaReq ( const ServiceFlow serviceFlow)

Definition at line 129 of file ss-service-flow-manager.cc.

References m_currentTransactionId, m_transactionIdIndex, ns3::DsaReq::SetServiceFlow(), and ns3::DsaReq::SetTransactionId().

Referenced by ScheduleDsaReq().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::SsServiceFlowManager::DoDispose ( void  )
virtual

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 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::ServiceFlowManager.

Definition at line 75 of file ss-service-flow-manager.cc.

References ns3::ServiceFlowManager::DoDispose().

+ Here is the call graph for this function:

EventId ns3::SsServiceFlowManager::GetDsaAckTimeoutEvent ( void  ) const

Definition at line 99 of file ss-service-flow-manager.cc.

References m_dsaAckTimeoutEvent.

EventId ns3::SsServiceFlowManager::GetDsaRspTimeoutEvent ( void  ) const

Definition at line 93 of file ss-service-flow-manager.cc.

References m_dsaRspTimeoutEvent.

uint8_t ns3::SsServiceFlowManager::GetMaxDsaReqRetries ( void  ) const
Returns
the maximum retries on DSA request message

Definition at line 87 of file ss-service-flow-manager.cc.

References m_maxDsaReqRetries.

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::SsServiceFlowManager::InitiateServiceFlows ( void  )

Definition at line 120 of file ss-service-flow-manager.cc.

References ns3::ServiceFlowManager::GetNextServiceFlowToAllocate(), m_pendingServiceFlow, NS_ASSERT_MSG, and ScheduleDsaReq().

+ Here is the call graph for this function:

void ns3::SsServiceFlowManager::ScheduleDsaReq ( const ServiceFlow serviceFlow)
void ns3::SsServiceFlowManager::SetMaxDsaReqRetries ( uint8_t  maxDsaReqRetries)

sets the maximum retries on DSA request message

Parameters
maxDsaReqRetriesthe maximum retries on DSA request message

Definition at line 81 of file ss-service-flow-manager.cc.

References m_maxDsaReqRetries.

Member Data Documentation

uint16_t ns3::SsServiceFlowManager::m_currentTransactionId
private

Definition at line 108 of file ss-service-flow-manager.h.

Referenced by CreateDsaReq(), and ProcessDsaRsp().

Ptr<SubscriberStationNetDevice> ns3::SsServiceFlowManager::m_device
private

Definition at line 98 of file ss-service-flow-manager.h.

Referenced by ProcessDsaRsp(), and ScheduleDsaReq().

DsaAck ns3::SsServiceFlowManager::m_dsaAck
private

Definition at line 106 of file ss-service-flow-manager.h.

Referenced by CreateDsaAck().

EventId ns3::SsServiceFlowManager::m_dsaAckTimeoutEvent
private

Definition at line 103 of file ss-service-flow-manager.h.

Referenced by GetDsaAckTimeoutEvent().

DsaReq ns3::SsServiceFlowManager::m_dsaReq
private

Definition at line 105 of file ss-service-flow-manager.h.

Referenced by CreateDsaAck(), and ScheduleDsaReq().

uint8_t ns3::SsServiceFlowManager::m_dsaReqRetries
private

Definition at line 110 of file ss-service-flow-manager.h.

Referenced by ProcessDsaRsp(), and ScheduleDsaReq().

EventId ns3::SsServiceFlowManager::m_dsaRspTimeoutEvent
private

Definition at line 102 of file ss-service-flow-manager.h.

Referenced by GetDsaRspTimeoutEvent(), and ScheduleDsaReq().

uint8_t ns3::SsServiceFlowManager::m_maxDsaReqRetries
private
ServiceFlow* ns3::SsServiceFlowManager::m_pendingServiceFlow
private

Definition at line 113 of file ss-service-flow-manager.h.

Referenced by InitiateServiceFlows(), and ProcessDsaRsp().

uint16_t ns3::SsServiceFlowManager::m_transactionIdIndex
private

Definition at line 109 of file ss-service-flow-manager.h.

Referenced by CreateDsaReq().


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