phosphor-fan-presence/monitor/power_off_action.hpp

30  * the D-Bus call to do the power off, so it can be mocked
48      * @param[in] name - The action name.  Used for tracing.
49      * @param[in] powerInterface - The object used to invoke the power off.
50      * @param[in] powerOffFunc - A function to call right before the power
76      * The 'force' parameter is mainly for use when something else
80      * @param[in] force - If the cancel should be forced
82      * @return bool - If the cancel was allowed/successful
84     virtual bool cancel(bool force) = 0;
89      * @return const std::string& - The name
162      * @param[in] delay - The amount of time in seconds to wait before
164      * @param[in] powerInterface - The object to use to do the power off
165      * @param[in] func - A function to call right before the power
190      * @param[in] force - If the cancel should be forced or not
192      * @return bool - Always returns true
217         _powerIface->hardPowerOff();  in powerOff()
254      * @param[in] delay - The amount of time in seconds to wait before
256      * @param[in] powerInterface - The object to use to do the power off
257      * @param[in] func - A function to call right before the power
282      * @param[in] force - If the cancel should be forced or not
284      * @return bool - Always returns true
309         _powerIface->softPowerOff();  in powerOff()
331  * 1) On start, the service mode timer is started.  This timer can be
334  *   a) The thermal alert D-Bus property is set, this can be used as
352      * @param[in] serviceModeDelay - The service mode timeout.
353      * @param[in] meltdownDelay - The meltdown delay timeout.
354      * @param[in] powerInterface - The object to use to do the power off
355      * @param[in] func - A function to call right before the power
376      * @brief Starts the service mode timer.
381             std::format("Action {}: Starting service mode timer", name()));  in start()
387      * @brief Called when the service mode timer expires.
389      * Sets the thermal alert D-Bus property and starts the
395             "Action {}: Service mode timer expired, starting meltdown timer",  in serviceModeTimerExpired()
398         _powerIface->thermalAlert(true);  in serviceModeTimerExpired()
418         _powerIface->hardPowerOff();  in meltdownTimerExpired()
425      * The service mode timer can be canceled.  The meltdown
428      * @param[in] force - To force the cancel (like if the
431      * @return bool - If the cancel was successful
433     bool cancel(bool force) override  in cancel()  argument
442             if (force)  in cancel()
463      * @brief The number of seconds to wait after the service mode
469      * @brief The service mode timer.