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

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

#include "bs-scheduler-rtps.h"

+ Inheritance diagram for ns3::BSSchedulerRtps:
+ Collaboration diagram for ns3::BSSchedulerRtps:

Public Member Functions

 BSSchedulerRtps ()
 
 BSSchedulerRtps (Ptr< BaseStationNetDevice > bs)
 Constructor. More...
 
 ~BSSchedulerRtps () override
 
void AddDownlinkBurst (Ptr< const WimaxConnection > connection, uint8_t diuc, WimaxPhy::ModulationType modulationType, Ptr< PacketBurst > burst) override
 This function adds a downlink burst to the list of downlink bursts scheduled for the next downlink sub-frame. More...
 
void BSSchedulerBasicConnection (uint32_t &availableSymbols)
 schedules the basic connections More...
 
void BSSchedulerBEConnection (uint32_t &availableSymbols)
 schedules the BE connection More...
 
void BSSchedulerBroadcastConnection (uint32_t &availableSymbols)
 schedules the broadcast connections More...
 
void BSSchedulerInitialRangingConnection (uint32_t &availableSymbols)
 schedules the IR connections More...
 
void BSSchedulerNRTPSConnection (uint32_t &availableSymbols)
 schedules the NRTPS connections More...
 
void BSSchedulerPrimaryConnection (uint32_t &availableSymbols)
 schedules the primary connection More...
 
void BSSchedulerRTPSConnection (uint32_t &availableSymbols)
 Downlink Scheduler for rtPS connections. More...
 
void BSSchedulerUGSConnection (uint32_t &availableSymbols)
 schedules the UGS connection More...
 
Ptr< PacketBurstCreateUgsBurst (ServiceFlow *serviceFlow, WimaxPhy::ModulationType modulationType, uint32_t availableSymbols) override
 Creates a downlink UGS burst. More...
 
std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * GetDownlinkBursts () const override
 This function returns all the downlink bursts scheduled for the next downlink sub-frame. More...
 
void Schedule () override
 Schedule function. More...
 
bool SelectBEConnection (Ptr< WimaxConnection > &connection)
 Check for BE connections that have packets to transmit. More...
 
bool SelectConnection (Ptr< WimaxConnection > &connection) override
 Selects a connection from the list of connections having packets to be sent . More...
 
bool SelectIRandBCConnection (Ptr< WimaxConnection > &connection)
 Check for IR and Broadcast connections that have packets to transmit. More...
 
bool SelectMenagementConnection (Ptr< WimaxConnection > &connection)
 Check for Basic and Primary connections that have packets to transmit. More...
 
bool SelectNRTPSConnection (Ptr< WimaxConnection > &connection)
 Check for nrtPS connections that have packets to transmit. More...
 
bool SelectRTPSConnection (Ptr< WimaxConnection > &connection)
 Check for rtPS connections that have packets to transmit. More...
 
bool SelectUGSConnection (Ptr< WimaxConnection > &connection)
 Check for UGS connections that have packets to transmit. More...
 
- Public Member Functions inherited from ns3::BSScheduler
 BSScheduler ()
 
 BSScheduler (Ptr< BaseStationNetDevice > bs)
 Constructor. More...
 
 ~BSScheduler () override
 
bool CheckForFragmentation (Ptr< WimaxConnection > connection, int availableSymbols, WimaxPhy::ModulationType modulationType)
 Check if the packet fragmentation is possible for transport connection. More...
 
virtual Ptr< BaseStationNetDeviceGetBs ()
 Get the base station. More...
 
virtual void SetBs (Ptr< BaseStationNetDevice > bs)
 Set the base station. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::BSScheduler
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * m_downlinkBursts
 down link bursts More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

This class implements a simple downlink scheduler for rtPS flows.

