os::estd::timed_mutex Class Reference

#include <mutex>

Inheritance diagram for os::estd::timed_mutex:

Public Types
using	native_handle_type = native_type *

Public Member Functions
	timed_mutex ()=default
	timed_mutex (const timed_mutex &)=delete
	~timed_mutex ()=default
void	lock ()
native_handle_type	native_handle ()
timed_mutex &	operator= (const timed_mutex &)=delete
bool	try_lock ()
template<typename Rep_T , typename Period_T >
bool	try_lock_for (const std::chrono::duration< Rep_T, Period_T > &rel_time)
template<typename Clock_T , typename Duration_T >
bool	try_lock_until (const std::chrono::time_point< Clock_T, Duration_T > &abs_time)
void	unlock ()

Protected Attributes
native_type	nm_

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

Detailed Description

Definition at line 129 of file mutex.

Member Typedef Documentation

native_handle_type

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

inherited

Definition at line 64 of file mutex.

native_type

using os::estd::mutex::native_type = os::rtos::mutex

privateinherited

Definition at line 61 of file mutex.

Constructor & Destructor Documentation

timed_mutex() [1/2]

os::estd::timed_mutex::timed_mutex ( )

default

~timed_mutex()

os::estd::timed_mutex::~timed_mutex ( )

default

timed_mutex() [2/2]

os::estd::timed_mutex::timed_mutex ( const timed_mutex &  )

delete

Member Function Documentation

lock()

void os::estd::mutex::lock ( )

inherited

Definition at line 29 of file mutex.cpp.

    {
      os::rtos::result_t res;
      res = nm_.lock ();
      if (res != os::rtos::result::ok)
        {
          os::estd::__throw_cmsis_error (static_cast<int> (res),
                                         "mutex lock failed");
        }
    }

References os::estd::__throw_cmsis_error(), os::rtos::mutex::lock(), os::estd::mutex::nm_, and os::rtos::result::ok.

native_handle()

mutex::native_handle_type os::estd::mutex::native_handle ( )

inlineinherited

Definition at line 187 of file mutex.

    {
      return &nm_;
    }

References os::estd::mutex::nm_.

operator=()

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

delete

try_lock()

bool os::estd::mutex::try_lock ( )

inherited

Definition at line 41 of file mutex.cpp.

    {
      os::rtos::result_t res;
      res = nm_.try_lock ();
      if (res == os::rtos::result::ok)
        {
          return true;
        }
      else if (res == EWOULDBLOCK)
        {
          return false;
        }
 
      os::estd::__throw_cmsis_error (static_cast<int> (res),
                                     "mutex try_lock failed");
      // return false;
    }

References os::estd::__throw_cmsis_error(), os::estd::mutex::nm_, os::rtos::result::ok, and os::rtos::mutex::try_lock().

try_lock_for()

template<typename Rep_T , typename Period_T >

bool os::estd::timed_mutex::try_lock_for

(

const std::chrono::duration< Rep_T, Period_T > &

rel_time

)

Definition at line 215 of file mutex.

    {
      using namespace std::chrono;
      os::rtos::clock::duration_t ticks = 0;
      if (rel_time > duration<Rep_T, Period_T>::zero ())
        {
          ticks = static_cast<os::rtos::clock::duration_t> (
              os::estd::chrono::ceil<os::estd::chrono::systicks> (rel_time)
                  .count ());
        }
 
      os::rtos::result_t res;
      res = nm_.timed_lock (ticks);
      if (res == os::rtos::result::ok)
        {
          return true;
        }
      else if (res == ETIMEDOUT)
        {
          return false;
        }
 
      os::estd::__throw_system_error (static_cast<int> (res),
                                      "timed_mutex try_lock failed");
      return false;
    }

References os::estd::__throw_system_error(), os::estd::mutex::nm_, os::rtos::result::ok, and os::rtos::mutex::timed_lock().

Referenced by try_lock_until().

try_lock_until()

template<typename Clock_T , typename Duration_T >

bool os::estd::timed_mutex::try_lock_until

(

const std::chrono::time_point< Clock_T, Duration_T > &

abs_time

)

Definition at line 245 of file mutex.

    {
      using clock = Clock_T;
 
      auto now = clock::now ();
      while (now < abs_time)
        {
          if (try_lock_for (abs_time - now))
            {
              return true;
            }
          now = clock::now ();
        }
 
      return false;
    }

References clock(), and try_lock_for().

unlock()

void os::estd::mutex::unlock ( )

inherited

Definition at line 60 of file mutex.cpp.

    {
      os::rtos::result_t res;
      res = nm_.unlock ();
      if (res != os::rtos::result::ok)
        {
          os::estd::__throw_cmsis_error (static_cast<int> (res),
                                         "mutex unlock failed");
        }
    }

References os::estd::__throw_cmsis_error(), os::estd::mutex::nm_, os::rtos::result::ok, and os::rtos::mutex::unlock().

Member Data Documentation

nm_

native_type os::estd::mutex::nm_

protectedinherited

Definition at line 89 of file mutex.

Referenced by os::estd::mutex::lock(), os::estd::mutex::native_handle(), os::estd::mutex::try_lock(), try_lock_for(), and os::estd::mutex::unlock().

---

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

• mutex