os::rtos::internal::clock_timestamps_list Class Reference

Ordered list of time stamp nodes. More...

#include <os-lists.h>

Inherits os::utils::double_list.

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

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

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

Detailed Description

Ordered list of time stamp nodes.

Definition at line 657 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 958 of file os-lists.h.

~clock_timestamps_list()

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

inline

Destruct the list.

Definition at line 964 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]

now

The 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 447 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 108 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

true	The list has no nodes.
false	The list has at least one node.

Definition at line 1032 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 970 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

node	Reference to node to insert.
after	Reference to existing node.

Returns

Nothing.

Definition at line 115 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]

node

Reference 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 384 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 1045 of file lists.h.

uninitialized()

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

inlineinherited

Check if the list is unitialised.

Parameters

None.

Return values

true	The list was not initialised.
false	The list was initialised.

Definition at line 1025 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 486 of file lists.h.

---

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

• include/cmsis-plus/rtos/internal/os-lists.h
• src/rtos/internal/os-lists.cpp