#include <Semaphore.h>

Collaboration diagram for Euclid::Semaphore:

Classes
class	SemaphoreImpl

Public Member Functions
	Semaphore (unsigned int i)

	~Semaphore ()

void	release ()

void	acquire ()

bool	try_acquire ()

bool	try_acquire_until (const std::chrono::system_clock::time_point &abs_time)

template<class Clock , class Duration >
bool	try_acquire_until (const std::chrono::time_point< Clock, Duration > &abs_time)

template<class Rep , class Ratio >
bool	try_acquire_for (const std::chrono::duration< Rep, Ratio > &rel_time)

Private Attributes
std::unique_ptr< SemaphoreImpl >	m_impl

Detailed Description

Counting semaphore, based on the C++20 API, so it can be eventually swapped

Definition at line 31 of file Semaphore.h.

Constructor & Destructor Documentation

Euclid::Semaphore::Semaphore ( unsigned int i )

explicit

Constructor

Parameters

i	The internal counter will be initialized to i

Definition at line 28 of file Semaphore.cpp.

Euclid::Semaphore::~Semaphore ( )

default

Destructor

Member Function Documentation

void Euclid::Semaphore::acquire ( )

Decrement the counter. Blocks if it was already 0 until some other thread calls release()

Definition at line 36 of file Semaphore.cpp.

References m_impl.

void Euclid::Semaphore::release ( )

Increment the counter. Does not block.

Definition at line 32 of file Semaphore.cpp.

References m_impl.

bool Euclid::Semaphore::try_acquire ( )

Try decrementing the counter.

Returns: false if the counter can not be decremented (already at 0)

Definition at line 40 of file Semaphore.cpp.

References m_impl.

template<class Rep , class Ratio >

bool Euclid::Semaphore::try_acquire_for ( const std::chrono::duration< Rep, Ratio > & rel_time )

inline

Try decrementing the counter with a relative timeout

Template Parameters

Rep
Ratio

Parameters

rel_time If the counter can not be decremented, the call will block for this duration.

Returns: false if the counter can not be decremented within the time window

Definition at line 94 of file Semaphore.h.

References std::chrono::system_clock::now(), and try_acquire_until().

Here is the call graph for this function:

bool Euclid::Semaphore::try_acquire_until ( const std::chrono::system_clock::time_point & abs_time )

Try decrementing the counter with an absolute timeout

Parameters

abs_time If the counter can not be decremented, the call will block until this time point is reached. If it was in the past, it will return immediately.