Network server component in charge of scheduling downling packets onto devices' reception windows. More...

#include "network-scheduler.h"

Inheritance diagram for ns3::lorawan::NetworkScheduler:

Collaboration diagram for ns3::lorawan::NetworkScheduler:

Public Member Functions
	NetworkScheduler ()
	Default constructor.

	NetworkScheduler (Ptr< NetworkStatus > status, Ptr< NetworkController > controller)
	Construct a new NetworkScheduler providing the NetworkStatus and the NetworkController objects.

	~NetworkScheduler () override
	Destructor.

void	OnReceivedPacket (Ptr< const Packet > packet)
	Method called by NetworkServer application to inform the Scheduler of a newly arrived uplink packet.

void	OnReceiveWindowOpportunity (LoraDeviceAddress deviceAddress, int window)
	Method that is scheduled after packet arrival in order to take action on sender's receive windows openings.

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 ()
	Register this type.

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< NetworkController >	m_controller
	A pointer to the NetworkController object.

TracedCallback< Ptr< const Packet > >	m_receiveWindowOpened
	Trace callback source for reception windows openings.

Ptr< NetworkStatus >	m_status
	A pointer to the NetworkStatus object.

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

Network server component in charge of scheduling downling packets onto devices' reception windows.

Todo:: We should probably add getters and setters or remove default constructor

Definition at line 48 of file network-scheduler.h.

Constructor & Destructor Documentation

◆ NetworkScheduler() [1/2]

ns3::lorawan::NetworkScheduler::NetworkScheduler ( )

Default constructor.

Definition at line 27 of file network-scheduler.cc.

◆ ~NetworkScheduler()

ns3::lorawan::NetworkScheduler::~NetworkScheduler ( )

override

Destructor.

Definition at line 37 of file network-scheduler.cc.

◆ NetworkScheduler() [2/2]

ns3::lorawan::NetworkScheduler::NetworkScheduler	(	Ptr< NetworkStatus >	status,
		Ptr< NetworkController >	controller
	)

Construct a new NetworkScheduler providing the NetworkStatus and the NetworkController objects.

Parameters

status	A pointer to the NetworkStatus object.
controller	A pointer to the NetworkController object.

Definition at line 31 of file network-scheduler.cc.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::lorawan::NetworkScheduler::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 13 of file network-scheduler.cc.

References m_receiveWindowOpened, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ OnReceivedPacket()

void ns3::lorawan::NetworkScheduler::OnReceivedPacket ( Ptr< const Packet > packet )

Method called by NetworkServer application to inform the Scheduler of a newly arrived uplink packet.

This function schedules the OnReceiveWindowOpportunity events 1 and 2 seconds later.

Parameters

packet A pointer to the new Packet instance.

Definition at line 42 of file network-scheduler.cc.

References ns3::lorawan::LoraFrameHeader::GetAddress(), m_status, NS_LOG_FUNCTION, OnReceiveWindowOpportunity(), ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::lorawan::LoraFrameHeader::SetAsUplink().

Here is the call graph for this function:

◆ OnReceiveWindowOpportunity()

void ns3::lorawan::NetworkScheduler::OnReceiveWindowOpportunity	(	LoraDeviceAddress	deviceAddress,
		int	window
	)

Method that is scheduled after packet arrival in order to take action on sender's receive windows openings.

Parameters

deviceAddress	The Address of the end device.
window	The reception window number (1 or 2).

Definition at line 71 of file network-scheduler.cc.

References m_controller, m_status, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, OnReceiveWindowOpportunity(), ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by OnReceivedPacket(), and OnReceiveWindowOpportunity().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_controller

Ptr<NetworkController> ns3::lorawan::NetworkScheduler::m_controller

private

A pointer to the NetworkController object.

Definition at line 93 of file network-scheduler.h.

Referenced by OnReceiveWindowOpportunity().

◆ m_receiveWindowOpened

TracedCallback<Ptr<const Packet> > ns3::lorawan::NetworkScheduler::m_receiveWindowOpened

private

Trace callback source for reception windows openings.

Todo:: Never called. Place calls in the right places.

Definition at line 90 of file network-scheduler.h.

Referenced by GetTypeId().

◆ m_status

Ptr<NetworkStatus> ns3::lorawan::NetworkScheduler::m_status

private

A pointer to the NetworkStatus object.

Definition at line 92 of file network-scheduler.h.

Referenced by OnReceivedPacket(), and OnReceiveWindowOpportunity().

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

src/lorawan/model/network-scheduler.h
src/lorawan/model/network-scheduler.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NetworkScheduler() [1/2]

◆ ~NetworkScheduler()

◆ NetworkScheduler() [2/2]

Member Function Documentation

◆ GetTypeId()

◆ OnReceivedPacket()

◆ OnReceiveWindowOpportunity()

Member Data Documentation

◆ m_controller

◆ m_receiveWindowOpened

◆ m_status