A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 ~BSSchedulerRtps (void)
void AddDownlinkBurst (Ptr< const WimaxConnection > connection, uint8_t diuc, WimaxPhy::ModulationType modulationType, Ptr< PacketBurst > burst)
void BSSchedulerBasicConnection (uint32_t &availableSymbols)
void BSSchedulerBEConnection (uint32_t &availableSymbols)
void BSSchedulerBroadcastConnection (uint32_t &availableSymbols)
void BSSchedulerInitialRangingConnection (uint32_t &availableSymbols)
void BSSchedulerNRTPSConnection (uint32_t &availableSymbols)
void BSSchedulerPrimaryConnection (uint32_t &availableSymbols)
void BSSchedulerRTPSConnection (uint32_t &availableSymbols)
 Downlink Scheduler for rtPS connections.
void BSSchedulerUGSConnection (uint32_t &availableSymbols)
Ptr< PacketBurstCreateUgsBurst (ServiceFlow *serviceFlow, WimaxPhy::ModulationType modulationType, uint32_t availableSymbols)
std::list< std::pair
< OfdmDlMapIe *, Ptr
< PacketBurst > > > * 
GetDownlinkBursts (void) const
void Schedule (void)
 Schedule function.
bool SelectBEConnection (Ptr< WimaxConnection > &connection)
 Check for BE connections that have packets to transmit.
bool SelectConnection (Ptr< WimaxConnection > &connection)
bool SelectIRandBCConnection (Ptr< WimaxConnection > &connection)
 Check for IR and Broadcast connections that have packets to transmit.
bool SelectMenagementConnection (Ptr< WimaxConnection > &connection)
 Check for Basic and Primary connections that have packets to transmit.
bool SelectNRTPSConnection (Ptr< WimaxConnection > &connection)
 Check for nrtPS connections that have packets to transmit.
bool SelectRTPSConnection (Ptr< WimaxConnection > &connection)
 Check for rtPS connections that have packets to transmit.
bool SelectUGSConnection (Ptr< WimaxConnection > &connection)
 Check for UGS connections that have packets to transmit.
- Public Member Functions inherited from ns3::BSScheduler
 BSScheduler ()
 BSScheduler (Ptr< BaseStationNetDevice > bs)
 ~BSScheduler (void)
bool CheckForFragmentation (Ptr< WimaxConnection > connection, int availableSymbols, WimaxPhy::ModulationType modulationType)
virtual Ptr< BaseStationNetDeviceGetBs (void)
virtual void SetBs (Ptr< BaseStationNetDevice > bs)
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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)
 This method returns the TypeId associated to ns3::BSSchedulerRtps.

Private Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

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 58 of file bs-scheduler-rtps.h.

Constructor & Destructor Documentation

ns3::BSSchedulerRtps::BSSchedulerRtps ( )

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

References ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

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

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

References ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

ns3::BSSchedulerRtps::~BSSchedulerRtps ( void  )

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

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

+ Here is the call graph for this function:

Member Function Documentation

void ns3::BSSchedulerRtps::AddDownlinkBurst ( Ptr< const WimaxConnection connection,
uint8_t  diuc,
WimaxPhy::ModulationType  modulationType,
Ptr< PacketBurst burst 
)
virtual
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 481 of file bs-scheduler-rtps.cc.

References AddDownlinkBurst(), ns3::PacketBurst::AddPacket(), ns3::BSScheduler::CheckForFragmentation(), ns3::WimaxConnection::Dequeue(), ns3::WimaxNetDevice::DIRECTION_DOWNLINK, ns3::BSScheduler::GetBs(), ns3::BurstProfileManager::GetBurstProfile(), ns3::WimaxNetDevice::GetBurstProfileManager(), ns3::WimaxConnection::GetCid(), ns3::GenericMacHeader::GetCid(), ns3::ServiceFlow::GetModulation(), ns3::SSRecord::GetModulationType(), ns3::PacketBurst::GetNPackets(), ns3::WimaxPhy::GetNrSymbols(), ns3::WimaxNetDevice::GetPhy(), ns3::WimaxConnection::GetQueue(), ns3::WimaxMacQueue::GetQueueLengthWithMACOverhead(), ns3::WimaxConnection::GetServiceFlow(), ns3::BaseStationNetDevice::GetServiceFlowManager(), ns3::BsServiceFlowManager::GetServiceFlows(), ns3::BaseStationNetDevice::GetSSManager(), ns3::SSManager::GetSSRecord(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, ns3::Cid::MULTICAST, ns3::Now(), NS_ASSERT_MSG, NS_LOG_INFO, ns3::WimaxMacQueue::Peek(), 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:

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

Implements ns3::BSScheduler.

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

References m_downlinkBursts.

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

This method returns the TypeId associated to ns3::BSSchedulerRtps.

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

Reimplemented from ns3::BSScheduler.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::BSSchedulerRtps::Schedule ( void  )
virtual

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 128 of file bs-scheduler-rtps.cc.

References ns3::Cid::BASIC, BSSchedulerBasicConnection(), BSSchedulerBEConnection(), BSSchedulerBroadcastConnection(), BSSchedulerInitialRangingConnection(), BSSchedulerNRTPSConnection(), BSSchedulerPrimaryConnection(), BSSchedulerRTPSConnection(), BSSchedulerUGSConnection(), ns3::WimaxNetDevice::GetBroadcastConnection(), ns3::BSScheduler::GetBs(), ns3::WimaxNetDevice::GetConnectionManager(), ns3::WimaxNetDevice::GetInitialRangingConnection(), ns3::ConnectionManager::GetNPackets(), ns3::BaseStationNetDevice::GetNrDlSymbols(), ns3::WimaxConnection::GetQueue(), ns3::WimaxMacQueue::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:

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

Check for BE connections that have packets to transmit.

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

Implements ns3::BSScheduler.

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

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 wich have packets to transmit
Returns
false if no initial ranging or broadcast connection has packets to transmit, true otherwise
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 wich have packets to transmit
Returns
false if no basic or primary connection has packets to transmit, true otherwise
bool ns3::BSSchedulerRtps::SelectNRTPSConnection ( Ptr< WimaxConnection > &  connection)

Check for nrtPS connections that have packets to transmit.

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

Check for rtPS connections that have packets to transmit.

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.

Member Data Documentation

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

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