SuperTinyKernel™ RTOS 1.06.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
stk::IPlatform::IEventOverrider Class Reference

Interface for a platform event overrider. More...

#include <stk_common.h>

Inheritance diagram for stk::IPlatform::IEventOverrider:

Public Member Functions

virtual bool OnSleep (Timeout sleep_ticks)
 Called by the Kernel when it is entering a sleep mode.
virtual bool OnHardFault ()
 Called by Kernel when hard fault happens.

Detailed Description

Interface for a platform event overrider.

Note
Optional. Can be used to extend functionality of default IPlatform driver handlers from the user-space.

Definition at line 842 of file stk_common.h.

Member Function Documentation

◆ OnHardFault()

virtual bool stk::IPlatform::IEventOverrider::OnHardFault ( )
inlinevirtual

Called by Kernel when hard fault happens.

Note
Normally called by Kernel when one of the scheduled tasks missed its deadline (see stk::KERNEL_HRT, IPlatform::HardFault).
Returns
True if event is handled otherwise False to let driver handle it.

Reimplemented in EventOverrider.

Definition at line 854 of file stk_common.h.

854{ return false; }

◆ OnSleep()

virtual bool stk::IPlatform::IEventOverrider::OnSleep ( Timeout sleep_ticks)
inlinevirtual

Called by the Kernel when it is entering a sleep mode.

Returns
True if event is handled otherwise False to let driver handle it.

Reimplemented in EventOverrider.

Definition at line 848 of file stk_common.h.

848{ STK_UNUSED(sleep_ticks); return false; }
#define STK_UNUSED(X)
Explicitly marks a variable as unused to suppress compiler warnings.
Definition stk_defs.h:610

References STK_UNUSED.


The documentation for this class was generated from the following file: