Scheduler interface used by BaseModel to communicate with a scheduler module. More...

#include <scheduler.h>

Inheritance diagram for EMANE::Models::TDMA::Scheduler:

Public Member Functions
virtual	~Scheduler ()

virtual std::pair< RxSlotInfo, bool >	getRxSlotInfo (const TimePoint &timePoint) const =0

virtual std::pair< TxSlotInfos, TimePoint >	getTxSlotInfo (const TimePoint &timePoint, int multiframes) const =0

virtual SlotInfo	getSlotInfo (std::uint64_t u64AbsoluteSlotIndex) const =0

virtual SlotInfo	getSlotInfo (const TimePoint &timePoint) const =0

virtual void	processSchedulerPacket (UpstreamPacket &pkt, const PacketMetaInfo &packetMetaInfo)=0

virtual void	processPacketMetaInfo (const PacketMetaInfo &packetMetaInfo)=0

virtual void	initialize (Registrar &registrar)=0

virtual void	configure (const ConfigurationUpdate &update)=0

virtual void	start ()=0

virtual void	postStart ()

virtual void	stop ()=0

virtual void	destroy ()=0 throw ()

virtual void	processEvent (const EventId &eventId, const Serialization &serialization)

virtual void	processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg)

virtual void	processConfiguration (const ConfigurationUpdate &update)

Protected Member Functions
	Scheduler (NEMId id, PlatformServiceProvider pPlatformServiceProvider, SchedulerUser pSchedulerUser)

Protected Attributes
SchedulerUser *	pSchedulerUser_

NEMId	id_

PlatformServiceProvider *	pPlatformService_

Detailed Description

Scheduler interface used by BaseModel to communicate with a scheduler module.

Definition at line 56 of file scheduler.h.

Constructor & Destructor Documentation

◆ ~Scheduler()

virtual EMANE::Models::TDMA::Scheduler::~Scheduler ( )

inlinevirtual

Destroys an instance.

Definition at line 64 of file scheduler.h.

◆ Scheduler()

EMANE::Models::TDMA::Scheduler::Scheduler	(	NEMId	id,
		PlatformServiceProvider *	pPlatformServiceProvider,
		SchedulerUser *	pSchedulerUser
	)

inlineprotected

Creates an instance.

Definition at line 145 of file scheduler.h.

Member Function Documentation

◆ configure()

virtual void EMANE::Component::configure ( const ConfigurationUpdate & update )

pure virtualinherited

Configure the component.

Parameters

update Configuration update values

Exceptions

ConfigureException thrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ destroy()

virtual void EMANE::Component::destroy	(	)
throw	(
	)

pure virtualinherited

Destroy the component.

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Models::TDMA::EventScheduler, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::FrameworkPHY, EMANE::Application::TransportAdapterImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ getRxSlotInfo()

virtual std::pair<RxSlotInfo,bool> EMANE::Models::TDMA::Scheduler::getRxSlotInfo ( const TimePoint & timePoint ) const

pure virtual

Gets the RxSlotInfo for a specified time.

Parameters

timePoint Current time

Returns: A pair holding the RxSlotInfo and a bool set to true if the slot is a valid receive slot.

Implemented in EMANE::Models::TDMA::EventScheduler.

◆ getSlotInfo() [1/2]

virtual SlotInfo EMANE::Models::TDMA::Scheduler::getSlotInfo ( std::uint64_t u64AbsoluteSlotIndex ) const

pure virtual

Gets the slot info for a specified absolute slot index

Parameters

u64AbsoluteSlotIndex Absolute slot index

Returns: Slot information

Implemented in EMANE::Models::TDMA::EventScheduler.

◆ getSlotInfo() [2/2]

virtual SlotInfo EMANE::Models::TDMA::Scheduler::getSlotInfo ( const TimePoint & timePoint ) const

pure virtual

Gets the slot info for a specified time

Parameters

timePoint Time of desired slot info

Returns: Slot information

Implemented in EMANE::Models::TDMA::EventScheduler.

◆ getTxSlotInfo()

virtual std::pair<TxSlotInfos,TimePoint> EMANE::Models::TDMA::Scheduler::getTxSlotInfo	(	const TimePoint &	timePoint,
		int	multiframes
	)		const

pure virtual

Gets the transmit slot info for a specified number of multiframes occurring on or after a specified time.

Parameters

timePoint	Start time of transmit opportunity search
multiframes	Number of mulitframes worth of transmit opportunities to return

Returns: A pair holding a list of TxSlotInfo entries and the next time to use when requesting more transmit opportunities.

Note: Using the returned time value during the next request allows you to determine the number of missed opportunities due to system timing/resource issues.

Implemented in EMANE::Models::TDMA::EventScheduler.

◆ initialize()

virtual void EMANE::Component::initialize ( Registrar & registrar )

