Detailed Description

A semaphore for inter-thread synchronization.

The state of a semaphore object is signaled when its count is greater than zero, and nonsignaled when its count is equal to zero. The initialCount parameter specifies the initial count. Each time a waiting thread is released because of the semaphore's signaled state, the count of the semaphore is decreased by one. Use the release function to increment a semaphore's count by a specified amount. The count can never be less than zero or greater than the value specified in the maxCount parameter.

Definition at line 28 of file CSemaphore.h.

#include <mrpt/synch/CSemaphore.h>

Public Member Functions
	CSemaphore (unsigned int initialCount, unsigned int maxCount)
	Creates a semaphore. More...

virtual	~CSemaphore ()
	Dtor. More...

bool	waitForSignal (unsigned int timeout_ms=0)
	Blocks until the count of the semaphore to be non-zero. More...

void	release (unsigned int increaseCount=1)
	Increments the count of the semaphore by a given amount. More...

Protected Attributes
mrpt::utils::CReferencedMemBlock	m_data

Constructor & Destructor Documentation

◆ CSemaphore()

mrpt::synch::CSemaphore::CSemaphore	(	unsigned int	initialCount,
		unsigned int	maxCount
	)

Creates a semaphore.

◆ ~CSemaphore()

virtual mrpt::synch::CSemaphore::~CSemaphore ( )

virtual

Dtor.

Member Function Documentation

◆ release()

void mrpt::synch::CSemaphore::release ( unsigned int increaseCount = 1 )

Increments the count of the semaphore by a given amount.

Referenced by mrpt::detectors::CFaceDetection::detectObjects_Impl(), mrpt::gui::CWindowDialog::OnClose(), mrpt::gui::C3DWindowDialog::OnClose(), CDisplayWindow_WXAPP::OnInit(), mrpt::gui::WxSubsystem::CWXMainFrame::OnTimerProcessRequests(), mrpt::hwdrivers::CNTRIPClient::private_ntrip_thread(), sem_thread_example(), mrpt::detectors::CFaceDetection::thread_checkIfDiagonalSurface(), mrpt::detectors::CFaceDetection::thread_checkIfFacePlaneCov(), mrpt::detectors::CFaceDetection::thread_checkIfFaceRegions(), mrpt::gui::WxSubsystem::wxMainThread(), and mrpt::detectors::CFaceDetection::~CFaceDetection().

◆ waitForSignal()

bool mrpt::synch::CSemaphore::waitForSignal ( unsigned int timeout_ms = 0 )

Blocks until the count of the semaphore to be non-zero.

Parameters

timeout_ms The timeout in milliseconds, or set to zero to wait indefinidely.

Returns: true if the semaphore has been signaled, false on timeout or any other error.

Referenced by mrpt::hwdrivers::CNTRIPClient::close(), mrpt::gui::WxSubsystem::createOneInstanceMainThread(), mrpt::detectors::CFaceDetection::detectObjects_Impl(), mrpt::hwdrivers::CNTRIPClient::open(), mrpt::hwdrivers::prepareVideoSourceFromUserSelection(), sem_thread_example(), mrpt::detectors::CFaceDetection::thread_checkIfDiagonalSurface(), mrpt::detectors::CFaceDetection::thread_checkIfFacePlaneCov(), and mrpt::detectors::CFaceDetection::thread_checkIfFaceRegions().

Member Data Documentation

◆ m_data

mrpt::utils::CReferencedMemBlock mrpt::synch::CSemaphore::m_data

protected

Definition at line 31 of file CSemaphore.h.