Unique lock for reading. More...

#include <UniqueReadLock.hpp>

Collaboration diagram for samchon::library::UniqueReadLock:

Public Member Functions
	UniqueReadLock (const RWMutex &, bool=true)
	Construct from mutex. More...

	UniqueReadLock (const UniqueReadLock &)=delete
	Prohibited Copy Constructor. More...

	UniqueReadLock (UniqueReadLock &&)
	Move Constructor. More...

	~UniqueReadLock ()
	Default Destructor. More...

void	lock () const
	Lock on read. More...

void	unlock () const
	Unlock of read. More...

Private Attributes
const RWMutex *	mtx
	Managed mutex. More...

bool	isLocked
	Whether the mutex was locked by UniqueLock. More...

Detailed Description

Unique lock for reading.

A UniqueAcquire is an object manages a RWMutex with unique ownership in both states.

locked
unlocked

On construction (or by move-assigning to it), the object locks a RWMutex object on reading side, for whose locking and unlocking operations becomes responsible.

This class guarantees a unlocked status on destruction (even if not called explicitly). Therefore it is especially useful as an object with automatic duration, as it guarantees the RWMutex object is properly unlocked in case an exception is thrown.

Referenced comments of std::unique_lock

http://www.cplusplus.com/reference/mutex/unique_lock/

Note: Though, that the UniqueReadLock object does not manage the lifetime of the RWMutex object in any way: the duration of the RWMutex object shall extend at least until the destruction of the UniqueReadLock that manages it.

See also: samchon::library

Author: Jeongho Nam http://samchon.org

Definition at line 39 of file UniqueReadLock.hpp.

Constructor & Destructor Documentation

UniqueReadLock::UniqueReadLock	(	const RWMutex &	mtx,
		bool	doLock = `true`
	)

Construct from mutex.

Parameters

mtx	Mutex to manage
doLock	Whether to lock directly or not

Definition at line 7 of file UniqueReadLock.cpp.

References isLocked, mtx, and samchon::library::RWMutex::readLock().

Here is the call graph for this function:

samchon::library::UniqueReadLock::UniqueReadLock ( const UniqueReadLock & )

delete

Prohibited Copy Constructor.

UniqueAcquire can't be copied. Use pointer, reference instead.

If what you want is UniqueAcquire(s) references each other and unlock when all related UniqueAcquire objects are destructed, SharedAcquire is the best way.

Parameters