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 (const BandwidthManager &)=delete

	BandwidthManager (Ptr< WimaxNetDevice > device)
	Constructor.

	~BandwidthManager () override

uint32_t	CalculateAllocationSize (const SSRecord ssRecord, const ServiceFlow serviceFlow)
	Calculate allocation size function.

void	DoDispose () override
	Destructor implementation.

uint32_t	GetSymbolsPerFrameAllocated ()
	Get symbols per frame allocated.

BandwidthManager &	operator= (const BandwidthManager &)=delete

void	ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)
	Process bandwidth request.

ServiceFlow *	SelectFlowForRequest (uint32_t &bytesToRequest)
	Select flow for request function.

void	SendBandwidthRequest (uint8_t uiuc, uint16_t allocationSize)
	Send bandwidth request.

void	SetSubframeRatio ()
	Set subframe ratio.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
Ptr< WimaxNetDevice >	m_device
	the device

uint16_t	m_nrBwReqsSent
	bandwidth requests sent

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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.
Size of this type is 72 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ BandwidthManager() [1/2]

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

Constructor.

Parameters

device WIMAX device

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

◆ ~BandwidthManager()

ns3::BandwidthManager::~BandwidthManager ( )

override

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

◆ BandwidthManager() [2/2]

ns3::BandwidthManager::BandwidthManager ( const BandwidthManager & )

delete

Member Function Documentation

◆ CalculateAllocationSize()

uint32_t ns3::BandwidthManager::CalculateAllocationSize	(	const SSRecord *	ssRecord,
		const ServiceFlow *	serviceFlow
	)

Calculate allocation size function.

Parameters

ssRecord	the SS record
serviceFlow	the service flow

Returns: the allocation size

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

References ns3::ServiceFlowRecord::GetGrantSize(), ns3::ServiceFlowRecord::GetGrantTimeStamp(), ns3::SSRecord::GetHasServiceFlowUgs(), ns3::SSRecord::GetPollMeBit(), ns3::ServiceFlow::GetRecord(), ns3::ServiceFlow::GetSchedulingType(), ns3::ServiceFlow::GetUnsolicitedGrantInterval(), ns3::ServiceFlow::GetUnsolicitedPollingInterval(), m_device, ns3::Simulator::Now(), NS_FATAL_ERROR, ns3::ServiceFlowRecord::SetGrantTimeStamp(), ns3::ServiceFlow::SF_TYPE_BE, ns3::ServiceFlow::SF_TYPE_NRTPS, ns3::ServiceFlow::SF_TYPE_RTPS, and ns3::ServiceFlow::SF_TYPE_UGS.

Here is the call graph for this function:

◆ DoDispose()

void ns3::BandwidthManager::DoDispose ( )

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.

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

References m_device.

◆ GetSymbolsPerFrameAllocated()

uint32_t ns3::BandwidthManager::GetSymbolsPerFrameAllocated ( )

Get symbols per frame allocated.

Returns: the symbols per the frame allocated

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

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

◆ GetTypeId()

TypeId ns3::BandwidthManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

BandwidthManager & ns3::BandwidthManager::operator= ( const BandwidthManager & )

delete

◆ ProcessBandwidthRequest()

void ns3::BandwidthManager::ProcessBandwidthRequest ( const BandwidthRequestHeader & bwRequestHdr )

Process bandwidth request.

Parameters

bwRequestHdr the bandwidth request

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

References ns3::BandwidthRequestHeader::GetBr(), ns3::BandwidthRequestHeader::GetCid(), ns3::BandwidthRequestHeader::GetType(), ns3::BandwidthRequestHeader::HEADER_TYPE_INCREMENTAL, and m_device.

Here is the call graph for this function:

◆ SelectFlowForRequest()

ServiceFlow * ns3::BandwidthManager::SelectFlowForRequest ( uint32_t & bytesToRequest )

Select flow for request function.

Parameters

bytesToRequest bytes to request

Returns: a service flow

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

References ns3::ServiceFlow::GetQueue(), ns3::ServiceFlow::GetSchedulingType(), ns3::ServiceFlow::HasPackets(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, m_device, ns3::ServiceFlow::SF_TYPE_ALL, ns3::ServiceFlow::SF_TYPE_BE, ns3::ServiceFlow::SF_TYPE_NRTPS, and ns3::ServiceFlow::SF_TYPE_RTPS.

Referenced by SendBandwidthRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendBandwidthRequest()

void ns3::BandwidthManager::SendBandwidthRequest	(	uint8_t	uiuc,
		uint16_t	allocationSize
	)

Send bandwidth request.

Parameters

uiuc	the UIUC
allocationSize	the allocation size

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

References ns3::ServiceFlow::GetConnection(), ns3::BandwidthRequestHeader::HEADER_TYPE_AGGREGATE, ns3::MacHeaderType::HEADER_TYPE_BANDWIDTH, m_device, m_nrBwReqsSent, NS_ASSERT_MSG, SelectFlowForRequest(), ns3::BandwidthRequestHeader::SetBr(), ns3::BandwidthRequestHeader::SetCid(), ns3::BandwidthRequestHeader::SetType(), and ns3::OfdmUlBurstProfile::UIUC_REQ_REGION_FULL.

Referenced by ns3::SubscriberStationNetDevice::ProcessUlMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSubframeRatio()

void ns3::BandwidthManager::SetSubframeRatio ( )

Set subframe ratio.

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

References m_device.

Member Data Documentation

◆ m_device

Ptr<WimaxNetDevice> ns3::BandwidthManager::m_device

private

the device

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

Referenced by CalculateAllocationSize(), DoDispose(), GetSymbolsPerFrameAllocated(), ProcessBandwidthRequest(), SelectFlowForRequest(), SendBandwidthRequest(), and SetSubframeRatio().

◆ m_nrBwReqsSent

uint16_t ns3::BandwidthManager::m_nrBwReqsSent

private

bandwidth requests sent

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

Referenced by SendBandwidthRequest().

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

src/wimax/model/bandwidth-manager.h
src/wimax/model/bandwidth-manager.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Constructor & Destructor Documentation

◆ BandwidthManager() [1/2]

◆ ~BandwidthManager()

◆ BandwidthManager() [2/2]

Member Function Documentation

◆ CalculateAllocationSize()

◆ DoDispose()

◆ GetSymbolsPerFrameAllocated()

◆ GetTypeId()

◆ operator=()

◆ ProcessBandwidthRequest()

◆ SelectFlowForRequest()

◆ SendBandwidthRequest()

◆ SetSubframeRatio()

Member Data Documentation

◆ m_device

◆ m_nrBwReqsSent