#include <TaskScheduler.h>

Classes
struct	Compare
	Container which provides Task order, insert and reschedule operations. More...

class	Task

class	TaskHandler

class	TaskQueue

Public Member Functions
	TaskScheduler ()

template<typename P >
	TaskScheduler (P &&predicate)

	TaskScheduler (TaskScheduler const &)=delete

	TaskScheduler (TaskScheduler &&)=delete

TaskScheduler &	operator= (TaskScheduler const &)=delete

TaskScheduler &	operator= (TaskScheduler &&)=delete

	~TaskScheduler ()

template<typename P >
TaskScheduler &	SetValidator (P &&predicate)
	Sets a validator which is asked if tasks are allowed to be executed.

TaskScheduler &	ClearValidator ()
	Clears the validator which is asked if tasks are allowed to be executed.

TaskScheduler &	Update ()
	Update the scheduler to the current time.

TaskScheduler &	Update (success_t callback)

TaskScheduler &	Update (size_t milliseconds)
	Update the scheduler with a difftime in ms.

TaskScheduler &	Update (size_t milliseconds, success_t callback)

TaskScheduler &	Update (duration_t difftime)
	Update the scheduler with a difftime.

TaskScheduler &	Update (duration_t difftime, success_t callback)

TaskScheduler &	Async (std::function< void()> callable)

TaskScheduler &	Schedule (duration_t time, task_handler_t task)

TaskScheduler &	Schedule (duration_t time, group_t group, task_handler_t task)

TaskScheduler &	Schedule (std::chrono::milliseconds min, std::chrono::milliseconds max, task_handler_t task)

TaskScheduler &	Schedule (std::chrono::milliseconds min, std::chrono::milliseconds max, group_t group, task_handler_t task)

TaskScheduler &	CancelAll ()

TaskScheduler &	CancelGroup (group_t group)

TaskScheduler &	CancelGroupsOf (std::span< group_t > groups)

TaskScheduler &	DelayAll (duration_t duration)
	Delays all tasks with the given duration.

TaskScheduler &	DelayAll (std::chrono::milliseconds min, std::chrono::milliseconds max)
	Delays all tasks with a random duration between min and max.

TaskScheduler &	DelayGroup (group_t group, duration_t duration)
	Delays all tasks of a group with the given duration.

TaskScheduler &	DelayGroup (group_t group, std::chrono::milliseconds min, std::chrono::milliseconds max)
	Delays all tasks of a group with a random duration between min and max.

TaskScheduler &	RescheduleAll (duration_t duration)
	Reschedule all tasks with a given duration.

TaskScheduler &	RescheduleAll (std::chrono::milliseconds min, std::chrono::milliseconds max)
	Reschedule all tasks with a random duration between min and max.

TaskScheduler &	RescheduleGroup (group_t group, duration_t duration)
	Reschedule all tasks of a group with the given duration.

TaskScheduler &	RescheduleGroup (group_t group, std::chrono::milliseconds min, std::chrono::milliseconds max)
	Reschedule all tasks of a group with a random duration between min and max.

Static Public Attributes
static success_t const	EmptySuccessCallback

Private Types
typedef std::chrono::steady_clock	clock_t

typedef clock_t::time_point	timepoint_t

typedef clock_t::duration	duration_t

typedef uint32	group_t

typedef uint32	repeated_t

typedef TaskHandler	task_handler_t

typedef std::function< bool()>	predicate_t

typedef std::function< void()>	success_t

typedef std::shared_ptr< Task >	TaskContainer

Private Member Functions
TaskScheduler &	InsertTask (TaskContainer &&task)
	Insert a new task to the enqueued tasks.

TaskScheduler &	InsertTask (TaskQueue::Container::node_type &&node)
	Insert a new task to the enqueued tasks.

TaskScheduler &	ScheduleAt (timepoint_t end, duration_t time, task_handler_t task)

TaskScheduler &	ScheduleAt (timepoint_t end, duration_t time, group_t group, task_handler_t task)

void	Dispatch (success_t const &callback)
	Dispatch remaining tasks.

Static Private Member Functions
static bool	EmptyValidator ()

Private Attributes
std::shared_ptr< TaskScheduler >	self_reference
	Contains a self reference to track if this object was deleted or not.

timepoint_t	_now
	The current time point (now)

TaskQueue	_task_holder
	The Task Queue which contains all task objects.

