|
SuperTinyKernel™ RTOS 1.08.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
|
Wait object. More...
#include <stk_common.h>
Public Types | |
| enum | EState : uint8_t { STATE_NONE = 0U , STATE_WAIT , STATE_SIGNALED , STATE_TIMEOUT , STATE_CANCELLED } |
| State of the WaitObject. More... | |
| typedef DLHeadType | ListHeadType |
| List head type for IWaitObject elements. | |
| typedef DLEntryType | ListEntryType |
| List entry type of IWaitObject elements. | |
| enum | |
| A tag for type-safe casts done by CastListEntryToParent. More... | |
| typedef DListEntry< IWaitObject, TClosedLoop > | DLEntryType |
| Convenience alias for this entry type. Used to avoid repeating the full template spelling. | |
| typedef DListHead< IWaitObject, TClosedLoop > | DLHeadType |
| Convenience alias for the corresponding list head type. | |
Public Member Functions | |
| virtual TId | GetTid () const =0 |
| Get thread Id of the task that owns this wait object. | |
| virtual void | Wake (bool timeout)=0 |
| Wake task. | |
| virtual EState | GetState () const =0 |
| Get current state. | |
| virtual bool | Tick (Timeout elapsed_ticks)=0 |
| Update wait object's waiting time. | |
| DLHeadType * | GetHead () |
| Get the list head this entry currently belongs to. | |
| DLEntryType * | GetNext () |
| Get the next entry in the list. | |
| DLEntryType * | GetPrev () |
| Get the previous entry in the list. | |
| bool | IsLinked () const |
| Check whether this entry is currently a member of any list. | |
| operator IWaitObject * () | |
| Implicit conversion to a mutable pointer to the host object (T). | |
| operator const IWaitObject * () const | |
| Implicit conversion to a const pointer to the host object (T). | |
Protected Member Functions | |
| ~IWaitObject ()=default | |
| Destructor. | |
Private Member Functions | |
| void | Link (DLHeadType *head, DLEntryType *next, DLEntryType *prev) |
| Wire this entry into a list between prev and next. | |
| void | Unlink () |
| Remove this entry from its current list. | |
Private Attributes | |
| DLHeadType * | m_head |
Owning list head, or NULL when the entry is not linked. | |
| DLEntryType * | m_next |
Next entry in the list, or NULL (open list boundary) / first entry (closed loop). | |
| DLEntryType * | m_prev |
Previous entry in the list, or NULL (open list boundary) / last entry (closed loop). | |
Wait object.
Definition at line 542 of file stk_common.h.
|
inherited |
Convenience alias for this entry type. Used to avoid repeating the full template spelling.
Definition at line 75 of file stk_linked_list.h.
|
inherited |
Convenience alias for the corresponding list head type.
Definition at line 80 of file stk_linked_list.h.
List entry type of IWaitObject elements.
Definition at line 553 of file stk_common.h.
List head type for IWaitObject elements.
Definition at line 548 of file stk_common.h.
|
inherited |
A tag for type-safe casts done by CastListEntryToParent.
Definition at line 70 of file stk_linked_list.h.
| enum stk::IWaitObject::EState : uint8_t |
State of the WaitObject.
| Enumerator | |
|---|---|
| STATE_NONE | Not waiting, no result pending. |
| STATE_WAIT | Wait is active. |
| STATE_SIGNALED | Wake signaled. |
| STATE_TIMEOUT | Wait expired due to timeout rather than a Wake() signal. |
| STATE_CANCELLED | Wait was cancelled via Cancel() rather than Wake()/timeout. |
Definition at line 558 of file stk_common.h.
|
protecteddefault |
Destructor.
|
inlineinherited |
Get the list head this entry currently belongs to.
NULL if the entry is not linked. Definition at line 85 of file stk_linked_list.h.
|
inlineinherited |
Get the next entry in the list.
NULL for the last entry; in a closed loop the last entry wraps to the first one, so the result is never NULL for a linked entry. Definition at line 96 of file stk_linked_list.h.
|
inlineinherited |
Get the previous entry in the list.
NULL for the first entry; in a closed loop the first entry wraps to the last one, so the result is never NULL for a linked entry. Definition at line 106 of file stk_linked_list.h.
|
pure virtual |
Get current state.
Implemented in stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::WaitObject.
Referenced by stk::sync::Event::RemoveWaitObject().
|
pure virtual |
Get thread Id of the task that owns this wait object.
Implemented in stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::WaitObject.
Referenced by stk::ISyncObject::FindWeightHigherThan(), stk::ISyncObject::GetFirstWaiterTid(), stk::sync::FastMutex::Unlock(), and stk::sync::Mutex::Unlock().
|
inlineinherited |
Check whether this entry is currently a member of any list.
true if linked (m_head != NULL); false otherwise. Definition at line 115 of file stk_linked_list.h.
|
inlineprivateinherited |
Wire this entry into a list between prev and next.
| [in] | head | The owning DListHead. Stored as a back-pointer for IsLinked() and ownership checks. |
| [in] | next | The entry that will follow this one, or NULL if this becomes the last entry. |
| [in] | prev | The entry that will precede this one, or NULL if this becomes the first entry. |
Definition at line 150 of file stk_linked_list.h.
|
inlineinherited |
Implicit conversion to a const pointer to the host object (T).
Definition at line 129 of file stk_linked_list.h.
|
inlineinherited |
Implicit conversion to a mutable pointer to the host object (T).
Definition at line 122 of file stk_linked_list.h.
|
pure virtual |
Update wait object's waiting time.
| [in] | elapsed_ticks | Number of ticks elapsed between this and previous calls, in case of KERNEL_TICKLESS mode this value can be >1, for non-tickless mode it is always 1. |
true if the wait is still active, false if the timeout has just expired (the caller then wakes the task with Wake(true)). Implemented in stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::WaitObject.
Referenced by stk::ISyncObject::Tick().
|
inlineprivateinherited |
Remove this entry from its current list.
Definition at line 174 of file stk_linked_list.h.
|
pure virtual |
Wake task.
| [in] | timeout | true if the task is waking due to timeout expiry; false if waking due to a successful signal. |
Implemented in stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::WaitObject.
Referenced by stk::ISyncObject::Tick(), stk::sync::FastMutex::Unlock(), stk::sync::Mutex::Unlock(), and stk::ISyncObject::WakeOne().
|
privateinherited |
Owning list head, or NULL when the entry is not linked.
Definition at line 191 of file stk_linked_list.h.
|
privateinherited |
Next entry in the list, or NULL (open list boundary) / first entry (closed loop).
Definition at line 192 of file stk_linked_list.h.
|
privateinherited |
Previous entry in the list, or NULL (open list boundary) / last entry (closed loop).
Definition at line 193 of file stk_linked_list.h.