A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::ConnectionManager Class Reference

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

#include <connection-manager.h>

+ Inheritance diagram for ns3::ConnectionManager:
+ Collaboration diagram for ns3::ConnectionManager:

Public Member Functions

 ConnectionManager (void)
 
 ~ConnectionManager (void)
 
void AddConnection (Ptr< WimaxConnection > connection, Cid::Type type)
 add a connection to the list of managed connections More...
 
void AllocateManagementConnections (SSRecord *ssRecord, RngRsp *rngrsp)
 allocates the management connection for an ss record. More...
 
Ptr< WimaxConnectionCreateConnection (Cid::Type type)
 create a connection of type type More...
 
void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
Ptr< WimaxConnectionGetConnection (Cid cid)
 
std::vector< Ptr
< WimaxConnection > > 
GetConnections (Cid::Type type) const
 
uint32_t GetNPackets (Cid::Type type, ServiceFlow::SchedulingType schedulingType) const
 
bool HasPackets (void) const
 
void SetCidFactory (CidFactory *cidFactory)
 
- 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< Ptr
< WimaxConnection > > 
m_basicConnections
 
CidFactorym_cidFactory
 
std::vector< Ptr
< WimaxConnection > > 
m_multicastConnections
 
std::vector< Ptr
< WimaxConnection > > 
m_primaryConnections
 
std::vector< Ptr
< WimaxConnection > > 
m_transportConnections
 

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 connection manager class serves both for BS and SS though some functions are exclusive to only one of them.

Config Paths

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

  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager

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

Definition at line 44 of file connection-manager.h.

Constructor & Destructor Documentation

ns3::ConnectionManager::ConnectionManager ( void  )

Definition at line 47 of file connection-manager.cc.

ns3::ConnectionManager::~ConnectionManager ( void  )

Definition at line 57 of file connection-manager.cc.

Member Function Documentation

void ns3::ConnectionManager::AddConnection ( Ptr< WimaxConnection connection,
Cid::Type  type 
)

add a connection to the list of managed connections

Parameters
connectionthe connection to add
typethe type of connection to add

Definition at line 104 of file connection-manager.cc.

References ns3::Cid::BASIC, m_basicConnections, m_multicastConnections, m_primaryConnections, m_transportConnections, ns3::Cid::MULTICAST, NS_FATAL_ERROR, ns3::Cid::PRIMARY, and ns3::Cid::TRANSPORT.

Referenced by CreateConnection().

+ Here is the caller graph for this function:

void ns3::ConnectionManager::AllocateManagementConnections ( SSRecord ssRecord,
RngRsp rngrsp 
)

allocates the management connection for an ss record.

This method is only used by BS

Parameters
ssRecordthe ss record to wich the management connection will be allocated
rngrspthe ranging response message

Definition at line 68 of file connection-manager.cc.

References ns3::Cid::BASIC, CreateConnection(), ns3::Cid::PRIMARY, ns3::SSRecord::SetBasicCid(), ns3::RngRsp::SetBasicCid(), ns3::SSRecord::SetPrimaryCid(), and ns3::RngRsp::SetPrimaryCid().

+ Here is the call graph for this function:

Ptr< WimaxConnection > ns3::ConnectionManager::CreateConnection ( Cid::Type  type)

create a connection of type type

Parameters
typetype of the connection to create

Definition at line 81 of file connection-manager.cc.

References AddConnection(), ns3::CidFactory::Allocate(), ns3::CidFactory::AllocateTransportOrSecondary(), ns3::Cid::BASIC, m_cidFactory, ns3::Cid::MULTICAST, NS_FATAL_ERROR, ns3::Cid::PRIMARY, and ns3::Cid::TRANSPORT.

Referenced by AllocateManagementConnections().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ConnectionManager::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.

Definition at line 53 of file connection-manager.cc.

Ptr< WimaxConnection > ns3::ConnectionManager::GetConnection ( Cid  cid)
Returns
the connection which has as identifier cid

Definition at line 127 of file connection-manager.cc.

References m_basicConnections, m_primaryConnections, and m_transportConnections.

std::vector< Ptr< WimaxConnection > > ns3::ConnectionManager::GetConnections ( Cid::Type  type) const
Returns
a listy of all connection which have as type type

Definition at line 159 of file connection-manager.cc.

References ns3::Cid::BASIC, m_basicConnections, m_primaryConnections, m_transportConnections, NS_FATAL_ERROR, ns3::Cid::PRIMARY, and ns3::Cid::TRANSPORT.

uint32_t ns3::ConnectionManager::GetNPackets ( Cid::Type  type,
ServiceFlow::SchedulingType  schedulingType 
) const
TypeId ns3::ConnectionManager::GetTypeId ( void  )
static

Definition at line 40 of file connection-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

bool ns3::ConnectionManager::HasPackets ( void  ) const
Returns
true if one of the managed connection has at least one packet to send, false otherwise

Definition at line 228 of file connection-manager.cc.

References m_basicConnections, m_primaryConnections, and m_transportConnections.

void ns3::ConnectionManager::SetCidFactory ( CidFactory cidFactory)

Definition at line 62 of file connection-manager.cc.

References m_cidFactory.

Member Data Documentation

std::vector<Ptr<WimaxConnection> > ns3::ConnectionManager::m_basicConnections
private
CidFactory* ns3::ConnectionManager::m_cidFactory
private

Definition at line 88 of file connection-manager.h.

Referenced by CreateConnection(), and SetCidFactory().

std::vector<Ptr<WimaxConnection> > ns3::ConnectionManager::m_multicastConnections
private

Definition at line 86 of file connection-manager.h.

Referenced by AddConnection().

std::vector<Ptr<WimaxConnection> > ns3::ConnectionManager::m_primaryConnections
private
std::vector<Ptr<WimaxConnection> > ns3::ConnectionManager::m_transportConnections
private

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