µOS++ IIIe Reference 7.0.0
The third edition of µOS++, a POSIX inspired open source framework, written in C++
Loading...
Searching...
No Matches
os::rtos::internal::clock_timestamps_list Class Reference

Ordered list of time stamp nodes. More...

#include <os-lists.h>

+ Inheritance diagram for os::rtos::internal::clock_timestamps_list:

Public Member Functions

Constructors & Destructor
 clock_timestamps_list ()
 Construct a list of clock time stamps.
 
 ~clock_timestamps_list ()
 Destruct the list.
 
Public Member Functions
void link (timestamp_node &node)
 Add a new thread node to the list.
 
volatile timestamp_nodehead (void) const
 Get list head.
 
void check_timestamp (port::clock::timestamp_t now)
 Check list time stamps.
 
Public Member Functions
bool uninitialized (void) const
 Check if the list is uninitialised.
 
void clear (void)
 Clear the list.
 
bool empty (void) const
 Check if the list is empty.
 
volatile static_double_list_links * tail (void) const
 Get the list tail.
 

Protected Member Functions

Private Member Functions
void insert_after (static_double_list_links &node, static_double_list_links *after)
 Insert a new node after existing node.
 

Protected Attributes

Private Member Variables
static_double_list_links head_
 A list node used to point to head and tail.
 

Detailed Description

Ordered list of time stamp nodes.

Definition at line 670 of file os-lists.h.

Constructor & Destructor Documentation

◆ clock_timestamps_list()

os::rtos::internal::clock_timestamps_list::clock_timestamps_list ( )
inline

Construct a list of clock time stamps.

Definition at line 968 of file os-lists.h.

◆ ~clock_timestamps_list()

os::rtos::internal::clock_timestamps_list::~clock_timestamps_list ( )
inline

Destruct the list.

Definition at line 973 of file os-lists.h.

Member Function Documentation

◆ check_timestamp()

void os::rtos::internal::clock_timestamps_list::check_timestamp ( port::clock::timestamp_t  now)

Check list time stamps.

Parameters
[in]nowThe current clock time stamp.
Returns
Nothing.

With the list ordered, check if the list head time stamp was reached and run the node action.

Repeat for all nodes that have overdue time stamps.

Definition at line 490 of file os-lists.cpp.

◆ clear()

void os::utils::static_double_list::clear ( void  )
inherited

Clear the list.

Parameters
None.
Returns
Nothing.

Initialise the mandatory node with links to itself.

Definition at line 105 of file lists.cpp.

◆ empty()

bool os::utils::static_double_list::empty ( void  ) const
inlineinherited

Check if the list is empty.

Parameters
None.
Return values
trueThe list has no nodes.
falseThe list has at least one node.

Definition at line 1028 of file lists.h.

◆ head()

volatile timestamp_node * os::rtos::internal::clock_timestamps_list::head ( void  ) const
inline

Get list head.

Parameters
None.
Returns
Casted pointer to head node.

Definition at line 978 of file os-lists.h.

◆ insert_after()

void os::utils::static_double_list::insert_after ( static_double_list_links node,
static_double_list_links after 
)
protectedinherited

Insert a new node after existing node.

Parameters
nodeReference to node to insert.
afterReference to existing node.
Returns
Nothing.

Definition at line 118 of file lists.cpp.

◆ link()

void os::rtos::internal::clock_timestamps_list::link ( timestamp_node node)

Add a new thread node to the list.

Parameters
[in]nodeReference to a list node.
Returns
Nothing.

The list is kept in ascending time stamp order.

Based on time stamp, the node is inserted

  • at the end of the list,
  • at the beginning of the list,
  • in the middle of the list, which requires a partial list traversal (done from the end).

To satisfy the circular double linked list requirements, an empty list still contains the head node with references to itself.

Definition at line 414 of file os-lists.cpp.

◆ tail()

volatile static_double_list_links * os::utils::static_double_list::tail ( void  ) const
inlineinherited

Get the list tail.

Parameters
None.
Returns
Pointer to tail node.

Definition at line 1041 of file lists.h.

◆ uninitialized()

bool os::utils::static_double_list::uninitialized ( void  ) const
inlineinherited

Check if the list is uninitialised.

Parameters
None.
Return values
trueThe list was not initialised.
falseThe list was initialised.

Definition at line 1021 of file lists.h.

Member Data Documentation

◆ head_

static_double_list_links os::utils::static_double_list::head_
protectedinherited

A list node used to point to head and tail.

To simplify processing, the list always has a node.

Definition at line 482 of file lists.h.


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