#include <timed_task.h>

Public Member Functions
DISPENSO_DLL_ACCESS	TimedTaskScheduler (ThreadPriority priority=ThreadPriority::kNormal)

void	setPriority (ThreadPriority priority)

template<typename Schedulable , typename F >
TimedTask	schedule (Schedulable &sched, F &&func, double nextRunAbs, double period=0.0, size_t timesToRun=1, TimedTaskType type=TimedTaskType::kNormal)

template<typename Schedulable , typename Rep , typename Period , typename F >
TimedTask	schedule (Schedulable &sched, F &&func, const std::chrono::duration< Rep, Period > &timeInFuture)

template<typename Schedulable , typename Clock , typename Duration , typename F >
TimedTask	schedule (Schedulable &sched, F &&func, const std::chrono::time_point< Clock, Duration > &nextRunTime)

template<typename Schedulable , typename Rep , typename Period , typename F >
TimedTask	schedule (Schedulable &sched, F &&func, const std::chrono::duration< Rep, Period > &timeInFuture, const std::chrono::duration< Rep, Period > &period, size_t timesToRun=std::numeric_limits< size_t >::max(), TimedTaskType type=TimedTaskType::kNormal)

template<typename Schedulable , typename Rep , typename Period , typename Clock , typename Duration , typename F >
TimedTask	schedule (Schedulable &sched, F &&func, const std::chrono::time_point< Clock, Duration > &nextRunTime, const std::chrono::duration< Rep, Period > &period, size_t timesToRun=std::numeric_limits< size_t >::max(), TimedTaskType type=TimedTaskType::kNormal)

Detailed Description

A timed-task scheduler running on a single thread. This allows multiple schedulers if necessary, if e.g. you wish to schedule against InlineInvoker backing schedulable and you're running a lot of relatively quick timed tasks.Most people should just use the global timed task scheduler.

Definition at line 126 of file timed_task.h.

Constructor & Destructor Documentation

◆ TimedTaskScheduler()

dispenso::TimedTaskScheduler::TimedTaskScheduler ( ThreadPriority priority = ThreadPriority::kNormal )

explicit

Create a TimedTaskScheduler with specified priority

Parameters

priority The priority to set. For highest level of periodicity accuracy, use kRealtime.

Note: Priorities above kNormal should be used sparingly, and only short-running tasks should be run inline to avoid bad OS responsivity. When using a ThreadPool Schedulable, tasks can be long running.

Definition at line 15 of file timed_task.cpp.

◆ ~TimedTaskScheduler()

dispenso::TimedTaskScheduler::~TimedTaskScheduler ( )

Definition at line 24 of file timed_task.cpp.

Member Function Documentation

◆ schedule() [1/5]

template<typename Schedulable , typename Rep , typename Period , typename F >

TimedTask dispenso::TimedTaskScheduler::schedule	(	Schedulable &	sched,
		F &&	func,
		const std::chrono::duration< Rep, Period > &	timeInFuture
	)

inline

Schedule a task to run once at a time in the future

Parameters

sched	A backing schedulable, such as ImmediateInvoker, NewThreadInvoker, TaskSet, or ThreadPool to run the function in when it is scheduled.
func	A bool() function to run when scheduled. The function may return true to indicate it should continue to be scheduled, or false to cancel.
timeInFuture	the amount of time from current at which to schedule the function

Definition at line 186 of file timed_task.h.

◆ schedule() [2/5]

template<typename Schedulable , typename Rep , typename Period , typename F >

TimedTask dispenso::TimedTaskScheduler::schedule	(	Schedulable &	sched,
		F &&	func,
		const std::chrono::duration< Rep, Period > &	timeInFuture,
		const std::chrono::duration< Rep, Period > &	period,
		size_t	timesToRun = `std::numeric_limits<size_t>::max()`,
		TimedTaskType	type = `TimedTaskType::kNormal`
	)

inline

