Scheduler

Collaboration diagram for Scheduler:

Detailed Description

Modules
	Factories

Classes
struct	IScheduler
	A thread-pool scheduler that supports scheduling one-off functions as well as dependency graphs. More...
class	SchedulerPtr
	A thread-pool scheduler that supports scheduling one-off functions as well as dependency graphs. More...

Functions
daq::AwaitablePtr	scheduleFunction (const daq::FunctionPtr &function) const
	Schedules the specified work function to run on the thread-pool. The call does not block but immediately returns an awaitable that represents the asynchronous execution. It can be waited upon and queried for status and result. More...
void	scheduleWork (const daq::WorkPtr &work) const
	Schedules the specified work callback to run on the thread-pool. The call does not block. More...
daq::AwaitablePtr	scheduleGraph (const daq::TaskGraphPtr &graph) const
	Schedules the specified dependency graph to run on the thread-pool. The call does not block but immediately returns an awaitable that represents the asynchronous execution. It can be waited upon and queried for status and result. Any exceptions that occur during the graph execution are silently ignored. More...
void	stop () const
	Cancels all outstanding work and waits for the remaining to complete. After this point the scheduler does not allow any new work or graphs for scheduling.
void	waitAll () const
	Waits fo all current scheduled work and tasks to complete.
daq::Bool	isMultiThreaded () const
	Returns whether more than one worker thread is used. More...

Function Documentation

isMultiThreaded()

daq::Bool isMultiThreaded ( ) const

inline

Returns whether more than one worker thread is used.

Returns

Returns true if more that one worker thread is used by the scheduler.

scheduleFunction()

daq::AwaitablePtr scheduleFunction ( const daq::FunctionPtr &  function ) const

inline

Schedules the specified work function to run on the thread-pool. The call does not block but immediately returns an awaitable that represents the asynchronous execution. It can be waited upon and queried for status and result.

Parameters

function

The function to schedule for execution.

Returns

The object representing the state and result of the execution.

Exceptions

OpendaqErrException

when the scheduler already stopped and is not accepting any more work.

scheduleGraph()

daq::AwaitablePtr scheduleGraph ( const daq::TaskGraphPtr &  graph ) const

inline

Schedules the specified dependency graph to run on the thread-pool. The call does not block but immediately returns an awaitable that represents the asynchronous execution. It can be waited upon and queried for status and result. Any exceptions that occur during the graph execution are silently ignored.

Parameters

graph

The dependency graph (acyclic directed graph) to schedule.

Returns

The object representing the state and result of the execution.

Exceptions

OpendaqErrException

when the scheduler already stopped and is not accepting any more work.

scheduleWork()

void scheduleWork ( const daq::WorkPtr &  work ) const

inline

Schedules the specified work callback to run on the thread-pool. The call does not block.

Parameters

work	The function to schedule for execution.

Exceptions

OpendaqErrException

when the scheduler already stopped and is not accepting any more work.

Work is a lightweight callback that returns no value and accepts no procedure. It has less overhead than function. The function does not return awaitable object.