Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock > Class Template Reference

Mutex protected reference, will be locked until destroyed. More...

#include <ScopeLockedWrapper.hpp>

Public Member Functions
	ScopeLockedWrapper (T &val, Mutex &mutex)
T *	operator-> () const
T &	operator* () const

Private Attributes
T &	v
Lock< Mutex >	lock

Detailed Description

template<class T, class Mutex = std::mutex, template< class... > class Lock = std::scoped_lock>
class Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >

Mutex protected reference, will be locked until destroyed.

Template Parameters

T	Class to store
Mutex	Mutex type to use
Lock	Lock type to use

Definition at line 16 of file ScopeLockedWrapper.hpp.

Constructor & Destructor Documentation

ScopeLockedWrapper()

template<class T , class Mutex = std::mutex, template< class... > class Lock = std::scoped_lock>

Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::ScopeLockedWrapper ( T &  val, Mutex &  mutex  )

inline

Definition at line 19 of file ScopeLockedWrapper.hpp.

Member Function Documentation

operator*()

template<class T , class Mutex = std::mutex, template< class... > class Lock = std::scoped_lock>

T & Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::operator* ( ) const

inline

Definition at line 22 of file ScopeLockedWrapper.hpp.

References Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::v.

operator->()

template<class T , class Mutex = std::mutex, template< class... > class Lock = std::scoped_lock>

T * Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::operator-> ( ) const

inline

Definition at line 21 of file ScopeLockedWrapper.hpp.

References Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::v.

Member Data Documentation

lock

template<class T , class Mutex = std::mutex, template< class... > class Lock = std::scoped_lock>

Lock<Mutex> Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::lock

private

Definition at line 25 of file ScopeLockedWrapper.hpp.

v

template<class T , class Mutex = std::mutex, template< class... > class Lock = std::scoped_lock>

T& Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::v

private

Definition at line 24 of file ScopeLockedWrapper.hpp.

Referenced by Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::operator*(), and Botcraft::Utilities::ScopeLockedWrapper< T, Mutex, Lock >::operator->().

---

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

• botcraft/include/botcraft/Utilities/ScopeLockedWrapper.hpp