os::estd::condition_variable Class Reference

#include <condition_variable>

Public Types
using	native_handle_type = native_type *

Public Member Functions
	condition_variable ()
	condition_variable (const condition_variable &)=delete
	~condition_variable ()
native_handle_type	native_handle ()
void	notify_all () noexcept
void	notify_one () noexcept
condition_variable &	operator= (const condition_variable &)=delete
void	wait (std::unique_lock< mutex > &lock)
template<class Predicate_T >
void	wait (std::unique_lock< mutex > &lock, Predicate_T pred)
template<class Rep_T , class Period_T >
cv_status	wait_for (std::unique_lock< mutex > &lock, const std::chrono::duration< Rep_T, Period_T > &rel_time)
template<class Rep_T , class Period_T , class Predicate_T >
bool	wait_for (std::unique_lock< mutex > &lock, const std::chrono::duration< Rep_T, Period_T > &rel_time, Predicate_T pred)
template<class Clock_T , class Duration_T >
cv_status	wait_until (std::unique_lock< mutex > &lock, const std::chrono::time_point< Clock_T, Duration_T > &abs_time)
template<class Clock_T , class Duration_T , class Predicate_T >
bool	wait_until (std::unique_lock< mutex > &lock, const std::chrono::time_point< Clock_T, Duration_T > &abs_time, Predicate_T pred)

Protected Types
using	Native_clock = os::estd::chrono::systick_clock

Protected Attributes
native_type	ncv_

Private Types
using	native_type = os::rtos::condition_variable

Detailed Description

Definition at line 76 of file condition_variable.

Member Typedef Documentation

Native_clock

using os::estd::condition_variable::Native_clock = os::estd::chrono::systick_clock

protected

Definition at line 134 of file condition_variable.

native_handle_type

using os::estd::condition_variable::native_handle_type = native_type*

Definition at line 82 of file condition_variable.

native_type

using os::estd::condition_variable::native_type = os::rtos::condition_variable

private

Definition at line 79 of file condition_variable.

Constructor & Destructor Documentation

condition_variable() [1/2]

os::estd::condition_variable::condition_variable ( )

inline

Definition at line 205 of file condition_variable.

    {
    }

~condition_variable()

os::estd::condition_variable::~condition_variable ( )

inline

Definition at line 209 of file condition_variable.

    {
    }

condition_variable() [2/2]

os::estd::condition_variable::condition_variable ( const condition_variable &  )

delete

Member Function Documentation

native_handle()

native_handle_type os::estd::condition_variable::native_handle

(

)

notify_all()

void os::estd::condition_variable::notify_all ( )

noexcept

Definition at line 42 of file condition-variable.cpp.

    {
      os::rtos::result_t res;
      res = ncv_.broadcast ();
      if (res != os::rtos::result::ok)
        {
          os::estd::__throw_cmsis_error (
              static_cast<int> (res),
              "condition_variable::notify_all() failed");
        }
    }

References os::estd::__throw_cmsis_error(), os::rtos::condition_variable::broadcast(), ncv_, and os::rtos::result::ok.

Referenced by os::estd::condition_variable_any::notify_all().

notify_one()

void os::estd::condition_variable::notify_one ( )

noexcept

Definition at line 29 of file condition-variable.cpp.

    {
      os::rtos::result_t res;
      res = ncv_.signal ();
      if (res != os::rtos::result::ok)
        {
          os::estd::__throw_cmsis_error (
              static_cast<int> (res),
              "condition_variable::notify_one() failed");
        }
    }

References os::estd::__throw_cmsis_error(), ncv_, os::rtos::result::ok, and os::rtos::condition_variable::signal().

Referenced by os::estd::condition_variable_any::notify_one().

operator=()

condition_variable & os::estd::condition_variable::operator= ( const condition_variable &  )

delete

wait() [1/2]

void os::estd::condition_variable::wait

(

std::unique_lock< mutex > &

lock

)

Definition at line 55 of file condition-variable.cpp.

    {
      if (!lk.owns_lock ())
        {
          os::estd::__throw_system_error (
              EPERM, "condition_variable::wait: mutex not locked");
        }
      os::rtos::result_t res = ncv_.wait ((*(lk.mutex ()->native_handle ())));
      if (res != os::rtos::result::ok)
        {
          os::estd::__throw_cmsis_error (static_cast<int> (res),
                                         "condition_variable wait failed");
        }
    }