predicate_t	_predicate

Friends
class	TaskContext

Detailed Description

The TaskScheduler class provides the ability to schedule std::function's in the near future. Use TaskScheduler::Update to update the scheduler. Popular methods are:

Schedule (Schedules a std::function which will be executed in the near future).
Schedules an asynchronous function which will be executed at the next update tick.
Cancel, Delay & Reschedule (Methods to manipulate already scheduled tasks). Tasks are organized in groups (uint), multiple tasks can have the same group id, you can provide a group or not, but keep in mind that you can only manipulate specific tasks through its group id! Tasks callbacks use the function signature void(TaskContext) where TaskContext provides access to the function schedule plan which makes it possible to repeat the task with the same duration or a new one. It also provides access to the repeat counter which is useful for task that repeat itself often but behave different every time (spoken event dialogs for example).

Definition at line 48 of file TaskScheduler.h.

Member Typedef Documentation

◆ clock_t

typedef std::chrono::steady_clock TaskScheduler::clock_t

private

Definition at line 55 of file TaskScheduler.h.

◆ duration_t

typedef clock_t::duration TaskScheduler::duration_t

private

Definition at line 57 of file TaskScheduler.h.

◆ group_t

typedef uint32 TaskScheduler::group_t

private

Definition at line 60 of file TaskScheduler.h.

◆ predicate_t

typedef std::function<bool()> TaskScheduler::predicate_t

private

Definition at line 66 of file TaskScheduler.h.

◆ repeated_t

typedef uint32 TaskScheduler::repeated_t

private

Definition at line 62 of file TaskScheduler.h.

◆ success_t

typedef std::function<void()> TaskScheduler::success_t

private

Definition at line 68 of file TaskScheduler.h.

◆ task_handler_t

typedef TaskHandler TaskScheduler::task_handler_t

private

Definition at line 64 of file TaskScheduler.h.

◆ TaskContainer

typedef std::shared_ptr<Task> TaskScheduler::TaskContainer

private

Definition at line 155 of file TaskScheduler.h.

◆ timepoint_t

typedef clock_t::time_point TaskScheduler::timepoint_t

private

Definition at line 56 of file TaskScheduler.h.

Constructor & Destructor Documentation

◆ TaskScheduler() [1/4]

TaskScheduler::TaskScheduler ( )

Definition at line 23 of file TaskScheduler.cpp.

◆ TaskScheduler() [2/4]

template<typename P >

TaskScheduler::TaskScheduler ( P && predicate )

inlineexplicit

Definition at line 215 of file TaskScheduler.h.

◆ TaskScheduler() [3/4]

TaskScheduler::TaskScheduler ( TaskScheduler const & )

delete

◆ TaskScheduler() [4/4]

TaskScheduler::TaskScheduler ( TaskScheduler && )

delete

◆ ~TaskScheduler()

TaskScheduler::~TaskScheduler ( )

default

Member Function Documentation

◆ Async()

TaskScheduler & TaskScheduler::Async ( std::function< void()> callable )

Schedule an callable function that is executed at the next update tick. Its safe to modify the TaskScheduler from within the callable.

Definition at line 80 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CancelAll()

TaskScheduler & TaskScheduler::CancelAll ( )

Cancels all tasks. Never call this from within a task context! Use TaskContext::CancelAll instead!

Clear the task holder

Definition at line 86 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CancelGroup()

TaskScheduler & TaskScheduler::CancelGroup ( group_t group )

Cancel all tasks of a single group. Never call this from within a task context! Use TaskContext::CancelGroup instead!

Definition at line 93 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CancelGroupsOf()

TaskScheduler & TaskScheduler::CancelGroupsOf ( std::span< group_t > groups )

Cancels all groups in the given std::span. Hint: Use std::initializer_list for this: "{1, 2, 3, 4}"

Definition at line 102 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ ClearValidator()

TaskScheduler & TaskScheduler::ClearValidator ( )

Clears the validator which is asked if tasks are allowed to be executed.

Definition at line 32 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DelayAll() [1/2]

TaskScheduler & TaskScheduler::DelayAll ( duration_t duration )

Delays all tasks with the given duration.

Definition at line 111 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DelayAll() [2/2]

TaskScheduler & TaskScheduler::DelayAll	(	std::chrono::milliseconds	min,
		std::chrono::milliseconds	max
	)

