os::rtos::internal::timer_node Class Reference

Double linked list node, with time stamp and timer. More...

#include <os-lists.h>

Inheritance diagram for os::rtos::internal::timer_node:

Public Member Functions
Constructors & Destructor
	timer_node (port::clock::timestamp_t ts, timer &tm)
	Construct a clock timer node.
virtual	~timer_node () override
	Destruct the node.
Public Member Functions
virtual void	action (void) override
	Action to perform when the time stamp is reached.
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)

Public Attributes
Public Member Variables
timer &	tmr
	Reference to waiting timer.
Public Member Variables
port::clock::timestamp_t	timestamp
	Time stamp when the next action will be performed.

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

Constructor & Destructor Documentation

timer_node()

os::rtos::internal::timer_node::timer_node	(	port::clock::timestamp_t	ts,
		timer &	tm
	)

Parameters

[in]	ts	Time stamp.
[in]	tm	Reference to timer.

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

          : timestamp_node{ ts }, //
            tmr (tm)
      {
#if defined(OS_TRACE_RTOS_LISTS_CONSTRUCT)
        trace::printf ("%s() %p \n", __func__, this);
#endif
      }

References os::trace::printf().

~timer_node()

os::rtos::internal::timer_node::~timer_node ( )

overridevirtual

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

      {
#if defined(OS_TRACE_RTOS_LISTS_CONSTRUCT)
        trace::printf ("%s() %p \n", __func__, this);
#endif
      }

References os::trace::printf().

Member Function Documentation

action()

void os::rtos::internal::timer_node::action ( void  )

overridevirtual

Parameters

None.

Returns

Nothing.

Remove the node from the list and perform the timer actions.

Implements os::rtos::internal::timestamp_node.

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

      {
        this->unlink ();
        tmr.internal_interrupt_service_routine ();
      }

References tmr, and os::utils::static_double_list_links::unlink().

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(), 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 os::utils::double_list_links::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 os::utils::double_list_links::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().

timestamp

port::clock::timestamp_t os::rtos::internal::timestamp_node::timestamp

inherited

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

Referenced by os::rtos::internal::clock_timestamps_list::check_timestamp(), and os::rtos::internal::clock_timestamps_list::link().

tmr

timer& os::rtos::internal::timer_node::tmr

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

Referenced by action().

---

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

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