Sched module

sched

Deferred and periodic job scheduling primitives.

sched

Deferred and periodic job scheduling primitives.

Classes

NameDescription
SchedulerThe Scheduler manages and runs tasks that need to be executed at specific times.
TaskScheduled task with an attached trigger and scheduler association.
TaskFactoryThe TaskFactory can dynamically instantiate registered sched::Task and sched::Trigger classes from named strings.
DailyTriggerTrigger that fires once per day at a configured time, with optional day-of-week exclusions.
IntervalTriggerTrigger that fires repeatedly at a fixed time interval.
OnceOnlyTriggerTrigger that fires exactly once at the scheduled time and then expires.
TriggerBase class for scheduled task triggers that determine when a task should run.

Enumerations

NameDescription
DaysOfTheWeekDays of the week.
MonthOfTheYeayMonths of the year.

DaysOfTheWeek

enum DaysOfTheWeek

Days of the week.

ValueDescription
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

MonthOfTheYeay

enum MonthOfTheYeay

Months of the year.

ValueDescription
January
February
March
April
May
June
July
August
September
October
November
December

Typedefs

ReturnNameDescription
std::vector< sched::Task * >TaskListOrdered list of task pointers used by the scheduler.

TaskList

std::vector< sched::Task * > TaskList()

Ordered list of task pointers used by the scheduler.

Functions

ReturnNameDescription
std::unique_ptr< sched::Task >instantiateTaskInstantiate a registered Task subtype using its default constructor.
std::unique_ptr< sched::Trigger >instantiateTriggerInstantiate a registered Trigger subtype using its default constructor.

instantiateTask

template<typename T> std::unique_ptr< sched::Task > instantiateTask()

Instantiate a registered Task subtype using its default constructor.


instantiateTrigger

template<typename T> std::unique_ptr< sched::Trigger > instantiateTrigger()

Instantiate a registered Trigger subtype using its default constructor.