Home
Sched module

OnceOnlyTrigger

Trigger that fires exactly once at the scheduled time and then expires.

OnceOnlyTrigger

#include <icy/sched/trigger.h>
struct OnceOnlyTrigger

Defined 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

NameKindOwner
OnceOnlyTriggerfunctionDeclared here
updatefunctionDeclared here
expiredfunctionDeclared here
typevariableInherited from Trigger
namevariableInherited from Trigger
timesRunvariableInherited from Trigger
createdAtvariableInherited from Trigger
scheduleAtvariableInherited from Trigger
lastRunAtvariableInherited from Trigger
TriggerfunctionInherited from Trigger
updatefunctionInherited from Trigger
remainingfunctionInherited from Trigger
timeoutfunctionInherited from Trigger
expiredfunctionInherited from Trigger
serializefunctionInherited from Trigger
deserializefunctionInherited from Trigger
~ISerializablefunctionInherited from ISerializable
serializefunctionInherited from ISerializable
deserializefunctionInherited from ISerializable

Inherited from Trigger

KindNameDescription
variabletypeThe type of this trigger class.
variablenameThe display name of this trigger class.
variabletimesRunThe number of times the task has run since creation;
variablecreatedAtThe time the task was created.
variablescheduleAtThe time the task is scheduled to run.
variablelastRunAtThe time the task was last run.
functionTrigger
functionupdate virtualUpdates the scheduleAt value to the next scheduled time.
functionremaining virtualReturns the milliseconds remaining until the next scheduled timeout.
functiontimeout virtualReturns true if the task is ready to be run, false otherwise.
functionexpired virtualReturns true if the task is expired and should be destroyed. Returns false by default.
functionserialize virtual overrideSerializes timing state (type, name, createdAt, scheduleAt, lastRunAt, timesRun) to root.
functiondeserialize virtual overrideDeserializes timing state from root.

Inherited from ISerializable

KindNameDescription
function~ISerializable virtualDefaulted destructor.
functionserialize virtualSerializes this object's state into root.
functiondeserialize virtualPopulates this object's state from root.

Public Methods

ReturnNameDescription
OnceOnlyTriggerConstructs the trigger with type "OnceOnlyTrigger".
voidupdate virtual inline overrideNo-op; scheduleAt is set once at construction and never advanced.
boolexpired virtual overrideReturns 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() override

Defined 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() override

Defined in src/sched/include/icy/sched/trigger.h:126

Returns true after the task has run at least once.

Reimplements