Trigger
Trigger
#include <icy/sched/trigger.h>struct TriggerDefined in src/sched/include/icy/sched/trigger.h:58
Inherits:
ISerializableSubclassed by:DailyTrigger,IntervalTrigger,OnceOnlyTrigger
Base class for scheduled task triggers that determine when a task should run.
List of all members
| Name | Kind | Owner |
|---|---|---|
type | variable | Declared here |
name | variable | Declared here |
timesRun | variable | Declared here |
createdAt | variable | Declared here |
scheduleAt | variable | Declared here |
lastRunAt | variable | Declared here |
Trigger | function | Declared here |
update | function | Declared here |
remaining | function | Declared here |
timeout | function | Declared here |
expired | function | Declared here |
serialize | function | Declared here |
deserialize | function | Declared here |
~ISerializable | function | Inherited from ISerializable |
serialize | function | Inherited from ISerializable |
deserialize | function | Inherited from ISerializable |
Inherited from ISerializable
| Kind | Name | Description |
|---|---|---|
function | ~ISerializable virtual | Defaulted destructor. |
function | serialize virtual | Serializes this object's state into root. |
function | deserialize virtual | Populates this object's state from root. |
Public Attributes
| Return | Name | Description |
|---|---|---|
std::string | type | The type of this trigger class. |
std::string | name | The display name of this trigger class. |
int | timesRun | The number of times the task has run since creation; |
DateTime | createdAt | The time the task was created. |
DateTime | scheduleAt | The time the task is scheduled to run. |
DateTime | lastRunAt | The time the task was last run. |
type
std::string typeDefined in src/sched/include/icy/sched/trigger.h:90
The type of this trigger class.
name
std::string nameDefined in src/sched/include/icy/sched/trigger.h:93
The display name of this trigger class.
timesRun
int timesRunDefined in src/sched/include/icy/sched/trigger.h:97
The number of times the task has run since creation;
createdAt
DateTime createdAtDefined in src/sched/include/icy/sched/trigger.h:100
The time the task was created.
scheduleAt
DateTime scheduleAtDefined in src/sched/include/icy/sched/trigger.h:103
The time the task is scheduled to run.
lastRunAt
DateTime lastRunAtDefined in src/sched/include/icy/sched/trigger.h:106
The time the task was last run.
Public Methods
| Return | Name | Description |
|---|---|---|
Trigger | ||
void | update virtual | Updates the scheduleAt value to the next scheduled time. |
std::int64_t | remaining virtual | Returns the milliseconds remaining until the next scheduled timeout. |
bool | timeout virtual | Returns true if the task is ready to be run, false otherwise. |
bool | expired virtual | Returns true if the task is expired and should be destroyed. Returns false by default. |
void | serialize virtual override | Serializes timing state (type, name, createdAt, scheduleAt, lastRunAt, timesRun) to root. |
void | deserialize virtual override | Deserializes timing state from root. |
Trigger
Trigger(const std::string & type = "", const std::string & name = "")Defined in src/sched/include/icy/sched/trigger.h:62
Parameters
typeRegistered type name used by TaskFactory.nameHuman-readable display name.
update
virtual
virtual void update()Defined in src/sched/include/icy/sched/trigger.h:66
Updates the scheduleAt value to the next scheduled time.
Reimplemented by
remaining
virtual
virtual std::int64_t remaining()Defined in src/sched/include/icy/sched/trigger.h:70
Returns the milliseconds remaining until the next scheduled timeout.
timeout
virtual
virtual bool timeout()Defined in src/sched/include/icy/sched/trigger.h:74
Returns true if the task is ready to be run, false otherwise.
expired
virtual
virtual bool expired()Defined in src/sched/include/icy/sched/trigger.h:79
Returns true if the task is expired and should be destroyed. Returns false by default.
Reimplemented by
serialize
virtual override
virtual void serialize(json::Value & root) overrideDefined in src/sched/include/icy/sched/trigger.h:83
Serializes timing state (type, name, createdAt, scheduleAt, lastRunAt, timesRun) to root.
Parameters
rootJSON object to populate.
Reimplements
Reimplemented by
deserialize
virtual override
virtual void deserialize(json::Value & root) overrideDefined in src/sched/include/icy/sched/trigger.h:87
Deserializes timing state from root.
Parameters
rootJSON object previously produced by serialize().
