System::Scheduler Class Reference

Abstract class(interface) that introduces API contract of scheduler. More...

#include <B2BITS_Scheduler.h>

Inheritance diagram for System::Scheduler:

Collaboration diagram for System::Scheduler:

Public Types
enum	SchedulerState { SchedulerState_Stopped = 0 , SchedulerState_Started = 1 }
typedef std::map< std::string, SchedulePtr >	Schedules
	Map of schedules registered.

Public Member Functions
virtual SchedulePtr	getSchedule (const std::string &scheduleId) const =0
	Returns scheduler registered by id.
virtual Schedules	getSchedules () const =0
	Returns schedules registered at the scheduler.
virtual SchedulerState	getState ()=0
	Returns current scheduler's state.
virtual void	registerSchedule (const SchedulePtr &schedulePtr)=0
	Registers schedule at scheduler.
virtual void	start ()=0
	Start scheduler operation.
virtual void	stop ()=0
	Stop scheduler operation.
virtual void	unregisterAll ()=0
	Unregisters all registered schedules.
virtual void	unregisterSchedule (const std::string &scheduleId)=0
	Unregisters schedule from scheduler.
Public Member Functions inherited from Utils::ReferenceCounter
virtual bool	addRef () const throw ()
	Increments reference counter.
virtual long	getNRef () const throw ()
	Returns the current value of the reference counter.
	ReferenceCounter () throw ()
	Constructor.
virtual long	release () const throw ()
	Decrements reference counter.

Additional Inherited Members
Protected Member Functions inherited from Utils::ReferenceCounter
long	decrement () const throw ()
	Decrements counter and returns new counter value.
long	increment () const throw ()
	Increments counter and returns new counter value.
virtual	~ReferenceCounter ()
	Destructor.

Detailed Description

Abstract class(interface) that introduces API contract of scheduler.

Member Typedef Documentation

Schedules

typedef std::map<std::string, SchedulePtr> System::Scheduler::Schedules

Map of schedules registered.

Member Enumeration Documentation

SchedulerState

enum System::Scheduler::SchedulerState

Enumerator
SchedulerState_Stopped
SchedulerState_Started

Member Function Documentation

getSchedule()

virtual SchedulePtr System::Scheduler::getSchedule ( const std::string & scheduleId ) const

pure virtual

Returns scheduler registered by id.

Parameters

scheduleId

- id of the schedule that was previously registered at the scheduler.

Implemented in System::SchedulerImpl.

getSchedules()

virtual Schedules System::Scheduler::getSchedules ( ) const

pure virtual

Returns schedules registered at the scheduler.

Implemented in System::SchedulerImpl.

getState()

virtual SchedulerState System::Scheduler::getState ( )

pure virtual

Returns current scheduler's state.

Implemented in System::SchedulerImpl.

registerSchedule()

virtual void System::Scheduler::registerSchedule ( const SchedulePtr & schedulePtr )

pure virtual

Registers schedule at scheduler.

Parameters

schedulePtr

- the schdule to register.

Implemented in System::SchedulerImpl.

start()

virtual void System::Scheduler::start ( )

pure virtual

Start scheduler operation.

Implemented in System::SchedulerImpl.

stop()

virtual void System::Scheduler::stop ( )

pure virtual

Stop scheduler operation.

Implemented in System::SchedulerImpl.

unregisterAll()

virtual void System::Scheduler::unregisterAll ( )

pure virtual

Unregisters all registered schedules.

Implemented in System::SchedulerImpl.

unregisterSchedule()

virtual void System::Scheduler::unregisterSchedule ( const std::string & scheduleId )

pure virtual

Unregisters schedule from scheduler.

Parameters

scheduleId

- id of the schdule to unregister.

Implemented in System::SchedulerImpl.