m2etis::pubsub::Scheduler< ClockUpdater > Class Template Reference

#include <Scheduler.h>

Inheritance diagram for m2etis::pubsub::Scheduler< ClockUpdater >:

Classes
struct	Job

Public Types
typedef struct m2etis::pubsub::Scheduler::Job	Job

Public Member Functions
	Scheduler (util::Clock< ClockUpdater > &c)
	~Scheduler ()
uint64_t	runOnce (uint64_t time, const boost::function< bool(void)> &func, int16_t priority)
	adds new job running only once More...
uint64_t	runRepeated (uint64_t interval, const boost::function< bool(void)> &func, int16_t priority)
	adds new job running repeatedly More...
uint64_t	getTime () const
	returns current time More...
void	stop (uint64_t id)
void	Stop ()
	Stops whole Scheduler and removes all tasks. More...

Detailed Description

template<class ClockUpdater>
class m2etis::pubsub::Scheduler< ClockUpdater >

Definition at line 37 of file Scheduler.h.

Member Typedef Documentation

template<class ClockUpdater>

typedef struct m2etis::pubsub::Scheduler::Job m2etis::pubsub::Scheduler< ClockUpdater >::Job

Constructor & Destructor Documentation

template<class ClockUpdater>

m2etis::pubsub::Scheduler< ClockUpdater >::Scheduler ( util::Clock< ClockUpdater > &  c )

inlineexplicit

Definition at line 59 of file Scheduler.h.

template<class ClockUpdater>

m2etis::pubsub::Scheduler< ClockUpdater >::~Scheduler ( )

inline

Definition at line 68 of file Scheduler.h.

Member Function Documentation

template<class ClockUpdater>

uint64_t m2etis::pubsub::Scheduler< ClockUpdater >::getTime ( ) const

inline

returns current time

Definition at line 106 of file Scheduler.h.

Here is the caller graph for this function:

template<class ClockUpdater>

uint64_t m2etis::pubsub::Scheduler< ClockUpdater >::runOnce ( uint64_t  time, const boost::function< bool(void)> &  func, int16_t  priority  )

inline

adds new job running only once

Parameters

[in]	time	time after which this job will be scheduled (in microseconds)
[in]	func	function to be called when scheduled
[in]	priority	priority of this job

Definition at line 78 of file Scheduler.h.

Here is the caller graph for this function:

template<class ClockUpdater>

uint64_t m2etis::pubsub::Scheduler< ClockUpdater >::runRepeated ( uint64_t  interval, const boost::function< bool(void)> &  func, int16_t  priority  )

inline

adds new job running repeatedly

Parameters

[in]	interval	time after which this job will be scheduled (in microseconds)
[in]	func	function to be called when scheduled
[in]	priority	priority of this job

Definition at line 94 of file Scheduler.h.

Here is the caller graph for this function:

template<class ClockUpdater>

void m2etis::pubsub::Scheduler< ClockUpdater >::stop ( uint64_t  id )

inline

Definition at line 110 of file Scheduler.h.

Here is the caller graph for this function:

template<class ClockUpdater>

void m2etis::pubsub::Scheduler< ClockUpdater >::Stop ( )

inline

Stops whole Scheduler and removes all tasks.

Definition at line 119 of file Scheduler.h.

---

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

• Scheduler.h