CoreLinux++  0.4.32
Public Member Functions | Protected Member Functions | List of all members
corelinux::MutexSemaphore Class Reference

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

#include <MutexSemaphore.hpp>

Public Member Functions

 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. More...
 
virtual ~MutexSemaphore (void)
 Virtual Destructor.
 
virtual bool isLocked (void)
 Ask if semaphore instance is locked.
 
virtual SemaphoreOperationStatus lockWithWait (void) throw (SemaphoreException)
 Request the semaphore, wait for availability.
 
virtual SemaphoreOperationStatus lockWithNoWait (void) throw (SemaphoreException)
 Request the semaphore without waiting.
 
virtual SemaphoreOperationStatus release (void) throw (SemaphoreException)
 Request the semaphore but timeout if not available. More...
 
- Public Member Functions inherited from corelinux::Semaphore
 Semaphore (SemaphoreGroupPtr, SemaphoreIdentifierRef, bool Recursive=false, bool Balking=false) throw ( NullPointerException )
 Default constructor requires the identifier of the semaphore in the semaphore group. More...
 
virtual ~Semaphore (void)
 Virtual Destructor.
 
bool operator== (SemaphoreCref aRef) const
 Equality operator returns true if identifiers match.
 
virtual bool isBalkingEnabled (void) const
 Returns true if balking enabled.
 
virtual bool isRecursionEnabled (void) const
 Returns true if recursion allowed.
 
virtual ThreadIdentifierCref getOwningThreadIdentifier (void) const
 Returns the identifier of who currently owns the semaphore.
 
virtual CounterCref getRecursionQueueLength (void) const
 Return the depth of the recursion for the owner.
 
- Public Member Functions inherited from corelinux::AbstractSemaphore
 AbstractSemaphore (SemaphoreGroupPtr, SemaphoreIdentifierRef) throw ( NullPointerException )
 Default constructor.
 
virtual ~AbstractSemaphore (void)
 Virtual Destructor.
 
bool operator== (AbstractSemaphoreCref aRef) const
 Equality operator returns true if identifiers match.
 
SemaphoreIdentifierCref getIdentifier (void) const
 Return a reference to this AbstractSemaphore identifier.
 
SemaphoreGroupIdentifierCref getGroupIdentifier (void) const
 Returns a reference to the SemaphoreGroup identifier.
 
Int getValue (void)
 Returns the current value of the semaphore.
 
Int getInitialValue (void)
 Retrieves the initial value for a semaphore.
 
- Public Member Functions inherited from corelinux::Synchronized
 Synchronized (void)
 Default constructor.
 
 Synchronized (SynchronizedCref)
 Copy constructor.
 
virtual ~Synchronized (void)
 Virtual Destructor.
 
SynchronizedRef operator= (SynchronizedCref)
 Assignment operator.
 
bool operator== (SynchronizedCref) const
 Equality operator.
 

Protected Member Functions

 MutexSemaphore (void) throw ( Assertion )
 Default construct throws assert.
 
 throw (Assertion)
 Copy constructor throws assertion.
 
MutexSemaphoreRef operator= (MutexSemaphoreCref) throw ( Assertion )
 Assignment operator throws assertion.
 
- Protected Member Functions inherited from corelinux::Semaphore
 throw (Assertion)
 Default constructor throws assertion.
 
 throw (Assertion)
 Copy constructor throws assertion.
 
SemaphoreRef operator= (SemaphoreCref) throw (Assertion)
 Assignment operator throws assertion.
 
CounterCref operator++ (void)
 Operator for increasing theRecursionQueueLength.
 
CounterCref operator-- (void)
 Operator for decreasing theRecursionQueueLength.
 
virtual ThreadIdentifierRef getOwnerId (void)
 Returns a reference to the owning thread.
 
virtual void setOwnerId (void)
 Sets the owner id to the current thread.
 
virtual void setRecursionQueueLength (Counter)
 Sets the recursion length.
 
virtual void resetOwnerId (void)
 Sets the owner thread id to not owned.
 
- Protected Member Functions inherited from corelinux::AbstractSemaphore
 throw (Assertion)
 
AbstractSemaphoreRef operator= (AbstractSemaphoreCref) throw (Assertion)
 
SemaphoreIdentifierRef getId (void)
 Returns a reference to the AbstractSemaphore identifier.
 
Int getGroupId (void) const
 Returns a reference to the group identifier.
 
SemaphoreOperationStatus setLock (Int)
 Calls kernel lock mechanism.
 
SemaphoreOperationStatus setUnlock (Int)
 Calls kernel unlock mechanism.
 
SemaphoreOperationStatus waitZero (Int)
 Calls kernel zero mechanism.
 
SemaphoreOperationStatus setValue (Int)
 Sets the value for the AbstractSemaphore.
 
- Protected Member Functions inherited from corelinux::Synchronized
Guard access (void) const throw (SemaphoreException)
 Access returns a instance of Guard which is block scoped to the caller. More...
 

Additional Inherited Members

- Protected Types inherited from corelinux::Synchronized
typedef GuardGuardPtr
 
typedef const GuardGuardCptr
 
typedef GuardGuardRef
 
typedef const GuardGuardCref
 

Detailed Description

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.

Constructor & Destructor Documentation

corelinux::MutexSemaphore::MutexSemaphore ( SemaphoreGroupPtr  aGroup,
SemaphoreIdentifierRef  aIdentifier,
bool  AutoLock = false,
bool  Recursive = true,
bool  Balking = false 
)
throw (NullPointerException
)

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

Parameters
SemaphoreGrouppointer to the owning SemaphoreGroup
SemaphoreIdentifierThe identifier for the Semaphore from the SemaphoreGroup
booltrue if autolock on creation
booltrue if recursion enabled
booltrue if balking enabled

References corelinux::Semaphore::setOwnerId().

Member Function Documentation

SemaphoreOperationStatus corelinux::MutexSemaphore::release ( void  )
throw (SemaphoreException
)
virtual

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

This is the CoreLinux++ reference manual
Provided by The CoreLinux Consortium