os::utils::double_list_links Class Reference

The core of a double linked list, pointers to next, previous. More...

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

Inheritance diagram for os::utils::double_list_links:

Public Member Functions
Constructors & Destructor
	double_list_links ()
	Construct a list node (explicitly set to nullptr).
	~double_list_links ()
	Destruct the node.
Public Member Functions
void	unlink (void)
	Remove the node from the list.
bool	unlinked (void)
	Check if the node is unlinked.
static_double_list_links *	next (void) const
void	next (static_double_list_links *n)
static_double_list_links *	prev (void) const
void	prev (static_double_list_links *n)

Protected Attributes
Private Member Variables
static_double_list_links *	prev_
	Pointer to previous node.
static_double_list_links *	next_
	Pointer to next node.

Detailed Description

Definition at line 152 of file lists.h.

Constructor & Destructor Documentation

double_list_links()

os::utils::double_list_links::double_list_links ( )

inline

Definition at line 860 of file lists.h.

    {
      prev_ = nullptr;
      next_ = nullptr;
    }

References os::utils::static_double_list_links::next_, and os::utils::static_double_list_links::prev_.

~double_list_links()

os::utils::double_list_links::~double_list_links ( )

inline

Definition at line 866 of file lists.h.

    {
    }

Member Function Documentation

next() [1/2]

void os::utils::static_double_list_links::next ( static_double_list_links *  n )

inlineinherited

Definition at line 847 of file lists.h.

    {
      next_ = n;
    }

References os::utils::static_double_list_links::next_.

next() [2/2]

static_double_list_links * os::utils::static_double_list_links::next ( void  ) const

inlineinherited

Definition at line 835 of file lists.h.

    {
      return next_;
    }

References os::utils::static_double_list_links::next_.

Referenced by os::rtos::internal::waiting_threads_list::begin(), os::rtos::internal::clock_timestamps_list::check_timestamp(), os::utils::static_double_list::clear(), os::utils::static_double_list::empty(), os::utils::static_double_list::head(), and os::utils::static_double_list::insert_after().

prev() [1/2]

void os::utils::static_double_list_links::prev ( static_double_list_links *  n )

inlineinherited

Definition at line 853 of file lists.h.

    {
      prev_ = n;
    }

References os::utils::static_double_list_links::prev_.

prev() [2/2]

static_double_list_links * os::utils::static_double_list_links::prev ( void  ) const

inlineinherited

Definition at line 841 of file lists.h.

    {
      return prev_;
    }

References os::utils::static_double_list_links::prev_.

Referenced by os::utils::static_double_list::clear(), os::utils::static_double_list::insert_after(), os::rtos::internal::clock_timestamps_list::link(), os::rtos::internal::ready_threads_list::link(), os::rtos::internal::waiting_threads_list::link(), os::rtos::internal::terminated_threads_list::link(), os::utils::static_double_list::tail(), and os::utils::static_double_list::uninitialized().

unlink()

void os::utils::static_double_list_links::unlink ( void  )

inherited

Returns

Nothing.

Update the neighbours to point to each other, skipping the node.

For more robustness, to prevent unexpected accesses, the links in the removed node are nullified.

Definition at line 59 of file lists.cpp.

    {
      // Check if not already unlinked.
      if (unlinked ())
        {
          assert (prev_ == nullptr);
#if defined(OS_TRACE_UTILS_LISTS)
          trace::printf ("%s() %p nop\n", __func__, this);
#endif
          return;
        }
 
#if defined(OS_TRACE_UTILS_LISTS)
      trace::printf ("%s() %p \n", __func__, this);
#endif
 
      // Make neighbours point to each other.
      prev_->next_ = next_;
      next_->prev_ = prev_;
 
      // Nullify both pointers in the unlinked node.
      prev_ = nullptr;
      next_ = nullptr;
    }

References os::utils::static_double_list_links::next_, os::utils::static_double_list_links::prev_, os::trace::printf(), and os::utils::static_double_list_links::unlinked().

Referenced by os::rtos::internal::timeout_thread_node::action(), os::rtos::internal::timer_node::action(), and os_rtos_idle_actions().

unlinked()

bool os::utils::static_double_list_links::unlinked ( void  )

inlineinherited

Return values

true	The node is not linked.
false	The node is linked to a list.

Definition at line 829 of file lists.h.

    {
      return (next_ == nullptr);
    }

References os::utils::static_double_list_links::next_.

Referenced by os::utils::static_double_list_links::unlink().

Member Data Documentation

next_

static_double_list_links* os::utils::static_double_list_links::next_

protectedinherited

Definition at line 137 of file lists.h.

Referenced by double_list_links(), os::utils::static_double_list_links::next(), os::utils::static_double_list_links::next(), os::utils::static_double_list_links::unlink(), and os::utils::static_double_list_links::unlinked().

prev_

static_double_list_links* os::utils::static_double_list_links::prev_

protectedinherited

Definition at line 132 of file lists.h.

Referenced by double_list_links(), os::utils::static_double_list_links::prev(), os::utils::static_double_list_links::prev(), and os::utils::static_double_list_links::unlink().

---

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

• lists.h