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::time::Timer::ReadyNode Struct Reference

Hook of a Timer in the ready list (expired timers waiting for a handler task). More...

Inheritance diagram for stk::time::Timer::ReadyNode:
Collaboration diagram for stk::time::Timer::ReadyNode:

Public Types

enum  
 A tag for type-safe casts done by CastListEntryToParent. More...
typedef DListEntry< ReadyNode, TClosedLoop > DLEntryType
 Convenience alias for this entry type. Used to avoid repeating the full template spelling.
typedef DListHead< ReadyNode, TClosedLoop > DLHeadType
 Convenience alias for the corresponding list head type.

Public Member Functions

 ReadyNode (Timer *owner)
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 ReadyNode * ()
 Implicit conversion to a mutable pointer to the host object (T).
 operator const ReadyNode * () const
 Implicit conversion to a const pointer to the host object (T).

Public Attributes

Timer *const timer
 the timer owning this node

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

Hook of a Timer in the ready list (expired timers waiting for a handler task).

It is a second, independent intrusive list hook of the Timer: the timer itself can stay in the list of active timers (periodic timer) while its node is in the ready list. A timer has exactly one node, so it can be queued for handling at most once and a command which cancels an expiration (stop, restart, ...) can unlink it in O(1).

Note
Linked/unlinked only inside a critical section. Invariant (task mode): the node is linked if and only if m_pending is true.

Definition at line 168 of file stk_time_timer.h.

Member Typedef Documentation

◆ DLEntryType

typedef DListEntry<ReadyNode, TClosedLoop> stk::detail::DListEntry< ReadyNode, 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<ReadyNode, TClosedLoop> stk::detail::DListEntry< ReadyNode, TClosedLoop >::DLHeadType
inherited

Convenience alias for the corresponding list head type.

Definition at line 80 of file stk_linked_list.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...

Constructor & Destructor Documentation

◆ ReadyNode()

stk::time::Timer::ReadyNode::ReadyNode ( Timer * owner)
inlineexplicit

Definition at line 170 of file stk_time_timer.h.

170 : timer(owner)
171 {}
Timer *const timer
the timer owning this node

References stk::time::Timer::Timer(), and timer.

Here is the call graph for this function:

Member Function Documentation

◆ GetHead()

DLHeadType * stk::detail::DListEntry< ReadyNode, 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< ReadyNode, 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< ReadyNode, 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; }

◆ IsLinked()

bool stk::detail::DListEntry< ReadyNode, 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< ReadyNode, 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 ReadyNode *()

stk::detail::DListEntry< ReadyNode, TClosedLoop >::operator const ReadyNode * ( ) 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 ReadyNode *()

stk::detail::DListEntry< ReadyNode, TClosedLoop >::operator ReadyNode* ( )
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); }

◆ Unlink()

void stk::detail::DListEntry< ReadyNode, 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 }

Member Data Documentation

◆ m_head

DLHeadType* stk::detail::DListEntry< ReadyNode, 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< ReadyNode, 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< ReadyNode, 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.

◆ timer

Timer* const stk::time::Timer::ReadyNode::timer

the timer owning this node

Definition at line 173 of file stk_time_timer.h.

Referenced by ReadyNode().


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