os::estd::mutex Class Reference

#include <mutex>

Inheritance diagram for os::estd::mutex:

Public Types
using	native_handle_type = native_type *

Public Member Functions
	mutex () noexcept
	mutex (const mutex &)=delete
	~mutex ()=default
void	lock ()
native_handle_type	native_handle ()
mutex &	operator= (const mutex &)=delete
bool	try_lock ()
void	unlock ()

Protected Attributes
native_type	nm_

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

Detailed Description

Definition at line 58 of file mutex.

Member Typedef Documentation

native_handle_type

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

Definition at line 64 of file mutex.

native_type

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

private

Definition at line 61 of file mutex.

Constructor & Destructor Documentation

mutex() [1/2]

os::estd::mutex::mutex ( )

inlinenoexcept

Definition at line 182 of file mutex.

    {
    }

~mutex()

os::estd::mutex::~mutex ( )

default

mutex() [2/2]

os::estd::mutex::mutex ( const mutex &  )

delete

Member Function Documentation

lock()

void os::estd::mutex::lock

(

)

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(), nm_, and os::rtos::result::ok.

native_handle()

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

inline

Definition at line 187 of file mutex.

    {
      return &nm_;
    }

References nm_.

operator=()

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

delete

try_lock()

bool os::estd::mutex::try_lock

(

)

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(), nm_, os::rtos::result::ok, and os::rtos::mutex::try_lock().

unlock()

void os::estd::mutex::unlock

(

)

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(), nm_, os::rtos::result::ok, and os::rtos::mutex::unlock().

Member Data Documentation

nm_

native_type os::estd::mutex::nm_

protected

Definition at line 89 of file mutex.

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

---

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

• mutex
• mutex.cpp