inline

Delays all tasks with a random duration between min and max.

Definition at line 312 of file TaskScheduler.h.

Here is the call graph for this function:

◆ DelayGroup() [1/2]

TaskScheduler & TaskScheduler::DelayGroup	(	group_t	group,
		duration_t	duration
	)

Delays all tasks of a group with the given duration.

Definition at line 121 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ DelayGroup() [2/2]

TaskScheduler & TaskScheduler::DelayGroup	(	group_t	group,
		std::chrono::milliseconds	min,
		std::chrono::milliseconds	max
	)

inline

Delays all tasks of a group with a random duration between min and max.

Definition at line 322 of file TaskScheduler.h.

Here is the call graph for this function:

◆ Dispatch()

void TaskScheduler::Dispatch ( success_t const & callback )

private

Dispatch remaining tasks.

Definition at line 186 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EmptyValidator()

static bool TaskScheduler::EmptyValidator ( )

inlinestaticprivate

Definition at line 206 of file TaskScheduler.h.

Here is the caller graph for this function:

◆ InsertTask() [1/2]

TaskScheduler & TaskScheduler::InsertTask ( TaskContainer && task )

private

Insert a new task to the enqueued tasks.

Definition at line 163 of file TaskScheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InsertTask() [2/2]

TaskScheduler & TaskScheduler::InsertTask ( TaskQueue::Container::node_type && node )

private

Insert a new task to the enqueued tasks.

Definition at line 169 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ operator=() [1/2]

TaskScheduler & TaskScheduler::operator= ( TaskScheduler && )

delete

◆ operator=() [2/2]

TaskScheduler & TaskScheduler::operator= ( TaskScheduler const & )

delete

◆ RescheduleAll() [1/2]

TaskScheduler & TaskScheduler::RescheduleAll ( duration_t duration )

Reschedule all tasks with a given duration.

Definition at line 136 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ RescheduleAll() [2/2]

TaskScheduler & TaskScheduler::RescheduleAll	(	std::chrono::milliseconds	min,
		std::chrono::milliseconds	max
	)

inline

Reschedule all tasks with a random duration between min and max.

Definition at line 333 of file TaskScheduler.h.

Here is the call graph for this function:

◆ RescheduleGroup() [1/2]

TaskScheduler & TaskScheduler::RescheduleGroup	(	group_t	group,
		duration_t	duration
	)

Reschedule all tasks of a group with the given duration.

Definition at line 147 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ RescheduleGroup() [2/2]

TaskScheduler & TaskScheduler::RescheduleGroup	(	group_t	group,
		std::chrono::milliseconds	min,
		std::chrono::milliseconds	max
	)

inline

Reschedule all tasks of a group with a random duration between min and max.

Definition at line 342 of file TaskScheduler.h.

Here is the call graph for this function:

◆ Schedule() [1/4]

TaskScheduler & TaskScheduler::Schedule	(	duration_t	time,
		group_t	group,
		task_handler_t	task
	)

inline

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::Schedule instead!

Definition at line 273 of file TaskScheduler.h.

◆ Schedule() [2/4]

TaskScheduler & TaskScheduler::Schedule	(	duration_t	time,
		task_handler_t	task
	)

inline

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::Schedule instead!

Definition at line 265 of file TaskScheduler.h.

◆ Schedule() [3/4]

TaskScheduler & TaskScheduler::Schedule	(	std::chrono::milliseconds	min,
		std::chrono::milliseconds	max,
		group_t	group,
		task_handler_t	task
	)

inline

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::Schedule instead!

Definition at line 289 of file TaskScheduler.h.

Here is the call graph for this function:

◆ Schedule() [4/4]

TaskScheduler & TaskScheduler::Schedule	(	std::chrono::milliseconds	min,
		std::chrono::milliseconds	max,
		task_handler_t	task
	)

inline

Schedule an event with a randomized rate between min and max rate. Never call this from within a task context! Use TaskContext::Schedule instead!

Definition at line 281 of file TaskScheduler.h.

Here is the call graph for this function:

◆ ScheduleAt() [1/2]

TaskScheduler & TaskScheduler::ScheduleAt	(	timepoint_t	end,
		duration_t	time,
		group_t	group,
		task_handler_t	task
	)

private

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::schedule instead!

Definition at line 180 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ ScheduleAt() [2/2]

