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

RAII guard for read-only access to the synchronized value. More...

#include <concurrency_utils.H>

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

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

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

Detailed Description

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

RAII guard for read-only 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 747 of file concurrency_utils.H.

Constructor & Destructor Documentation

ConstLockedPtr()

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

Aleph::Synchronized< T, Mutex >::ConstLockedPtr::ConstLockedPtr ( Mutex &  mutex, const 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 758 of file concurrency_utils.H.

Member Function Documentation

get()

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

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

inlinenoexcept

Access the protected value.

Returns

A const reference to the protected object.

Exceptions

Nothing.

Definition at line 765 of file concurrency_utils.H.

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

operator*()

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

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

inlinenoexcept

Access the protected value.

Returns

A const reference to the protected object.

Exceptions

Nothing.

Definition at line 775 of file concurrency_utils.H.

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

operator->()

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

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

inlinenoexcept

Access members of the protected value.

Returns

A const pointer to the protected object.

Exceptions

Nothing.

Definition at line 770 of file concurrency_utils.H.

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

Member Data Documentation

lock_

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

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

private

Definition at line 749 of file concurrency_utils.H.

ptr_

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

const T* Aleph::Synchronized< T, Mutex >::ConstLockedPtr::ptr_

private

Definition at line 750 of file concurrency_utils.H.

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

---

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

• concurrency_utils.H