The DL-rtPS-Scheduler assigns the available bandwidth the service flows in the following order: IR Connections, Broadcast Connections, Basic and Primary Connections, UGS Connections, rtPS Connections, nrtPS Connections, BE Connections. The IR, Broadcast and Basic/Primary Connections must transmit all packet in the queue. The UGS flows can transmit the quota of date equal to the "Grant Size" (that is one of service flows QoS parameters) according to their requested MaxLatency (another QoS parameter). All rtPS flows are able to transmit all packet in the queue according to the available bandwidth. The bandwidth saturation control has been implemented to redistribute the effective available bandwidth to all rtPS flows that have at least one packet to transmit. The remaining bandwidth is allocated to rntPS and BE Connections.

Definition at line 60 of file bs-scheduler-rtps.h.

Constructor & Destructor Documentation

◆ BSSchedulerRtps() [1/2]

ns3::BSSchedulerRtps::BSSchedulerRtps ( )

Definition at line 57 of file bs-scheduler-rtps.cc.

References ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

◆ BSSchedulerRtps() [2/2]

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

Constructor.

Parameters
bsbase station device

Definition at line 63 of file bs-scheduler-rtps.cc.

References ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

◆ ~BSSchedulerRtps()

ns3::BSSchedulerRtps::~BSSchedulerRtps ( )
override

Definition at line 71 of file bs-scheduler-rtps.cc.

References m_downlinkBursts, and ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

Member Function Documentation

◆ AddDownlinkBurst()

void ns3::BSSchedulerRtps::AddDownlinkBurst ( Ptr< const WimaxConnection connection,
uint8_t  diuc,
WimaxPhy::ModulationType  modulationType,
Ptr< PacketBurst burst 
)
overridevirtual

This function adds a downlink burst to the list of downlink bursts scheduled for the next downlink sub-frame.

Parameters
connectiona pointer to connection in which the burst will be sent
diucdownlink iuc
modulationTypethe modulation type of the burst
burstthe downlink burst to add to the downlink sub frame

Implements ns3::BSScheduler.

Definition at line 94 of file bs-scheduler-rtps.cc.

References m_downlinkBursts, NS_LOG_INFO, and ns3::Cid::TRANSPORT.

Referenced by BSSchedulerBasicConnection(), BSSchedulerBEConnection(), BSSchedulerBroadcastConnection(), BSSchedulerInitialRangingConnection(), BSSchedulerNRTPSConnection(), BSSchedulerPrimaryConnection(), BSSchedulerRTPSConnection(), and BSSchedulerUGSConnection().

+ Here is the caller graph for this function:

◆ BSSchedulerBasicConnection()

void ns3::BSSchedulerRtps::BSSchedulerBasicConnection ( uint32_t &  availableSymbols)