pure virtualinherited

Initialize the component.

Exceptions

InitializeException thrown when an error is encountered during initialization

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ postStart()

virtual void EMANE::Component::postStart ( )

inlinevirtualinherited

Hook to run any post start functionaililty. Called after all the components have been started.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::TransportLayer, EMANE::Application::TransportManagerImpl, and EMANE::Models::TDMA::BasicQueueManager.

Definition at line 119 of file component.h.

◆ processConfiguration()

virtual void EMANE::RunningStateMutable::processConfiguration ( const ConfigurationUpdate & update )

inlinevirtualinherited

Process dynamic running-state configuration updates

Parameters

update Configuration update

Note: Running state configuration errors are indicated using a validator. Validators can be registered using the ConfigurationRegistrar.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::TDMA::BaseModel, EMANE::NEMStatefulLayer, EMANE::NEMQueuedLayer, and EMANE::FrameworkPHY.

Definition at line 63 of file runningstatemutable.h.

◆ processEvent()

virtual void EMANE::EventServiceUser::processEvent	(	const EventId &	eventId,
		const Serialization &	serialization
	)

inlinevirtualinherited

Process an event.

Parameters

eventId	event identifier corresponding to the serialized event
serialization	opaque event object data

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::NEMStatefulLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::FrameworkPHY, EMANE::Models::TDMA::BaseModel, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TDMA::EventScheduler, and EMANE::Agents::GPSDLocation::Agent.

Definition at line 58 of file eventserviceuser.h.

◆ processPacketMetaInfo()

virtual void EMANE::Models::TDMA::Scheduler::processPacketMetaInfo ( const PacketMetaInfo & packetMetaInfo )

pure virtual

Process packet information for a received over-the-air data packet.

Parameters

packetMetaInfo Meta information associated with received packet

Implemented in EMANE::Models::TDMA::EventScheduler.

◆ processSchedulerPacket()

virtual void EMANE::Models::TDMA::Scheduler::processSchedulerPacket	(	UpstreamPacket &	pkt,
		const PacketMetaInfo &	packetMetaInfo
	)

pure virtual

Process a Scheduler message received over-the-air.

Parameters

pkt	Received UpstreamPacket
packetMetaInfo	Meta information associated with received packet

Implemented in EMANE::Models::TDMA::EventScheduler.

◆ processTimedEvent()

virtual void EMANE::TimerServiceUser::processTimedEvent	(	TimerEventId	eventId,
		const TimePoint &	expireTime,
		const TimePoint &	scheduleTime,
		const TimePoint &	fireTime,
		const void *	arg
	)

inlinevirtualinherited

Process a timed event

Parameters

eventId	Identifier corresponding to the timer being processed
expireTime	The time the timer was scheduled to expire
scheduleTime	The Time the timer was scheduled
fireTime	Time time The time the timer actually fired
arg	Opaque timed event data

Note: All times are abosulte using CLOCK_REALTIME

Reimplemented in EMANE::NEMStatefulLayer, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Agents::GPSDLocation::Agent, EMANE::TimerServiceProxy, and EMANE::NEMTimerServiceProxy.

Definition at line 62 of file timerserviceuser.h.

◆ start()

virtual void EMANE::Component::start ( )

pure virtualinherited

Start the component.

Exceptions

StartException thrown when an error is encountered during start.

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::Application::TransportManagerImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ stop()

virtual void EMANE::Component::stop ( )

pure virtualinherited

Stop the component.

Exceptions

StopException thrown when an error is encountered during stop

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::TDMA::EventScheduler, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::FrameworkPHY, EMANE::Application::TransportAdapterImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::MACLayer, EMANE::PHYLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::ShimLayer, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

Member Data Documentation

◆ id_

NEMId EMANE::Models::TDMA::Scheduler::id_

protected

Definition at line 140 of file scheduler.h.

◆ pPlatformService_

PlatformServiceProvider* EMANE::PlatformServiceUser::pPlatformService_

protectedinherited

Definition at line 64 of file platformserviceuser.h.

◆ pSchedulerUser_

SchedulerUser* EMANE::Models::TDMA::Scheduler::pSchedulerUser_

protected

Definition at line 139 of file scheduler.h.

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

scheduler.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Scheduler()

◆ Scheduler()

Member Function Documentation

◆ configure()

◆ destroy()

◆ getRxSlotInfo()

◆ getSlotInfo() [1/2]

◆ getSlotInfo() [2/2]

◆ getTxSlotInfo()

◆ initialize()

◆ postStart()

◆ processConfiguration()

◆ processEvent()

◆ processPacketMetaInfo()

◆ processSchedulerPacket()

◆ processTimedEvent()

◆ start()

◆ stop()

Member Data Documentation

◆ id_

◆ pPlatformService_

◆ pSchedulerUser_