Sched module
OnceOnlyTrigger
Trigger that fires exactly once at the scheduled time and then expires.
OnceOnlyTrigger
#include <icy/sched/trigger.h>struct OnceOnlyTriggerDefined in src/sched/include/icy/sched/trigger.h:113
Inherits:
Trigger
Trigger that fires exactly once at the scheduled time and then expires.
List of all members
| Name | Kind | Owner |
|---|---|---|
OnceOnlyTrigger | function | Declared here |
update | function | Declared here |
expired | function | Declared here |
type | variable | Inherited from Trigger |
name | variable | Inherited from Trigger |
timesRun | variable | Inherited from Trigger |
createdAt | variable | Inherited from Trigger |
scheduleAt | variable | Inherited from Trigger |
lastRunAt | variable | Inherited from Trigger |
Trigger | function | Inherited from Trigger |
update | function | Inherited from Trigger |
remaining | function | Inherited from Trigger |
timeout | function | Inherited from Trigger |
expired | function | Inherited from Trigger |
serialize | function | Inherited from Trigger |
deserialize | function | Inherited from Trigger |
~ISerializable | function | Inherited from ISerializable |
serialize | function | Inherited from ISerializable |
deserialize | function | Inherited from ISerializable |
Inherited from Trigger
| Kind | Name | Description |
|---|---|---|
variable | type | The type of this trigger class. |
variable | name | The display name of this trigger class. |
variable | timesRun | The number of times the task has run since creation; |
variable | createdAt | The time the task was created. |
variable | scheduleAt | The time the task is scheduled to run. |
variable | lastRunAt | The time the task was last run. |
function | Trigger | |
function | update virtual | Updates the scheduleAt value to the next scheduled time. |
function | remaining virtual | Returns the milliseconds remaining until the next scheduled timeout. |
function | timeout virtual | Returns true if the task is ready to be run, false otherwise. |
function | expired virtual | Returns true if the task is expired and should be destroyed. Returns false by default. |
function | serialize virtual override | Serializes timing state (type, name, createdAt, scheduleAt, lastRunAt, timesRun) to root. |
function | deserialize virtual override | Deserializes timing state from root. |
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 Methods
| Return | Name | Description |
|---|---|---|
OnceOnlyTrigger | Constructs the trigger with type "OnceOnlyTrigger". | |
void | update virtual inline override | No-op; scheduleAt is set once at construction and never advanced. |
bool | expired virtual override | Returns true after the task has run at least once. |
OnceOnlyTrigger
OnceOnlyTrigger()Defined in src/sched/include/icy/sched/trigger.h:116
Constructs the trigger with type "OnceOnlyTrigger".
update
virtual inline override
virtual inline void update() overrideDefined in src/sched/include/icy/sched/trigger.h:119
No-op; scheduleAt is set once at construction and never advanced.
Reimplements
expired
virtual override
virtual bool expired() overrideDefined in src/sched/include/icy/sched/trigger.h:126
Returns true after the task has run at least once.