schedules the basic connections

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 312 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::Cid::BASIC, ns3::BSScheduler::CheckForFragmentation(), ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::OfdmDlBurstProfile::DIUC_BURST_PROFILE_1, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::Packet::GetSize(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, and NS_ASSERT_MSG.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerBEConnection()

void ns3::BSSchedulerRtps::BSSchedulerBEConnection ( uint32_t &  availableSymbols)

schedules the BE connection

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 690 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::Packet::GetSize(), ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, ns3::Cid::MULTICAST, NS_ASSERT_MSG, and ns3::ServiceFlow::SF_TYPE_BE.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerBroadcastConnection()

void ns3::BSSchedulerRtps::BSSchedulerBroadcastConnection ( uint32_t &  availableSymbols)

schedules the broadcast connections

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 217 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::BSScheduler::CheckForFragmentation(), ns3::OfdmDlBurstProfile::DIUC_BURST_PROFILE_1, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::Cid::GetIdentifier(), ns3::Packet::GetSize(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, and NS_ASSERT_MSG.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerInitialRangingConnection()

void ns3::BSSchedulerRtps::BSSchedulerInitialRangingConnection ( uint32_t &  availableSymbols)

schedules the IR connections

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 264 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::BSScheduler::CheckForFragmentation(), ns3::OfdmDlBurstProfile::DIUC_BURST_PROFILE_1, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::Packet::GetSize(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, and NS_ASSERT_MSG.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerNRTPSConnection()

void ns3::BSSchedulerRtps::BSSchedulerNRTPSConnection ( uint32_t &  availableSymbols)

schedules the NRTPS connections

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 633 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::Packet::GetSize(), ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, ns3::Cid::MULTICAST, NS_ASSERT_MSG, and ns3::ServiceFlow::SF_TYPE_NRTPS.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerPrimaryConnection()

void ns3::BSSchedulerRtps::BSSchedulerPrimaryConnection ( uint32_t &  availableSymbols)

schedules the primary connection

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 373 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::BSScheduler::CheckForFragmentation(), ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::Packet::GetSize(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, NS_ASSERT_MSG, and ns3::Cid::PRIMARY.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerRTPSConnection()

void ns3::BSSchedulerRtps::BSSchedulerRTPSConnection ( uint32_t &  availableSymbols)

Downlink Scheduler for rtPS connections.

Parameters
availableSymbolsavailable symbols for rtPS flows

This method represent the DL Scheduler for rtPS connections. The scheduler is designed to serve all rtPS connections that have at least one packet to transmit, every DL Subframe. To each rtPS connections are allocated, at the beginning, the bandwidth to transmit a quota of data equal to the queue length. 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 493 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::BSScheduler::CheckForFragmentation(), two-ray-to-three-gpp-ch-calibration::delta, ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::BSScheduler::GetBs(), ns3::GenericMacHeader::GetCid(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, ns3::Cid::MULTICAST, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_INFO, ns3::ServiceFlowRecord::SetDlTimeStamp(), and ns3::ServiceFlow::SF_TYPE_RTPS.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BSSchedulerUGSConnection()

void ns3::BSSchedulerRtps::BSSchedulerUGSConnection ( uint32_t &  availableSymbols)

schedules the UGS connection

Parameters
availableSymbolsthe remaining free OFDM symbols in the current subframe

Definition at line 433 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), CreateUgsBurst(), ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::BSScheduler::GetBs(), ns3::ServiceFlowRecord::GetDlTimeStamp(), ns3::MilliSeconds(), ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, ns3::Cid::MULTICAST, ns3::Simulator::Now(), ns3::ServiceFlowRecord::SetDlTimeStamp(), and ns3::ServiceFlow::SF_TYPE_UGS.

Referenced by Schedule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ CreateUgsBurst()

Ptr< PacketBurst > ns3::BSSchedulerRtps::CreateUgsBurst ( ServiceFlow serviceFlow,
WimaxPhy::ModulationType  modulationType,
uint32_t  availableSymbols 
)
overridevirtual

Creates a downlink UGS burst.

Parameters
serviceFlowthe service flow of the burst
modulationTypethe modulation type to be used for the burst
availableSymbolsmaximum number of OFDM symbols to be used by the burst
Returns
a Burst (list of packets)

Implements ns3::BSScheduler.

Definition at line 171 of file bs-scheduler-rtps.cc.

References ns3::BSScheduler::CheckForFragmentation(), ns3::BSScheduler::GetBs(), ns3::ServiceFlow::GetConnection(), ns3::ServiceFlow::HasPackets(), and ns3::MacHeaderType::HEADER_TYPE_GENERIC.

Referenced by BSSchedulerUGSConnection().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetDownlinkBursts()

std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * ns3::BSSchedulerRtps::GetDownlinkBursts ( ) const
overridevirtual

This function returns all the downlink bursts scheduled for the next downlink sub-frame.

Returns
all the downlink bursts scheduled for the next downlink sub-frame

Implements ns3::BSScheduler.

Definition at line 88 of file bs-scheduler-rtps.cc.

References m_downlinkBursts.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 48 of file bs-scheduler-rtps.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Schedule()

void ns3::BSSchedulerRtps::Schedule ( )
overridevirtual

Schedule function.

A DownLink Scheduler for rtPS Flows.

The DL Scheduler assigns the available bandwidth in the following order:

  • IR Connections
  • Broadcast Connections
  • Basic and Primary Connections
  • UGS Connections
  • rtPS Connections
  • nrtPS Connections
  • BE Connections All rtPS flows that have packets in the queue can transmit at least one packet, according to the available bandwidth.

Implements ns3::BSScheduler.

Definition at line 132 of file bs-scheduler-rtps.cc.

References ns3::Cid::BASIC, BSSchedulerBasicConnection(), BSSchedulerBEConnection(), BSSchedulerBroadcastConnection(), BSSchedulerInitialRangingConnection(), BSSchedulerNRTPSConnection(), BSSchedulerPrimaryConnection(), BSSchedulerRTPSConnection(), BSSchedulerUGSConnection(), ns3::BSScheduler::GetBs(), ns3::GetSize(), m_downlinkBursts, NS_LOG_DEBUG, ns3::Cid::PRIMARY, ns3::ServiceFlow::SF_TYPE_ALL, ns3::ServiceFlow::SF_TYPE_NONE, and ns3::Cid::TRANSPORT.

+ Here is the call graph for this function:

◆ SelectBEConnection()

bool ns3::BSSchedulerRtps::SelectBEConnection ( Ptr< WimaxConnection > &  connection)

Check for BE connections that have packets to transmit.

Parameters
connectionwill point to a connection that has packets to be sent
Returns
false if no connection has packets to be sent, true otherwise

◆ SelectConnection()

bool ns3::BSSchedulerRtps::SelectConnection ( Ptr< WimaxConnection > &  connection)
overridevirtual

Selects a connection from the list of connections having packets to be sent .

Parameters
connectionwill point to a connection that has packets to be sent
Returns
false if no connection has packets to be sent, true otherwise

Implements ns3::BSScheduler.

Definition at line 211 of file bs-scheduler-rtps.cc.

◆ SelectIRandBCConnection()

bool ns3::BSSchedulerRtps::SelectIRandBCConnection ( Ptr< WimaxConnection > &  connection)

Check for IR and Broadcast connections that have packets to transmit.

Parameters
connectionwill point to a initial ranging or broadcast connection which have packets to transmit
Returns
false if no initial ranging or broadcast connection has packets to transmit, true otherwise

◆ SelectMenagementConnection()

bool ns3::BSSchedulerRtps::SelectMenagementConnection ( Ptr< WimaxConnection > &  connection)

Check for Basic and Primary connections that have packets to transmit.

Parameters
connectionwill point to a basic or primary connection which have packets to transmit
Returns
false if no basic or primary connection has packets to transmit, true otherwise

◆ SelectNRTPSConnection()

bool ns3::BSSchedulerRtps::SelectNRTPSConnection ( Ptr< WimaxConnection > &  connection)

Check for nrtPS connections that have packets to transmit.

Parameters
connectionwill point to a connection that has packets to be sent
Returns
false if no connection has packets to be sent, true otherwise

◆ SelectRTPSConnection()

bool ns3::BSSchedulerRtps::SelectRTPSConnection ( Ptr< WimaxConnection > &  connection)

Check for rtPS connections that have packets to transmit.

Parameters
connectionwill point to a connection that has packets to be sent
Returns
false if no connection has packets to be sent, true otherwise

◆ SelectUGSConnection()

bool ns3::BSSchedulerRtps::SelectUGSConnection ( Ptr< WimaxConnection > &  connection)

Check for UGS connections that have packets to transmit.

The method return the UGS connection that have packets to transmits, according to the MaxLatency specifications.

Parameters
connectionwill point to a connection that has packets to be sent
Returns
true if successful

Member Data Documentation

◆ m_downlinkBursts

std::list<std::pair<OfdmDlMapIe*, Ptr<PacketBurst> > >* ns3::BSSchedulerRtps::m_downlinkBursts
private

down link bursts

Definition at line 221 of file bs-scheduler-rtps.h.

Referenced by ~BSSchedulerRtps(), AddDownlinkBurst(), GetDownlinkBursts(), and Schedule().


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