Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr Class Reference

RAII guard for exclusive (write) access. More...

#include <concurrency_utils.H>

Collaboration diagram for Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr:

Public Member Functions
	WriteLockedPtr (SharedMutex &mutex, T &value)
	Construct a guard and acquire an exclusive 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< SharedMutex >	lock_
T *	ptr_

Detailed Description

template<typename T, typename SharedMutex = std::shared_mutex>
class Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr

RAII guard for exclusive (write) access.

Note

The guard holds an exclusive lock until destruction.

Definition at line 945 of file concurrency_utils.H.

Constructor & Destructor Documentation

WriteLockedPtr()

template<typename T , typename SharedMutex = std::shared_mutex>

Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::WriteLockedPtr ( SharedMutex &  mutex, T &  value  )

inline

Construct a guard and acquire an exclusive lock.

Parameters

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

Exceptions

Any	exception thrown while locking mutex.

Definition at line 956 of file concurrency_utils.H.

Member Function Documentation

get()

template<typename T , typename SharedMutex = std::shared_mutex>

T & Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::get ( )

inlinenoexcept

Access the protected value.

Returns

A mutable reference to the protected object.

Exceptions

Nothing.

Definition at line 963 of file concurrency_utils.H.

References Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::ptr_.

operator*()

template<typename T , typename SharedMutex = std::shared_mutex>

T & Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::operator* ( )

inlinenoexcept

Access the protected value.

Returns

A mutable reference to the protected object.

Exceptions

Nothing.

Definition at line 973 of file concurrency_utils.H.

References Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::ptr_.

operator->()

template<typename T , typename SharedMutex = std::shared_mutex>

T * Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::operator-> ( )

inlinenoexcept

Access members of the protected value.

Returns

A mutable pointer to the protected object.

Exceptions

Nothing.

Definition at line 968 of file concurrency_utils.H.

References Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::ptr_.

Member Data Documentation

lock_

template<typename T , typename SharedMutex = std::shared_mutex>

std::unique_lock<SharedMutex> Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::lock_

private

Definition at line 947 of file concurrency_utils.H.

ptr_

template<typename T , typename SharedMutex = std::shared_mutex>

T* Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::ptr_

private

Definition at line 948 of file concurrency_utils.H.

Referenced by Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::get(), Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::operator*(), and Aleph::RwSynchronized< T, SharedMutex >::WriteLockedPtr::operator->().

---

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

• concurrency_utils.H