A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::UplinkSchedulerRtps Class Reference

This class implements a simple uplink scheduler for rtPS flows. More...

#include "bs-uplink-scheduler-rtps.h"

+ Inheritance diagram for ns3::UplinkSchedulerRtps:

Public Member Functions

 UplinkSchedulerRtps ()
 
 UplinkSchedulerRtps (Ptr< BaseStationNetDevice > bs)
 Constructor. More...
 
 ~UplinkSchedulerRtps (void)
 
void AddUplinkAllocation (OfdmUlMapIe &ulMapIe, const uint32_t &allocationSize, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Add Uplink Allocation function. More...
 
void AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Allocate Initial Ranging Interval function. More...
 
uint32_t CalculateAllocationStartTime (void)
 Calculate allocation start time function. More...
 
void GetChannelDescriptorsToUpdate (bool &updateDcd, bool &updateUcd, bool &sendDcd, bool &sendUcd)
 Determines if channel descriptors sent in the current frame are required to be updated. More...
 
std::list< OfdmUlMapIeGetUplinkAllocations (void) const
 Get uplink allocations. More...
 
void InitOnce (void)
 Init once function. More...
 
void OnSetRequestedBandwidth (ServiceFlowRecord *sfr)
 Set requested bandwidth function. More...
 
void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)
 Process bandwidth requet function. More...
 
void Schedule (void)
 Schedule function. More...
 
