os::rtos::internal::ready_threads_list Class Reference

Priority ordered list of threads waiting too run. More...

#include <os-lists.h>

Inheritance diagram for os::rtos::internal::ready_threads_list:

Public Member Functions
Constructors & Destructor
	ready_threads_list ()
	Construct a list of waiting threads.
	~ready_threads_list ()
	Destruct the list.
Public Member Functions
void	link (waiting_thread_node &node)
	Add a new thread node to the list.
volatile waiting_thread_node *	head (void) const
	Get list head.
thread *	unlink_head (void)
	Remove the top node from 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 *	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

Priority ordered list of threads waiting too run.

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

Constructor & Destructor Documentation

ready_threads_list()

os::rtos::internal::ready_threads_list::ready_threads_list ( )

inline

Construct a list of waiting threads.

The initial list status is empty.

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

~ready_threads_list()

os::rtos::internal::ready_threads_list::~ready_threads_list ( )

inline

Destruct the list.

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

Member Function Documentation

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

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

Definition at line 1028 of file lists.h.

head()

volatile waiting_thread_node * os::rtos::internal::ready_threads_list::head ( void  ) const

inline

Get list head.

Parameters

None.

Returns

Casted pointer to head node.

Definition at line 916 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 118 of file lists.cpp.

link()

void os::rtos::internal::ready_threads_list::link

(

waiting_thread_node &

node

)

Add a new thread node to the list.

Parameters

[in]

node

Reference to a list node.

Returns

Nothing.

Definition at line 48 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

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

Definition at line 1021 of file lists.h.

unlink_head()

thread * os::rtos::internal::ready_threads_list::unlink_head

(

void

)

Remove the top node from the list.

Parameters

None.

Returns

Pointer to thread.

Must be called in a critical section.

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

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:

• os-lists.h
• os-lists.cpp