Schedule a task to run periodically

Parameters

sched	A backing schedulable, such as ImmediateInvoker, NewThreadInvoker, TaskSet, or ThreadPool to run the function in when it is scheduled.
func	A bool() function to run when scheduled. The function may return true to indicate it should continue to be scheduled, or false to cancel.
timeInFuture	the amount of time from current at which to schedule the function
period	The period defining the run frequency
timesToRun	The number of times to run the function. After that number, the function will not be called again.
type	The type of periodicity (if any).

Definition at line 222 of file timed_task.h.

◆ schedule() [3/5]

template<typename Schedulable , typename Clock , typename Duration , typename F >

TimedTask dispenso::TimedTaskScheduler::schedule	(	Schedulable &	sched,
		F &&	func,
		const std::chrono::time_point< Clock, Duration > &	nextRunTime
	)

inline

Schedule a task to run once at a time in the future

Parameters

sched	A backing schedulable, such as ImmediateInvoker, NewThreadInvoker, TaskSet, or ThreadPool to run the function in when it is scheduled.
func	A bool() function to run when scheduled. The function may return true to indicate it should continue to be scheduled, or false to cancel.
nextRunTime	An absolute time to run the function. If in the past, func will run immediately.

Definition at line 201 of file timed_task.h.

◆ schedule() [4/5]

template<typename Schedulable , typename Rep , typename Period , typename Clock , typename Duration , typename F >

TimedTask dispenso::TimedTaskScheduler::schedule	(	Schedulable &	sched,
		F &&	func,
		const std::chrono::time_point< Clock, Duration > &	nextRunTime,
		const std::chrono::duration< Rep, Period > &	period,
		size_t	timesToRun = `std::numeric_limits<size_t>::max()`,
		TimedTaskType	type = `TimedTaskType::kNormal`
	)

inline

Schedule a task to run periodically

Parameters

sched	A backing schedulable, such as ImmediateInvoker, NewThreadInvoker, TaskSet, or ThreadPool to run the function in when it is scheduled.
func	A bool() function to run when scheduled. The function may return true to indicate it should continue to be scheduled, or false to cancel.
nextRunTime	An absolute time to run the function. If in the past, func will run immediately.
period	The period defining the run frequency
timesToRun	The number of times to run the function. After that number, the function will not be called again.
type	The type of periodicity (if any).

Definition at line 254 of file timed_task.h.

◆ schedule() [5/5]

template<typename Schedulable , typename F >

TimedTask dispenso::TimedTaskScheduler::schedule	(	Schedulable &	sched,
		F &&	func,
		double	nextRunAbs,
		double	period = `0.0`,
		size_t	timesToRun = `1`,
		TimedTaskType	type = `TimedTaskType::kNormal`
	)

inline

Schedule a task

Parameters

sched	A backing schedulable, such as ImmediateInvoker, NewThreadInvoker, TaskSet, or ThreadPool to run the function in when it is scheduled.
func	A bool() function to run when scheduled. The function may return true to indicate it should continue to be scheduled, or false to cancel.
nextRunAbs	The absolute time to run the function. Time scale is expected to match getTime() for absolute times.
period	The period in seconds.
timesToRun	The number of times to run the function. After that number, the function will not be called again.
type	The type of periodicity (if any).

Definition at line 163 of file timed_task.h.

◆ setPriority()

void dispenso::TimedTaskScheduler::setPriority ( ThreadPriority priority )

inline

Set the priority for the backing thread. See note for constructor.

Definition at line 143 of file timed_task.h.

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

/github/workspace/dispenso/timed_task.h
/github/workspace/dispenso/timed_task.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TimedTaskScheduler()

◆ ~TimedTaskScheduler()

Member Function Documentation

◆ schedule() [1/5]

◆ schedule() [2/5]

◆ schedule() [3/5]

◆ schedule() [4/5]

◆ schedule() [5/5]

◆ setPriority()