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

This class manage the bandwidth request and grant mechanism. More...

#include <bandwidth-manager.h>

+ Inheritance diagram for ns3::BandwidthManager:
+ Collaboration diagram for ns3::BandwidthManager:

Public Member Functions

 BandwidthManager (Ptr< WimaxNetDevice > device)
 
 ~BandwidthManager (void)
 
uint32_t CalculateAllocationSize (const SSRecord *ssRecord, const ServiceFlow *serviceFlow)
 
void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
uint32_t GetSymbolsPerFrameAllocated (void)
 
void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)
 
ServiceFlowSelectFlowForRequest (uint32_t &bytesToRequest)
 
void SendBandwidthRequest (uint8_t uiuc, uint16_t allocationSize)
 
void SetSubframeRatio (void)
 
- 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 Member Functions

 BandwidthManager (const BandwidthManager &)
 
BandwidthManageroperator= (const BandwidthManager &)
 

Private Attributes

Ptr< WimaxNetDevicem_device
 
uint16_t m_nrBwReqsSent
 

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

This class manage the bandwidth request and grant mechanism.

The bandwidth request and grant mechanism is supported by the Bandwidth Manager. Both BS and SS maintain a bandwidth manager. Furthermore BS's bandwidth manager works together with the uplink scheduler to determine total bandwidth available and allocation size for each service flow. Bandwidth request mechanism is a key feature of the WiMAX scheduler since all three non-UGS services explicitly request for bandwidth by sending a bandwidth request to BS.

Config Paths

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

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

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

Definition at line 54 of file bandwidth-manager.h.

Constructor & Destructor Documentation

ns3::BandwidthManager::BandwidthManager ( Ptr< WimaxNetDevice device)

Definition at line 49 of file bandwidth-manager.cc.

ns3::BandwidthManager::~BandwidthManager ( void  )

Definition at line 55 of file bandwidth-manager.cc.

ns3::BandwidthManager::BandwidthManager ( const BandwidthManager )
private

Member Function Documentation

void ns3::BandwidthManager::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 60 of file bandwidth-manager.cc.

References m_device.

uint32_t ns3::BandwidthManager::GetSymbolsPerFrameAllocated ( void  )

Definition at line 217 of file bandwidth-manager.cc.

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

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

Definition at line 42 of file bandwidth-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

BandwidthManager& ns3::BandwidthManager::operator= ( const BandwidthManager )
private
void ns3::BandwidthManager::ProcessBandwidthRequest ( const BandwidthRequestHeader bwRequestHdr)
ServiceFlow * ns3::BandwidthManager::SelectFlowForRequest ( uint32_t &  bytesToRequest)
void ns3::BandwidthManager::SetSubframeRatio ( void  )

Definition at line 203 of file bandwidth-manager.cc.

References m_device.

Member Data Documentation

uint16_t ns3::BandwidthManager::m_nrBwReqsSent
private

Definition at line 73 of file bandwidth-manager.h.

Referenced by SendBandwidthRequest().


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