roo_threads::doc::lock_guard< Mutex > Class Template Reference

#include <mutex_api.h>

Public Types
using	mutex_type = Mutex
	Type of wrapped mutex.

Public Member Functions
	lock_guard (mutex_type &mutex)
	Acquires mutex on construction.
	~lock_guard ()
	Releases mutex on destruction.

Detailed Description

template<typename Mutex>
class roo_threads::doc::lock_guard< Mutex >

Definition at line 33 of file mutex_api.h.

Member Typedef Documentation

mutex_type

template<typename Mutex >

using roo_threads::doc::lock_guard< Mutex >::mutex_type = Mutex

Type of wrapped mutex.

Definition at line 36 of file mutex_api.h.

Constructor & Destructor Documentation

lock_guard()

template<typename Mutex >

roo_threads::doc::lock_guard< Mutex >::lock_guard ( mutex_type &  mutex )

explicit

Acquires mutex on construction.

Parameters

mutex

mutex to lock.

~lock_guard()

template<typename Mutex >

roo_threads::doc::lock_guard< Mutex >::~lock_guard

(

)

Releases mutex on destruction.

---

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

• temp_repos/roo_threads/src/roo_threads/doc/mutex_api.h