TaskScheduler & TaskScheduler::ScheduleAt	(	timepoint_t	end,
		duration_t	time,
		task_handler_t	task
	)

private

Definition at line 175 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ SetValidator()

template<typename P >

TaskScheduler & TaskScheduler::SetValidator ( P && predicate )

inline

Sets a validator which is asked if tasks are allowed to be executed.

Definition at line 227 of file TaskScheduler.h.

Here is the caller graph for this function:

◆ Update() [1/6]

TaskScheduler & TaskScheduler::Update ( )

Update the scheduler to the current time.

Definition at line 38 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ Update() [2/6]

TaskScheduler & TaskScheduler::Update ( duration_t difftime )

Update the scheduler with a difftime.

Definition at line 66 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ Update() [3/6]

TaskScheduler & TaskScheduler::Update	(	duration_t	difftime,
		success_t	callback
	)

Update the scheduler with a difftime. Calls the optional callback on successfully finish.

Definition at line 73 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ Update() [4/6]

TaskScheduler & TaskScheduler::Update ( size_t milliseconds )

Update the scheduler with a difftime in ms.

Definition at line 52 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ Update() [5/6]

TaskScheduler & TaskScheduler::Update	(	size_t	milliseconds,
		success_t	callback
	)

Update the scheduler with a difftime in ms. Calls the optional callback on successfully finish.

Definition at line 59 of file TaskScheduler.cpp.

Here is the call graph for this function:

◆ Update() [6/6]

TaskScheduler & TaskScheduler::Update ( success_t callback )

Update the scheduler to the current time. Calls the optional callback on successfully finish.

Definition at line 45 of file TaskScheduler.cpp.

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ TaskContext

friend class TaskContext

friend

Definition at line 50 of file TaskScheduler.h.

Member Data Documentation

◆ _now

timepoint_t TaskScheduler::_now

private

The current time point (now)

Definition at line 199 of file TaskScheduler.h.

◆ _predicate

predicate_t TaskScheduler::_predicate

private

Definition at line 204 of file TaskScheduler.h.

◆ _task_holder

TaskQueue TaskScheduler::_task_holder

private

The Task Queue which contains all task objects.

Definition at line 202 of file TaskScheduler.h.

◆ EmptySuccessCallback

TaskScheduler::success_t const TaskScheduler::EmptySuccessCallback

static

Definition at line 236 of file TaskScheduler.h.

◆ self_reference

std::shared_ptr<TaskScheduler> TaskScheduler::self_reference

private

Contains a self reference to track if this object was deleted or not.

Definition at line 196 of file TaskScheduler.h.

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

common/Utilities/TaskScheduler.h
common/Utilities/TaskScheduler.cpp

Classes

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ clock_t

◆ duration_t

◆ group_t

◆ predicate_t

◆ repeated_t

◆ success_t

◆ task_handler_t

◆ TaskContainer

◆ timepoint_t

Constructor & Destructor Documentation

◆ TaskScheduler() [1/4]

◆ TaskScheduler() [2/4]

◆ TaskScheduler() [3/4]

◆ TaskScheduler() [4/4]

◆ ~TaskScheduler()

Member Function Documentation

◆ Async()

◆ CancelAll()

◆ CancelGroup()

◆ CancelGroupsOf()

◆ ClearValidator()

◆ DelayAll() [1/2]

◆ DelayAll() [2/2]

◆ DelayGroup() [1/2]

◆ DelayGroup() [2/2]

◆ Dispatch()

◆ EmptyValidator()

◆ InsertTask() [1/2]

◆ InsertTask() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RescheduleAll() [1/2]

◆ RescheduleAll() [2/2]

◆ RescheduleGroup() [1/2]

◆ RescheduleGroup() [2/2]

◆ Schedule() [1/4]

◆ Schedule() [2/4]

◆ Schedule() [3/4]

◆ Schedule() [4/4]

◆ ScheduleAt() [1/2]

◆ ScheduleAt() [2/2]

◆ SetValidator()

◆ Update() [1/6]

◆ Update() [2/6]

◆ Update() [3/6]

◆ Update() [4/6]

◆ Update() [5/6]

◆ Update() [6/6]

Friends And Related Symbol Documentation

◆ TaskContext

Member Data Documentation

◆ _now

◆ _predicate

◆ _task_holder

◆ EmptySuccessCallback

◆ self_reference