#include <MutexSemaphoreGroup.hpp>
Public Member Functions | |
MutexSemaphoreGroup (Short, Int Rights=OWNER_ALL) throw (Assertion,SemaphoreException) | |
Default constructor creates a private group semaphores with access for OWNER_ALL. | |
MutexSemaphoreGroup (Short, SemaphoreGroupIdentifierCref, Int, CreateDisposition disp=FAIL_IF_EXISTS) throw (Assertion,SemaphoreException) | |
Constructor to open or create a semaphore group with a specific identifier. | |
MutexSemaphoreGroup (Short, CharCptr, Int, CreateDisposition disp=FAIL_IF_EXISTS) throw (Assertion,SemaphoreException) | |
Constructor to open or create a semaphore group by name. | |
virtual | ~MutexSemaphoreGroup (void) |
Virtual destructor. | |
virtual AbstractSemaphorePtr | createSemaphore (void) throw ( SemaphoreException ) |
Create a default MutexSemaphore. | |
virtual AbstractSemaphorePtr | createLockedSemaphore (bool Recursive=false, bool Balking=false) throw ( SemaphoreException ) |
Create a locked MutexSemaphore. | |
virtual AbstractSemaphorePtr | createSemaphore (SemaphoreIdentifierRef aIdentifier, CreateDisposition disp=CREATE_OR_REUSE, bool Recursive=false, bool Balking=false) throw ( SemaphoreException ) |
Create or open (use) a specific MutexSemphore. | |
virtual AbstractSemaphorePtr | createLockedSemaphore (SemaphoreIdentifierRef aIdentifier, CreateDisposition disp=CREATE_OR_REUSE, bool Recursive=false, bool Balking=false) throw ( SemaphoreException ) |
Create or open (use) a specific MutexSemphore and have it automatically locked. | |
virtual AbstractSemaphorePtr | createSemaphore (std::string aName, CreateDisposition disp=CREATE_OR_REUSE, bool Recursive=false, bool Balking=false) throw ( SemaphoreException ) |
Create or open (use) a specific MutexSemphore. | |
virtual void | destroySemaphore (AbstractSemaphorePtr) throw ( SemaphoreException ) |
Destroys a created MutexSemaphore. | |
Protected Member Functions | |
MutexSemaphoreGroup (void) throw ( Assertion ) | |
Default constructor not allowed. | |
MutexSemaphoreGroup (MutexSemaphoreGroupCref) throw ( Assertion ) | |
Copy constructor not allowed. | |
MutexSemaphoreGroupRef | operator= (MutexSemaphoreGroupCref) throw ( Assertion ) |
Assignment operator not allowed. | |
AbstractSemaphorePtr | resolveSemaphore (SemaphoreIdentifierRef aIdentifier, Short aSemId, CreateDisposition aDisp, bool aRecurse, bool aBalk, bool aAutoLock=false) throw ( SemaphoreException ) |
Protected method for resolving mutex between CSA and local. |
Default behavior for creating semaphores via the SemaphoreGroup interface is to NOT autolock the MutexSemaphore. Use the createLockedSemaphore(...) interface to accomplish this.
corelinux::MutexSemaphoreGroup::MutexSemaphoreGroup | ( | Short | aSemCount, | |
Int | Rights = OWNER_ALL | |||
) | throw (Assertion,SemaphoreException) |
Default constructor creates a private group semaphores with access for OWNER_ALL.
Short | Number of semaphores in group | |
AccessRights | Specifies access control for group |
Assertion | if aCount < 1 | |
SemaphoreException | if kernel group create call fails. |
corelinux::MutexSemaphoreGroup::MutexSemaphoreGroup | ( | Short | aSemCount, | |
SemaphoreGroupIdentifierCref | aGID, | |||
Int | aRightSet, | |||
CreateDisposition | disp = FAIL_IF_EXISTS | |||
) | throw (Assertion,SemaphoreException) |
Constructor to open or create a semaphore group with a specific identifier.
Short | Number of semaphores in group, this only has meaning used if failOnExist = true | |
SemaphoreGroupIdentifier | valid group identifier either through a system call or via another ipc mechanism | |
AccessRights | Specifies access control for group | |
CreateDisposition | indicates how to treat the conditions that the group may meet in the request: CREATE_OR_REUSE indicates that the caller doesn't care FAIL_IF_EXISTS indicates the attempt was for a create FAIL_IF_NOTEXISTS indicates the attempt was for a open |
Assertion | if aCount < 1 | |
SemaphoreException | for described states |
corelinux::MutexSemaphoreGroup::MutexSemaphoreGroup | ( | Short | aSemCount, | |
CharCptr | aName, | |||
Int | aRightSet, | |||
CreateDisposition | disp = FAIL_IF_EXISTS | |||
) | throw (Assertion,SemaphoreException) |
Constructor to open or create a semaphore group by name.
Short | Number of semaphores in group, this only has meaning used if failOnExist = true | |
Char | pointer to Group name | |
AccessRights | Specifies access control for group | |
CreateDisposition | indicates how to treat the conditions that the group may meet in the request: CREATE_OR_REUSE indicates that the caller doesn't care FAIL_IF_EXISTS indicates the attempt was for a create FAIL_IF_NOTEXISTS indicates the attempt was for a open |
Assertion | if aCount < 1 or aCount > system defined maximum for group | |
SemaphoreException | for described states |
AbstractSemaphorePtr corelinux::MutexSemaphoreGroup::createSemaphore | ( | void | ) | throw ( SemaphoreException ) [virtual] |
Create a default MutexSemaphore.
SemaphoreException | if no sems left in group |
Implements corelinux::SemaphoreGroup.
References corelinux::FAIL_IF_EXISTS, and resolveSemaphore().
AbstractSemaphorePtr corelinux::MutexSemaphoreGroup::createLockedSemaphore | ( | bool | Recursive = false , |
|
bool | Balking = false | |||
) | throw ( SemaphoreException ) [virtual] |
Create a locked MutexSemaphore.
SemaphoreException | if no sems left in group |
References corelinux::FAIL_IF_EXISTS, and resolveSemaphore().
AbstractSemaphorePtr corelinux::MutexSemaphoreGroup::createSemaphore | ( | SemaphoreIdentifierRef | aIdentifier, | |
CreateDisposition | disp = CREATE_OR_REUSE , |
|||
bool | Recursive = false , |
|||
bool | Balking = false | |||
) | throw ( SemaphoreException ) [virtual] |
Create or open (use) a specific MutexSemphore.
SemaphoreIdentifier | identifies which semphore id to create or attempt to use | |
CreateDisposition | indicates how to treat the conditions that the group may meet in the request: CREATE_OR_REUSE indicates that the caller doesn't care FAIL_IF_EXISTS indicates the attempt was for a create FAIL_IF_NOTEXISTS indicates the attempt was for a open | |
Recursive | to allow same thread multiple locks | |
Balking | to allow the semaphore to balk |
SemaphoreException | if the disposition disagrees with the semaphore state, or if it is a erroneous identifier |
Implements corelinux::SemaphoreGroup.
References corelinux::ScalarIdentifier< ScalarType >::getScalar(), corelinux::SemaphoreGroup::getSemaphoreCount(), and resolveSemaphore().
AbstractSemaphorePtr corelinux::MutexSemaphoreGroup::createLockedSemaphore | ( | SemaphoreIdentifierRef | aIdentifier, | |
CreateDisposition | disp = CREATE_OR_REUSE , |
|||
bool | Recursive = false , |
|||
bool | Balking = false | |||
) | throw ( SemaphoreException ) [virtual] |
Create or open (use) a specific MutexSemphore and have it automatically locked.
SemaphoreIdentifier | identifies which semphore id to create or attempt to use | |
CreateDisposition | indicates how to treat the conditions that the group may meet in the request: CREATE_OR_REUSE indicates that the caller doesn't care FAIL_IF_EXISTS indicates the attempt was for a create FAIL_IF_NOTEXISTS indicates the attempt was for a open | |
Recursive | to allow same thread multiple locks | |
Balking | to allow the semaphore to balk |
SemaphoreException | if the disposition disagrees with the semaphore state, or if it is a erroneous identifier |
References corelinux::ScalarIdentifier< ScalarType >::getScalar(), corelinux::SemaphoreGroup::getSemaphoreCount(), and resolveSemaphore().
AbstractSemaphorePtr corelinux::MutexSemaphoreGroup::createSemaphore | ( | std::string | aName, | |
CreateDisposition | disp = CREATE_OR_REUSE , |
|||
bool | Recursive = false , |
|||
bool | Balking = false | |||
) | throw ( SemaphoreException ) [virtual] |
Create or open (use) a specific MutexSemphore.
string | identifies which semphore id to create or attempt to use | |
CreateDisposition | indicates how to treat the conditions that the group may meet in the request: CREATE_OR_REUSE indicates that the caller doesn't care FAIL_IF_EXISTS indicates the attempt was for a create FAIL_IF_NOTEXISTS indicates the attempt was for a open | |
Recursive | to allow same thread multiple locks | |
Balking | to allow the semaphore to balk |
SemaphoreException | if the disposition disagrees with the semaphore state, or if it is a erroneous identifier |
Implements corelinux::SemaphoreGroup.
void corelinux::MutexSemaphoreGroup::destroySemaphore | ( | AbstractSemaphorePtr | aPtr | ) | throw ( SemaphoreException ) [virtual] |
Destroys a created MutexSemaphore.
AbstractSemaphore | pointer of semaphore to destroy |
SemaphoreException | if semaphore does not belong to this group or if already destroyed. |
Implements corelinux::SemaphoreGroup.
References corelinux::SemaphoreGroup::getIdentifier(), and corelinux::SemaphoreCommon::relinquishSemaphore().