Unique acquire from a Semaphore. More...

#include <UniqueAcquire.hpp>

Collaboration diagram for samchon::library::UniqueAcquire:

Public Member Functions
	UniqueAcquire (Semaphore &, bool=true)
	Construct from semaphore. More...

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

	UniqueAcquire (UniqueAcquire &&)
	Move Constructor. More...

	~UniqueAcquire ()
	Default Destructor. More...

void	acquire ()
	Acquire admission. More...

void	release ()
	Release an admission. More...

Private Attributes
Semaphore *	semaphore
	Managed semaphore. More...

bool	isLocked
	Whether the semaphore was acquired by the UniqueLock. More...

Detailed Description

Unique acquire from a Semaphore.

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

acquired
released

On construction (or by move-assigning to it), the object acquires a semaphore object, for whose acquiring and releasing operations becomes responsible.

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

Referenced comments of std::unique_lock

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

Note

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

The UniqueAcquire is movable, but not copyable.

See also: samchon::library

Author: Jeongho Nam http://samchon.org

Definition at line 41 of file UniqueAcquire.hpp.

Constructor & Destructor Documentation

UniqueAcquire::UniqueAcquire	(	Semaphore &	semaphore,
		bool	doLock = `true`
	)

Construct from semaphore.

Parameters

semaphore	Semaphore to manage
doLock	Whether to lock directly or not

Definition at line 9 of file UniqueAcquire.cpp.

References samchon::library::Semaphore::acquire(), isLocked, and semaphore.

Here is the call graph for this function:

samchon::library::UniqueAcquire::UniqueAcquire ( const UniqueAcquire & )

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