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

GatewaySemphore enables a depth of resource indicator. More...

#include <GatewaySemaphore.hpp>

Public Member Functions

 GatewaySemaphore (SemaphoreGroupPtr, SemaphoreIdentifierRef, Count, bool Recursive=false, bool Balking=false) throw ( NullPointerException )
 Default constructor requires the identifier of the semaphore in the semaphore group and a count of resources for control. More...
 
virtual ~GatewaySemaphore (void)
 Virtual Destructor.
 
virtual bool isLocked (void)
 Ask if AbstractSemaphore instance is locked.
 
virtual bool isAnOwner (void)
 Returns true if calling thread owns a resource.
 
virtual Counter getOwnerRecursionQueueLength (void)
 Returns the recursion depth for the calling thread. More...
 
virtual SemaphoreOperationStatus lockWithWait (void) throw ( SemaphoreException )
 Request the lock, wait for availability.
 
virtual SemaphoreOperationStatus lockWithNoWait (void) throw ( SemaphoreException )
 Request the lock without waiting.
 
virtual SemaphoreOperationStatus release (void) throw ( SemaphoreException )
 Request the AbstractSemaphore 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

 GatewaySemaphore (void) throw ( Assertion )
 Default construct throws assert.
 
 GatewaySemaphore (GatewaySemaphoreCref) throw ( Assertion )
 Copy constructor throws assertion.
 
GatewaySemaphoreRef operator= (GatewaySemaphoreCref) throw ( Assertion )
 Assignment operator throws assertion.
 
SemaphoreOperationStatus lockAndAdd (ThreadIdentifierRef aTid, Int aFlag=0)
 
- Protected Member Functions inherited from corelinux::Semaphore
 Semaphore (void) throw (Assertion)
 Default constructor throws assertion.
 
 Semaphore (SemaphoreCref) 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
 AbstractSemaphore (AbstractSemaphoreCref) 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

GatewaySemphore enables a depth of resource indicator.

Unlike the tradition boolean semaphore (locked,unlocked), this type assumes a finite number of threads/processes can be granted access up to theResourceMaximum. The semantics regarding semaphore and recursion in relationship to the GatewaySemaphore is as follows:

With recursion enabled:

Constructor & Destructor Documentation

corelinux::GatewaySemaphore::GatewaySemaphore ( SemaphoreGroupPtr  aGroup,
SemaphoreIdentifierRef  aIdentifier,
Count  aValue,
bool  Recursive = false,
bool  Balking = false 
)
throw (NullPointerException
)

Default constructor requires the identifier of the semaphore in the semaphore group and a count of resources for control.

Parameters
SemaphoreGroupPtrThe owning SemaphoreGroup
SemaphoreIdentifierThe identifier for the Semaphore from the SemaphoreGroup
Countnumber of resources the semaphore controls
booltrue if recursion enabled
booltrue if balking enabled

References corelinux::AbstractSemaphore::setValue().

Member Function Documentation

Counter corelinux::GatewaySemaphore::getOwnerRecursionQueueLength ( void  )
virtual

Returns the recursion depth for the calling thread.

Returns
Counter -1 if not an owner, 0 if owner but not recursed, or > 0 for recursion depth.

References corelinux::Thread::getThreadIdentifier(), and isAnOwner().

SemaphoreOperationStatus corelinux::GatewaySemaphore::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