catapult::thread::Scheduler Class Reference

A scheduler. More...

Public Member Functions
virtual	~Scheduler ()=default
virtual uint32_t	numScheduledTasks () const =0
	Gets the number of tasks that are currently either scheduled or executing. More...
virtual uint32_t	numExecutingTaskCallbacks () const =0
	Gets the number of currently executing task callbacks. More...
virtual void	addTask (const Task &task)=0
	Adds a scheduled task to the scheduler. More...
virtual void	shutdown ()=0
	Shuts down the scheduler. More...

Detailed Description

A scheduler.

Constructor & Destructor Documentation

~Scheduler()

virtual catapult::thread::Scheduler::~Scheduler ( )

virtualdefault

Member Function Documentation

addTask()

virtual void catapult::thread::Scheduler::addTask ( const Task &  task )

pure virtual

Adds a scheduled task to the scheduler.

numExecutingTaskCallbacks()

virtual uint32_t catapult::thread::Scheduler::numExecutingTaskCallbacks ( ) const

pure virtual

Gets the number of currently executing task callbacks.

numScheduledTasks()

virtual uint32_t catapult::thread::Scheduler::numScheduledTasks ( ) const

pure virtual

Gets the number of tasks that are currently either scheduled or executing.

shutdown()

virtual void catapult::thread::Scheduler::shutdown ( )

pure virtual

Shuts down the scheduler.

---

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

• Scheduler.h