References os::estd::__throw_cmsis_error(), os::estd::__throw_system_error(), ncv_, os::rtos::result::ok, and os::rtos::condition_variable::wait().

Referenced by os::estd::condition_variable_any::wait(), and wait().

wait() [2/2]

template<class Predicate_T >

void os::estd::condition_variable::wait	(	std::unique_lock< mutex > &	lock,
		Predicate_T	pred
	)

Definition at line 215 of file condition_variable.

    {
      while (!pred ())
        wait (lock);
    }

References wait().

wait_for() [1/2]

template<class Rep_T , class Period_T >

cv_status os::estd::condition_variable::wait_for	(	std::unique_lock< mutex > &	lock,
		const std::chrono::duration< Rep_T, Period_T > &	rel_time
	)

Definition at line 276 of file condition_variable.

    {
      using namespace std::chrono;
 
      if (rel_time <= rel_time.zero ())
        {
          return cv_status::timeout;
        }
 
      Native_clock::time_point start_tp = Native_clock::now ();
 
      os::rtos::clock::duration_t ticks
          = os::estd::chrono::ceil<std::chrono::duration<
              os::rtos::clock::duration_t, typename Native_clock::period>> (
                rel_time)
                .count ();
 
      ncv_.timed_wait (
          /*(rtos::mutex &)*/ (*(lock.mutex ()->native_handle ())), ticks);
 
      return (Native_clock::now () - start_tp) < rel_time
                 ? cv_status::no_timeout
                 : cv_status::timeout;
    }

References os::estd::chrono::ceil(), ncv_, os::estd::no_timeout, os::estd::chrono::systick_clock::now(), os::rtos::condition_variable::timed_wait(), and os::estd::timeout.

Referenced by wait_until().

wait_for() [2/2]

template<class Rep_T , class Period_T , class Predicate_T >

bool os::estd::condition_variable::wait_for ( std::unique_lock< mutex > &  lock, const std::chrono::duration< Rep_T, Period_T > &  rel_time, Predicate_T  pred  )

inline

Definition at line 305 of file condition_variable.

    {
      return wait_until (lock, Native_clock::now () + rel_time,
                         std::move (pred));
    }

References os::estd::chrono::systick_clock::now(), and wait_until().

wait_until() [1/2]

template<class Clock_T , class Duration_T >

cv_status os::estd::condition_variable::wait_until	(	std::unique_lock< mutex > &	lock,
		const std::chrono::time_point< Clock_T, Duration_T > &	abs_time
	)

Definition at line 229 of file condition_variable.

    {
      using namespace std::chrono;
      using clock = Clock_T;
 
#if 0
        wait_for (lock, abs_time - Clock_T::now ());
        return
        Clock_T::now () < abs_time ?
        cv_status::no_timeout : cv_status::timeout;
#else
      // Optimise to native (ticks). LLVM compares using the
      // original clock, which might be more accurate.
      Native_clock::duration rel_time
          = std::chrono::duration_cast<Native_clock::duration> (
              abs_time - clock::now ());
      return wait_for (lock, rel_time);
#endif
    }

References clock(), os::estd::no_timeout, os::estd::timeout, and wait_for().

Referenced by wait_for(), os::estd::condition_variable_any::wait_until(), and wait_until().

wait_until() [2/2]

template<class Clock_T , class Duration_T , class Predicate_T >

bool os::estd::condition_variable::wait_until	(	std::unique_lock< mutex > &	lock,
		const std::chrono::time_point< Clock_T, Duration_T > &	abs_time,
		Predicate_T	pred
	)

Definition at line 255 of file condition_variable.

    {
      while (!pred ())
        {
          if (wait_until (lock, abs_time) == cv_status::timeout)
            return pred ();
        }
      return true;
    }

References os::estd::timeout, and wait_until().

Member Data Documentation

ncv_

native_type os::estd::condition_variable::ncv_

protected

Definition at line 133 of file condition_variable.

Referenced by notify_all(), notify_one(), wait(), and wait_for().

---

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

• condition_variable
• condition-variable.cpp