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

Wait object. More...

#include <stk_common.h>

Inheritance diagram for stk::IWaitObject:
Collaboration diagram for stk::IWaitObject:

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).

Detailed Description

Wait object.

Definition at line 542 of file stk_common.h.

Member Typedef Documentation

◆ DLEntryType

typedef DListEntry<IWaitObject, TClosedLoop> stk::detail::DListEntry< IWaitObject, TClosedLoop >::DLEntryType
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.

◆ DLHeadType

typedef DListHead<IWaitObject, TClosedLoop> stk::detail::DListEntry< IWaitObject, TClosedLoop >::DLHeadType
inherited

Convenience alias for the corresponding list head type.

Definition at line 80 of file stk_linked_list.h.

◆ ListEntryType

List entry type of IWaitObject elements.

Definition at line 553 of file stk_common.h.

◆ ListHeadType

List head type for IWaitObject elements.

Definition at line 548 of file stk_common.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

A tag for type-safe casts done by CastListEntryToParent.

See also
CastListEntryToParent.

Definition at line 70 of file stk_linked_list.h.

70{ DLEntryTag = 1 };
Intrusive doubly-linked list node. Embed this as a base class in any object (T) that needs to partici...

◆ EState

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.

559 {
560 STATE_NONE = 0U,
561 STATE_WAIT,
565 };
@ STATE_CANCELLED
Wait was cancelled via Cancel() rather than Wake()/timeout.
Definition stk_common.h:564
@ STATE_TIMEOUT
Wait expired due to timeout rather than a Wake() signal.
Definition stk_common.h:563
@ STATE_SIGNALED
Wake signaled.
Definition stk_common.h:562
@ STATE_NONE
Not waiting, no result pending.
Definition stk_common.h:560
@ STATE_WAIT
Wait is active.
Definition stk_common.h:561

Constructor & Destructor Documentation

◆ ~IWaitObject()

stk::IWaitObject::~IWaitObject ( )
protecteddefault

Destructor.

Note
Protected by design. Prevents unsafe polymorphic delete.

Member Function Documentation

◆ GetHead()

DLHeadType * stk::detail::DListEntry< IWaitObject, TClosedLoop >::GetHead ( )
inlineinherited

Get the list head this entry currently belongs to.

Returns
Pointer to the owning DListHead, or NULL if the entry is not linked.

Definition at line 85 of file stk_linked_list.h.

85{ return m_head; }

◆ GetNext()

DLEntryType * stk::detail::DListEntry< IWaitObject, TClosedLoop >::GetNext ( )
inlineinherited

Get the next entry in the list.

Returns
Next entry. In an open 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.

96{ return m_next; }

◆ GetPrev()

DLEntryType * stk::detail::DListEntry< IWaitObject, TClosedLoop >::GetPrev ( )
inlineinherited

Get the previous entry in the list.

Returns
Previous entry. In an open 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.

106{ return m_prev; }

◆ GetState()

virtual EState stk::IWaitObject::GetState ( ) const
pure virtual

Get current state.

Returns
State value.
See also
EState

Implemented in stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::WaitObject.

Referenced by stk::sync::Event::RemoveWaitObject().

Here is the caller graph for this function:

◆ GetTid()

virtual TId stk::IWaitObject::GetTid ( ) const
pure virtual

Get thread Id of the task that owns this wait object.

Returns
Thread Id.

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().

Here is the caller graph for this function:

◆ IsLinked()

bool stk::detail::DListEntry< IWaitObject, TClosedLoop >::IsLinked ( ) const
inlineinherited

Check whether this entry is currently a member of any list.

Returns
true if linked (m_head != NULL); false otherwise.

Definition at line 115 of file stk_linked_list.h.

115{ return (GetHead() != nullptr); }

◆ Link()

void stk::detail::DListEntry< IWaitObject, TClosedLoop >::Link ( DLHeadType * head,
DLEntryType * next,
DLEntryType * prev )
inlineprivateinherited

Wire this entry into a list between prev and next.

Parameters
[in]headThe owning DListHead. Stored as a back-pointer for IsLinked() and ownership checks.
[in]nextThe entry that will follow this one, or NULL if this becomes the last entry.
[in]prevThe entry that will precede this one, or NULL if this becomes the first entry.
Note
Called exclusively by DListHead::Link(). Assumes the entry is not currently linked. Updates the neighbours' forward/back pointers to splice this entry in.

Definition at line 150 of file stk_linked_list.h.

151 {
152 m_head = head;
153 m_next = next;
154 m_prev = prev;
155
156 if (m_prev != nullptr)
157 {
158 m_prev->m_next = this;
159 }
160
161 if (m_next != nullptr)
162 {
163 m_next->m_prev = this;
164 }
165 }
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).

◆ operator const IWaitObject *()

stk::detail::DListEntry< IWaitObject, TClosedLoop >::operator const IWaitObject * ( ) const
inlineinherited

Implicit conversion to a const pointer to the host object (T).

Note
Safe because T must derive from DListEntry<T, TClosedLoop>. Eliminates the need for explicit static_cast at call sites.
MISRA deviation: [STK-DEV-004] Rule 5-2-x.

Definition at line 129 of file stk_linked_list.h.

129{ return static_cast<const T *>(this); }

◆ operator IWaitObject *()

stk::detail::DListEntry< IWaitObject, TClosedLoop >::operator IWaitObject* ( )
inlineinherited

Implicit conversion to a mutable pointer to the host object (T).

Note
Safe because T must derive from DListEntry<T, TClosedLoop>. Eliminates the need for explicit static_cast at call sites.
MISRA deviation: [STK-DEV-004] Rule 5-2-x.

Definition at line 122 of file stk_linked_list.h.

122{ return static_cast<T *>(this); }

◆ Tick()

virtual bool stk::IWaitObject::Tick ( Timeout elapsed_ticks)
pure virtual

Update wait object's waiting time.

Parameters
[in]elapsed_ticksNumber 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.
Returns
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().

Here is the caller graph for this function:

◆ Unlink()

void stk::detail::DListEntry< IWaitObject, TClosedLoop >::Unlink ( )
inlineprivateinherited

Remove this entry from its current list.

Note
Called exclusively by DListHead::Unlink(). Patches the neighbours' pointers to bridge over this entry, then clears m_head, m_next, and m_prev to NULL so the entry is in a clean unlinked state.
Does not update DListHead::m_count or m_first / m_last — those are the responsibility of the calling DListHead::Unlink().

Definition at line 174 of file stk_linked_list.h.

175 {
176 if (m_prev != nullptr)
177 {
179 }
180
181 if (m_next != nullptr)
182 {
184 }
185
186 m_head = nullptr;
187 m_next = nullptr;
188 m_prev = nullptr;
189 }

◆ Wake()

virtual void stk::IWaitObject::Wake ( bool timeout)
pure virtual

Wake task.

Parameters
[in]timeouttrue if the task is waking due to timeout expiry; false if waking due to a successful signal.
Note
The implementation is responsible for removing this wait object from the synchronization object's wait list (via ISyncObject::RemoveWaitObject) as part of the wake sequence.

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().

Here is the caller graph for this function:

Member Data Documentation

◆ m_head

DLHeadType* stk::detail::DListEntry< IWaitObject, TClosedLoop >::m_head
privateinherited

Owning list head, or NULL when the entry is not linked.

Definition at line 191 of file stk_linked_list.h.

◆ m_next

DLEntryType* stk::detail::DListEntry< IWaitObject, TClosedLoop >::m_next
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.

◆ m_prev

DLEntryType* stk::detail::DListEntry< IWaitObject, TClosedLoop >::m_prev
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.


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