os::utils::static_double_list Class Reference

Statically allocated circular double linked list of nodes. More...

#include <cmsis-plus/utils/lists.h>

Inheritance diagram for os::utils::static_double_list:

Public Member Functions
Constructors & Destructor
	static_double_list ()
	Construct a list.
	~static_double_list ()
	Destruct the list.
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 *	head (void) const
	Get the list head.
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

Statically allocated circular double linked list of nodes.

This is the simplest list, used as base class for scheduler lists that must be available for any statically constructed thread while still avoiding the 'static initialisation order fiasco'.

The idea is to design the object in such a way as to benefit from the standard BSS initialisation, in other words take nullptr as starting values.

This has the downside of requiring additional tests before adding new nodes to the list, to create the initial self links, and when checking if the list is empty.

Definition at line 349 of file lists.h.

Constructor & Destructor Documentation

static_double_list()

os::utils::static_double_list::static_double_list ( )

inline

Construct a list.

The initial list status is empty by having the pointers null.

Definition at line 1005 of file lists.h.

~static_double_list()

os::utils::static_double_list::~static_double_list ( )

inline

Destruct the list.

There must be no nodes in the list.

Definition at line 1016 of file lists.h.

Member Function Documentation

clear()

void os::utils::static_double_list::clear

(

void

)

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

inline

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 1028 of file lists.h.

head()

volatile static_double_list_links * os::utils::static_double_list::head ( void  ) const

inline

Get the list head.

Parameters

None.

Returns

Pointer to head node.

Definition at line 1035 of file lists.h.

insert_after()

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

protected

Insert a new node after existing node.

Parameters

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

Returns

Nothing.

Definition at line 118 of file lists.cpp.

tail()

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

inline

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

inline

Check if the list is uninitialised.

Parameters

None.

Return values

true	The list was not initialised.
false	The 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_

protected

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:

• lists.h
• lists.cpp