Cpl::System::Semaphore Class Reference

This semaphore class defines the interface for a Counting Semaphore. More...

Detailed Description

This semaphore class defines the interface for a Counting Semaphore.

NOTES:

o The 'max-count' for a Semaphore is platform specific.
o The class inherits from 'Signable' which contains/defines the
  "signal()" methods.

#include <Semaphore.h>

Inheritance diagram for Cpl::System::Semaphore:

Collaboration diagram for Cpl::System::Semaphore:

Public Member Functions
	Semaphore (unsigned initialCount=0)
	Constructor.
	~Semaphore ()
	Destructor.
void	wait (void) noexcept
	This method causes the current thread to block and wait till the semaphore is signaled/set.
bool	timedWait (unsigned long timeout) noexcept
	This method is the same as wait(), except that 'timeout' specifies the maximum amount of time, in milliseconds, will block if the semaphore count is zero.
bool	tryWait (void) noexcept
	This method is the same as wait(), except that if the semaphore count is zero, the method returns immediately and has a return code of false.
int	signal (void) noexcept
	Signable API
int	su_signal (void) noexcept
	Signable API
Public Member Functions inherited from Cpl::System::Signable
virtual	~Signable ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Member Functions
void	waitInRealTime (void) noexcept
	Helper method for supporting SimTicks and 'real' tick in the same build.
bool	timedWaitInRealTime (unsigned long timeout) noexcept
	Helper method for supporting SimTicks and 'real' tick in the same build.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes
Cpl_System_Sema_T	m_sema
	Raw Semaphore handle/instance/pointer.

Friends
class	Api
	Friends(s)
class	SimTick

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.

Constructor & Destructor Documentation

Semaphore()

Cpl::System::Semaphore::Semaphore

(

unsigned

initialCount = 0

)

Constructor.

The semaphore is created with the specified 'initialCount'. A count of zero, will cause an immediate call to 'wait()' to block.

~Semaphore()

Cpl::System::Semaphore::~Semaphore

(

)

Destructor.

Member Function Documentation

signal()

int Cpl::System::Semaphore::signal ( void  )

virtualnoexcept

Signable API

Implements Cpl::System::Signable.

su_signal()

int Cpl::System::Semaphore::su_signal ( void  )

virtualnoexcept

Signable API

Implements Cpl::System::Signable.

timedWait()

bool Cpl::System::Semaphore::timedWait ( unsigned long  timeout )

noexcept

This method is the same as wait(), except that 'timeout' specifies the maximum amount of time, in milliseconds, will block if the semaphore count is zero.

The method return true if the semaphore was signaled (i.e. count > 0); else false is returned if the timeout period expired.

timedWaitInRealTime()

bool Cpl::System::Semaphore::timedWaitInRealTime ( unsigned long  timeout )

protectednoexcept

Helper method for supporting SimTicks and 'real' tick in the same build.

tryWait()

bool Cpl::System::Semaphore::tryWait ( void  )

noexcept

This method is the same as wait(), except that if the semaphore count is zero, the method returns immediately and has a return code of false.

If the semaphore count is greater than zero, the count is decrement and the method returns immediately and has a return code of true.

wait()

void Cpl::System::Semaphore::wait ( void  )

noexcept

This method causes the current thread to block and wait till the semaphore is signaled/set.

NOTE: Can only be called from a Thread context!

waitInRealTime()

void Cpl::System::Semaphore::waitInRealTime ( void  )

protectednoexcept

Helper method for supporting SimTicks and 'real' tick in the same build.

Friends And Related Symbol Documentation

Api

friend class Api

friend

Friends(s)

Member Data Documentation

m_sema

Cpl_System_Sema_T Cpl::System::Semaphore::m_sema

protected

Raw Semaphore handle/instance/pointer.

---

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

• Cpl/System/Semaphore.h