std::detail::shared_mutex_cv Class Reference

A shared mutex type implemented using std::condition_variable. More...

#include <shared_mutex.h>

Public Member Functions
	shared_mutex_cv (const shared_mutex_cv &)=delete
shared_mutex_cv &	operator= (const shared_mutex_cv &)=delete
void	lock ()
	Takes ownership of the associated mutex.
bool	try_lock ()
	Tries to take ownership of the mutex without blocking.
void	unlock ()
	Releases the ownership of the mutex from the calling thread.
void	lock_shared ()
	Blocks the calling thread until the thread obtains shared ownership of the mutex.
bool	try_lock_shared ()
	Tries to take shared ownership of the mutex without blocking.
void	unlock_shared ()
	Releases the shared ownership of the mutex from the calling thread.

Detailed Description

A shared mutex type implemented using std::condition_variable.

Member Function Documentation

lock()

void std::detail::shared_mutex_cv::lock ( )

inline

Takes ownership of the associated mutex.

lock_shared()

void std::detail::shared_mutex_cv::lock_shared ( )

inline

Blocks the calling thread until the thread obtains shared ownership of the mutex.

try_lock()

bool std::detail::shared_mutex_cv::try_lock ( )

inline

Tries to take ownership of the mutex without blocking.

Returns

True if the method takes ownership; false otherwise.

try_lock_shared()

bool std::detail::shared_mutex_cv::try_lock_shared ( )

inline

Tries to take shared ownership of the mutex without blocking.

Returns

True if the method takes ownership; false otherwise.

unlock()

void std::detail::shared_mutex_cv::unlock ( )

inline

Releases the ownership of the mutex from the calling thread.

unlock_shared()

void std::detail::shared_mutex_cv::unlock_shared ( )

inline

Releases the shared ownership of the mutex from the calling thread.

---

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

• olp-cpp-sdk-core/include/olp/core/porting/shared_mutex.h