Aleph::Synchronized< T, Mutex >::LockedPtr Class Reference

RAII guard for exclusive access to the synchronized value. More...

#include <concurrency_utils.H>

Collaboration diagram for Aleph::Synchronized< T, Mutex >::LockedPtr:

Public Member Functions
	LockedPtr (Mutex &mutex, T &value)
	Construct a guard and acquire the lock.
T &	get () noexcept
	Access the protected value.
T *	operator-> () noexcept
	Access members of the protected value.
T &	operator* () noexcept
	Access the protected value.

Private Attributes
std::unique_lock< Mutex >	lock_
T *	ptr_

Detailed Description

template<typename T, typename Mutex = std::mutex>
class Aleph::Synchronized< T, Mutex >::LockedPtr

RAII guard for exclusive access to the synchronized value.

Note

Thread-safe to use only while the guard object remains alive on the thread that acquired it. The destructor releases the lock.

Definition at line 712 of file concurrency_utils.H.

Constructor & Destructor Documentation

LockedPtr()

template<typename T , typename Mutex = std::mutex>

Aleph::Synchronized< T, Mutex >::LockedPtr::LockedPtr ( Mutex &  mutex, T &  value  )

inline

Construct a guard and acquire the lock.

Parameters

mutex	Mutex protecting the value.
value	Protected object to expose through the guard.

Exceptions

Any	exception thrown while locking mutex.

Definition at line 723 of file concurrency_utils.H.

Member Function Documentation

get()

template<typename T , typename Mutex = std::mutex>

T & Aleph::Synchronized< T, Mutex >::LockedPtr::get ( )

inlinenoexcept

Access the protected value.

Returns

A mutable reference to the protected object.

Exceptions

Nothing.

Definition at line 730 of file concurrency_utils.H.

References Aleph::Synchronized< T, Mutex >::LockedPtr::ptr_.

operator*()

template<typename T , typename Mutex = std::mutex>

T & Aleph::Synchronized< T, Mutex >::LockedPtr::operator* ( )

inlinenoexcept

Access the protected value.

Returns

A mutable reference to the protected object.

Exceptions

Nothing.

Definition at line 740 of file concurrency_utils.H.

References Aleph::Synchronized< T, Mutex >::LockedPtr::ptr_.

operator->()

template<typename T , typename Mutex = std::mutex>

T * Aleph::Synchronized< T, Mutex >::LockedPtr::operator-> ( )

inlinenoexcept

Access members of the protected value.

Returns

A mutable pointer to the protected object.

Exceptions

Nothing.

Definition at line 735 of file concurrency_utils.H.

References Aleph::Synchronized< T, Mutex >::LockedPtr::ptr_.

Member Data Documentation

lock_

template<typename T , typename Mutex = std::mutex>

std::unique_lock<Mutex> Aleph::Synchronized< T, Mutex >::LockedPtr::lock_

private

Definition at line 714 of file concurrency_utils.H.

ptr_

template<typename T , typename Mutex = std::mutex>

T* Aleph::Synchronized< T, Mutex >::LockedPtr::ptr_

private

Definition at line 715 of file concurrency_utils.H.

Referenced by Aleph::Synchronized< T, Mutex >::LockedPtr::get(), Aleph::Synchronized< T, Mutex >::LockedPtr::operator*(), and Aleph::Synchronized< T, Mutex >::LockedPtr::operator->().

---

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

• concurrency_utils.H