class corelinux::MutexSemaphore

★ wanayoo — archive 1999 http://corelinux.sourceforge.net/classref/MutexSemaphore.html

class corelinux::MutexSemaphore: public Semaphore

MutexSemaphore implements a mutual exclusion control which can be used to insure that at most one (1) task has access at a time.

Inheritance:

Public Methods
MutexSemaphore( SemaphoreGroupPtr, SemaphoreIdentifierRef, bool AutoLock = false, bool Recursive = true, bool Balking = false ) throw( NullPointerException ): Default constructor requires the identifier of the semaphore in the semaphore group
virtual bool isLocked( void ): Ask if semaphore instance is locked
virtual SemaphoreOperationStatus lockWithNoWait( void ) throw(SemaphoreException): Request the semaphore without waiting
virtual SemaphoreOperationStatus lockWithWait( void ) throw(SemaphoreException): Request the semaphore, wait for availability
virtual SemaphoreOperationStatus release( void ) throw(SemaphoreException): Release the semaphore if owner
virtual ~MutexSemaphore( void ): Virtual Destructor

Public
: Request the semaphore but timeout if not available

Protected Methods
MutexSemaphore( MutexSemaphoreCref ) throw( Assertion ): Copy constructor throws assertion
MutexSemaphore( void ) throw( Assertion ): Default construct throws assert
MutexSemaphoreRef operator=( MutexSemaphoreCref ) throw( Assertion ): Assignment operator throws assertion

Inherited from Semaphore:

Public Methods
virtual ThreadIdentifierCref getOwningThreadIdentifier( void ) const
virtual CounterCref getRecursionQueueLength( void ) const
virtual bool isBalkingEnabled( void ) const
virtual bool isRecursionEnabled( void ) const
bool operator==( SemaphoreCref aRef ) const

Protected Methods
virtual ThreadIdentifierRef getOwnerId( void )
CounterCref operator++( void )
CounterCref operator--( void )
virtual void resetOwnerId( void )
virtual void setOwnerId( void )
virtual void setRecursionQueueLength( Counter )

Inherited from AbstractSemaphore:

Public Methods
SemaphoreGroupIdentifierCref getGroupIdentifier( void ) const
SemaphoreIdentifierCref getIdentifier( void ) const
Int getInitialValue( void )
Int getValue( void )

Protected Methods
inline Int getGroupId( void ) const
inline SemaphoreIdentifierRef getId( void )
SemaphoreOperationStatus setLock( Int )
SemaphoreOperationStatus setUnlock( Int )
SemaphoreOperationStatus setValue( Int )

Inherited from Synchronized:

Protected Methods
Guard access( void ) const throw(SemaphoreException)

Documentation

MutexSemaphore implements a mutual exclusion control which can be used to insure that at most one (1) task has access at a time.
The semantics for Recursion: The thread that is successful is obtaining the lock will be regarded as theOwningThreadIdentifier. If, upon a lock request, it is determined that the same thread that owns the lock is asking to lock again, theRecursionQueueLength will be incremented. It is thereafter neccessary for theOwningThread to release the semaphore until theRecursionQueueLength returns to zero (0). All other callers will block or not based on their lock call disposition.

MutexSemaphore( SemaphoreGroupPtr, SemaphoreIdentifierRef, bool AutoLock = false, bool Recursive = true, bool Balking = false ) throw( NullPointerException )

Default constructor requires the identifier of the semaphore in the semaphore group


Parameters:: SemaphoreGroup - pointer to the owning SemaphoreGroup
SemaphoreIdentifier - The identifier for the Semaphore from the SemaphoreGroup
bool - true if autolock on creation
bool - true if recursion enabled
bool - true if balking enabled

virtual ~MutexSemaphore( void )