AMutexWrapper< T, Lockable > Class Template Reference

Wraps the object with a Lockable, providing exclusive access layer, i.e., for thread-safety. More...

#include <AUI/Thread/AMutexWrapper.h>

Public Member Functions#
	AMutexWrapper (T value=T()) noexcept
void	lock ()
AMutexWrapper &	operator= (const T &rhs)
AMutexWrapper &	operator= (T &&rhs) noexcept
template<typename U, std::enable_if_t< std::is_constructible_v< U, T > > * = 0>
	operator U () noexcept
void	unlock ()
T &	value () noexcept
T *	operator-> () noexcept
Public Member Functions inherited from aui::noncopyable
	noncopyable (const noncopyable &)=delete
noncopyable &	operator= (const noncopyable &)=delete

Detailed Description#

template<typename T, typename Lockable = AMutex>
class AMutexWrapper< T, Lockable >

Template Parameters

T	The type of the value to be protected.
Lockable	A lockable type which manages locking behaviour, i.e, AMutex.

On debug builds, provides a runtime check for better diagnostics.

Aka boost::synchronized_value.

Implementing thread safety#

struct SharedResource {
 AString data;
};
AMutexWrapper<SharedResource, AMutex> sharedResource;
sharedResource->data = "test"; // bad, will crash
 
...
// thread 1
std::unique_lock lock(sharedResource); //
sharedResource->data = "hello";        // ok
...
 
// thread 2
std::unique_lock lock(sharedResource); //
sharedResource->data = "world";        // ok, will be done before or after "hello", but not simultaneously
...

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

Public Member Functions

Detailed Description

Implementing thread safety

View Page SourceEdit Page Source