void ServiceBandwidthRequests (const SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Service Bandwidth Requests function. More...
 
bool ServiceBandwidthRequests (ServiceFlow *serviceFlow, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Service bandwidth requests function. More...
 
void ServiceUnsolicitedGrants (const SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Service Unsolicited Grants function. More...
 
void SetupServiceFlow (SSRecord *ssRecord, ServiceFlow *serviceFlow)
 Setup service flow function. More...
 
void ULSchedulerRTPSConnection (uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Uplink Scheduler for rtPS connections. More...
 
- 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
 Get the most derived TypeId for this Object. 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 ()
 Default 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 operator. 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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::list< OfdmUlMapIem_uplinkAllocations
 uplink allocations More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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

This class implements a simple uplink scheduler for rtPS flows.


The UL-rtPS-Scheduler work in this way: At the beginning of the UL sub-frame some symbols are allocated to the rangingInterval Messages, DSA Messages, UGS grants and UGS/rtPS/nrtPS/BE poll. Then, the remaining available symbols are allocated to the all rtPS flows according to their requestedBandwidth. The bandwidth saturation control has been implemented to redistribute the resource if the sum of requestedBandwidth exceed the available bandwidth. At the end, if there are some free symbols, their are allocated to nrtPS and BE Connections.

Config Paths

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

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 120 bytes (on a 64-bit architecture).

Definition at line 53 of file bs-uplink-scheduler-rtps.h.

Constructor & Destructor Documentation

◆ UplinkSchedulerRtps() [1/2]

ns3::UplinkSchedulerRtps::UplinkSchedulerRtps ( )

◆ UplinkSchedulerRtps() [2/2]

ns3::UplinkSchedulerRtps::UplinkSchedulerRtps ( Ptr< BaseStationNetDevice bs)

◆ ~UplinkSchedulerRtps()

ns3::UplinkSchedulerRtps::~UplinkSchedulerRtps ( void  )

Member Function Documentation

◆ AddUplinkAllocation()

void ns3::UplinkSchedulerRtps::AddUplinkAllocation ( OfdmUlMapIe ulMapIe,
const uint32_t &  allocationSize,
uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)
virtual

Add Uplink Allocation function.

Parameters
ulMapIethe UL map IE
allocationSizethe allocation size
symbolsToAllocationthe symbols to allocation
availableSymbolsthe available symbols

Implements ns3::UplinkScheduler.

Definition at line 151 of file bs-uplink-scheduler-rtps.cc.

References m_uplinkAllocations, ns3::OfdmUlMapIe::SetDuration(), and ns3::OfdmUlMapIe::SetStartTime().

Referenced by AllocateInitialRangingInterval(), Schedule(), ServiceBandwidthRequests(), ServiceUnsolicitedGrants(), and ULSchedulerRTPSConnection().

◆ AllocateInitialRangingInterval()

void ns3::UplinkSchedulerRtps::AllocateInitialRangingInterval ( uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)
virtual

◆ CalculateAllocationStartTime()

uint32_t ns3::UplinkSchedulerRtps::CalculateAllocationStartTime ( void  )
virtual

Calculate allocation start time function.

Returns
the allocation start time value

Implements ns3::UplinkScheduler.

Definition at line 145 of file bs-uplink-scheduler-rtps.cc.

References ns3::UplinkScheduler::GetBs().

Referenced by AllocateInitialRangingInterval().

◆ GetChannelDescriptorsToUpdate()

void ns3::UplinkSchedulerRtps::GetChannelDescriptorsToUpdate ( bool &  updateDcd,
bool &  updateUcd,
bool &  sendDcd,
bool &  sendUcd 
)
virtual

Determines if channel descriptors sent in the current frame are required to be updated.

Parameters
updateDcdif true update DCD
updateUcdif true update UCD
sendDcdif true send DCD
sendUcdif true send UCD

Implements ns3::UplinkScheduler.

Definition at line 89 of file bs-uplink-scheduler-rtps.cc.

References ns3::UplinkScheduler::GetBs(), ns3::UplinkScheduler::GetDcdTimeStamp(), ns3::UplinkScheduler::GetUcdTimeStamp(), ns3::Simulator::Now(), ns3::UplinkScheduler::SetDcdTimeStamp(), and ns3::UplinkScheduler::SetUcdTimeStamp().

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 72 of file bs-uplink-scheduler-rtps.cc.

References ns3::TypeId::SetParent().

◆ GetUplinkAllocations()

std::list< OfdmUlMapIe > ns3::UplinkSchedulerRtps::GetUplinkAllocations ( void  ) const
virtual

Get uplink allocations.

Returns
std::list<OfdmUlMapIe>

Reimplemented from ns3::UplinkScheduler.

Definition at line 83 of file bs-uplink-scheduler-rtps.cc.

References m_uplinkAllocations.

◆ InitOnce()

void ns3::UplinkSchedulerRtps::InitOnce ( void  )
virtual

Init once function.

Implements ns3::UplinkScheduler.

Definition at line 704 of file bs-uplink-scheduler-rtps.cc.

◆ OnSetRequestedBandwidth()

void ns3::UplinkSchedulerRtps::OnSetRequestedBandwidth ( ServiceFlowRecord sfr)
virtual

Set requested bandwidth function.

Parameters
sfrthe service flow record

Implements ns3::UplinkScheduler.

Definition at line 714 of file bs-uplink-scheduler-rtps.cc.

References ns3::ServiceFlowRecord::SetGrantedBandwidth().

◆ ProcessBandwidthRequest()

void ns3::UplinkSchedulerRtps::ProcessBandwidthRequest ( const BandwidthRequestHeader bwRequestHdr)
virtual

Process bandwidth requet function.

Parameters
bwRequestHdrthe bandwidth request header

Implements ns3::UplinkScheduler.

Definition at line 709 of file bs-uplink-scheduler-rtps.cc.

◆ Schedule()

void ns3::UplinkSchedulerRtps::Schedule ( void  )
virtual

◆ ServiceBandwidthRequests() [1/2]

void ns3::UplinkSchedulerRtps::ServiceBandwidthRequests ( const SSRecord ssRecord,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)
virtual

Service Bandwidth Requests function.

Parameters
ssRecordSubscriber station record
schedulingTypethe scheduling type
ulMapIethe UL map IE
modulationTypethe modulation type
symbolsToAllocationthe symbols to allocation
availableSymbolsthe available symbols

Implements ns3::UplinkScheduler.

Definition at line 430 of file bs-uplink-scheduler-rtps.cc.

References ns3::SSRecord::GetServiceFlows().

Referenced by Schedule(), and ServiceUnsolicitedGrants().

◆ ServiceBandwidthRequests() [2/2]

bool ns3::UplinkSchedulerRtps::ServiceBandwidthRequests ( ServiceFlow serviceFlow,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)
virtual

Service bandwidth requests function.

Parameters
serviceFlowthe service flow
schedulingTypethe scheduling type
ulMapIethe UL map IE
modulationTypethe modulation type
symbolsToAllocationthe symbols to allocation
availableSymbolsthe available symbols
Returns
true if successful

Implements ns3::UplinkScheduler.

Definition at line 454 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlow::GetConnection(), ns3::ServiceFlowRecord::GetGrantedBandwidth(), ns3::ServiceFlow::GetRecord(), ns3::ServiceFlowRecord::GetRequestedBandwidth(), ns3::ServiceFlow::GetSchedulingTypeStr(), ns3::ServiceFlow::GetSduSize(), ns3::ServiceFlow::GetSfid(), NS_LOG_DEBUG, ns3::ServiceFlowRecord::SetBwSinceLastExpiry(), ns3::ServiceFlow::SF_TYPE_NRTPS, and ns3::ServiceFlowRecord::UpdateGrantedBandwidth().

◆ ServiceUnsolicitedGrants()

void ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants ( const SSRecord ssRecord,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)
virtual

◆ SetupServiceFlow()

void ns3::UplinkSchedulerRtps::SetupServiceFlow ( SSRecord ssRecord,
ServiceFlow serviceFlow 
)
virtual

◆ ULSchedulerRTPSConnection()

void ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection ( uint32_t &  symbolsToAllocation,
uint32_t &  availableSymbols 
)

Uplink Scheduler for rtPS connections.

Parameters
symbolsToAllocationsymbols to allocation for UpLink Subframe
availableSymbolsavailable symbols for rtPS flows

This method represent the UL Scheduler for rtPS connections. The scheduler is designed to serve all rtPS connections that have at least one packet to transmit, every UL Subframe. The method selects all rtPS connection that have al least one packet to transmit. To each rtPS connections are allocated, at the beginning, the bandwidth to transmit a quota of data equal to (RequestedBandwidth - GrantedBandwidth). If the sum of all pre-allocated bandwidth exceed the available symbols for rtPS connections, the Channel Saturation Control function is called to redistribute the available bandwidth.

Definition at line 509 of file bs-uplink-scheduler-rtps.cc.

References AddUplinkAllocation(), ns3::WimaxNetDevice::DIRECTION_UPLINK, ns3::SSRecord::GetAreServiceFlowsAllocated(), ns3::SSRecord::GetBasicCid(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlowRecord::GetGrantedBandwidth(), ns3::SSRecord::GetIsBroadcastSS(), ns3::SSRecord::GetModulationType(), ns3::SSRecord::GetPollForRanging(), ns3::SSRecord::GetRangingStatus(), ns3::ServiceFlowRecord::GetRequestedBandwidth(), ns3::SSRecord::GetServiceFlows(), NS_LOG_INFO, ns3::WimaxNetDevice::RANGING_STATUS_CONTINUE, ns3::OfdmUlMapIe::SetCid(), ns3::ServiceFlowRecord::SetGrantedBandwidth(), ns3::ServiceFlowRecord::SetRequestedBandwidth(), ns3::OfdmUlMapIe::SetUiuc(), ns3::ServiceFlow::SF_TYPE_RTPS, and ns3::ServiceFlowRecord::UpdateGrantedBandwidth().

Referenced by Schedule().

Member Data Documentation

◆ m_uplinkAllocations

std::list<OfdmUlMapIe> ns3::UplinkSchedulerRtps::m_uplinkAllocations
private

uplink allocations

Definition at line 200 of file bs-uplink-scheduler-rtps.h.

Referenced by AddUplinkAllocation(), GetUplinkAllocations(), Schedule(), and ~UplinkSchedulerRtps().


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