json/actions/timer_based_actions.hpp

36  * @class TimerBasedActions - Action that wraps a list of actions with a timer
38  * Sets up a list of actions to be invoked when the defined timer expires.
39  * Once for a `oneshot` timer or at each expiration of a `repeating` timer.
57      * @brief Call actions when timer expires
67      * Starts or stops a timer that runs a list of actions whenever the
68      * timer expires. The configured timer is set to callback the list of
72      * the groups' service owned state is used to start/stop the timer. When any
73      * service providing a group member is not owned, the timer is started and
74      * if all members' services are owned, the timer is stopped.
77      * compared against all members within each group to start/stop the timer.
79      * cache, the timer is started and if any do not match, the timer is
87      * @brief Start the timer
89      * Starts the configured timer of this action if not already running
94      * @brief Stop the timer
96      * Stops the configured timer of this action if running
101      * @brief Timer expire's callback
103      * Called each time the timer expires, running the configured actions
108      * @brief Set the zones on the action and the timer's actions
110      * @param[in] zones - Zones for the action and timer's actions
112      * Sets the zones on this action and the timer's actions to run against
118     /* The timer for this action */
119     Timer _timer;
121     /* Whether timer triggered by groups' owner or property value states */
124     /* Timer interval for this action's timer */
127     /* Timer type for this action's timer */
130     /* List of actions to be called when the timer expires */
134      * @brief Parse and set the timer configuration
138      * Sets the timer configuration used to run the list of actions
147      * Sets the list of actions that is run when the timer expires