---

corelinux::CoreLinuxGuardPool Class Reference

The CoreLinuxGuardPool is a private SemaphoreGroup resource for class objects that require synchronization capability. More...

#include <CoreLinuxGuardPool.hpp>

List of all members.

Public Methods
	CoreLinuxGuardPool ( Short numInit=8, Short numExt=0 ) throw ( Assertion )
	Default constructor. More...
virtual	~CoreLinuxGuardPool ( void )
	Virtual destructor.
Static Public Methods
bool	isLocked ( SynchronizedPtr ) throw ( SemaphoreException )
	isLocked determines if the object is currently locked. More...
Short	getInitialPoolSize ( void )
	Return the initial guard count in the pool.
Short	getExtentSize ( void )
	Return the current grow by count for the pool.
Short	getTotalCurrentSize ( void )
	Return the current guard pool size.
void	lock ( SynchronizedPtr ) throw ( SemaphoreException )
	lock is called by a guard when control is needed over a objects resource access. More...
void	release ( SynchronizedPtr ) throw ( SemaphoreException )
	release is called by a guard object during its destruction. More...
void	setExtentSize ( Short aExtentSize ) throw ( Assertion )
	Run time interface for changing the extent size. More...
Protected Methods
bool	isSynchronizedLocked ( SynchronizedPtr ) throw ( SemaphoreException )
	isSynchronizedLocked resolves whether Synchronized is in a locked state. More...
void	lockSynchronized ( SynchronizedPtr ) throw ( SemaphoreException )
	lockSynchronized manages the associations of objects to the semaphore in the pool in establishing the guard. More...
void	releaseSynchronized ( SynchronizedPtr ) throw ( SemaphoreException )
	releaseSynchronized manages the associations of objects to the semaphore in the pool when releasing a guard. More...
void	createPoolGroup ( Short numSems, Short initSize=0 )
	createPoolGroup creates a semaphore set with the requested number of semaphores in the group and will add the semaphores to theSemaphores with initial count and index set properly. More...
void	destroyPoolGroup ( Index aGroup )
	destroyPoolGroup validates that all the semaphores in the extent are not being used and then destroys the extent and all the semaphores associated with it. More...
Static Protected Attributes
GuardPool	theGuard
	Singleton instance.
Short	theInitialSize
	Describes the inital pool size.
Short	theExtentSize
	Describes the size to add when going into extents.

---

Detailed Description

The CoreLinuxGuardPool is a private SemaphoreGroup resource for class objects that require synchronization capability.

See also:

corelinux::Synchronized, corelinux::PoolDescriptor

---

Constructor & Destructor Documentation

corelinux::CoreLinuxGuardPool::CoreLinuxGuardPool ( Short numInit = 8, Short numExtent = 0 ) throw ( Assertion )

Default constructor. Parameters: Short   number of base semaphores to use in pool Short   number of semaphores to increment by when going into extents. If 0, no extents are allowed. Exceptions: Assertion   if Singleton<CoreLinuxGuardPool> already established.

---

Member Function Documentation

void corelinux::CoreLinuxGuardPool::createPoolGroup ( Short numSems, Short initSize = 0 ) [protected]

createPoolGroup creates a semaphore set with the requested number of semaphores in the group and will add the semaphores to theSemaphores with initial count and index set properly. Parameters: Short   the semaphore count Short   the number to insert into theSemaphores If the default is used, all go into theSemaphores

void corelinux::CoreLinuxGuardPool::destroyPoolGroup ( Index aGroup ) [protected]

destroyPoolGroup validates that all the semaphores in the extent are not being used and then destroys the extent and all the semaphores associated with it. The method assumes that the group is the last in the vector. Parameters: Index   the group index

bool corelinux::CoreLinuxGuardPool::isLocked ( SynchronizedPtr aPtr ) throw ( SemaphoreException ) [static]

isLocked determines if the object is currently locked. Calls singleton instance isSynchronizedLocked. Parameters: Synchronized   pointer of guard owner. Returns: bool true if locked

bool corelinux::CoreLinuxGuardPool::isSynchronizedLocked ( SynchronizedPtr aPtr ) throw ( SemaphoreException ) [protected]

isSynchronizedLocked resolves whether Synchronized is in a locked state. Parameters: Synchronized   pointer of guard owner. Returns: bool true if locked Exceptions: SemaphoreException   if not of set.

void corelinux::CoreLinuxGuardPool::lock ( SynchronizedPtr aPtr ) throw ( SemaphoreException ) [static]

lock is called by a guard when control is needed over a objects resource access. Calls singleton instance lockedSynchronized. Parameters: Synchronized   pointer of guard owner. Exceptions: SemaphoreException   if out of pool resources

void corelinux::CoreLinuxGuardPool::lockSynchronized ( SynchronizedPtr aPtr ) throw ( SemaphoreException ) [protected]

lockSynchronized manages the associations of objects to the semaphore in the pool in establishing the guard. Parameters: Synchronized   pointer of guard owner.

void corelinux::CoreLinuxGuardPool::release ( SynchronizedPtr aPtr ) throw ( SemaphoreException ) [static]

release is called by a guard object during its destruction. Parameters: Synchronized   pointer of guard owner.Calls singleton instance releaseSynchronized. Exceptions: SemaphoreException   if Synchronized object held no resource.

void corelinux::CoreLinuxGuardPool::releaseSynchronized ( SynchronizedPtr aPtr ) throw ( SemaphoreException ) [protected]

releaseSynchronized manages the associations of objects to the semaphore in the pool when releasing a guard. Parameters: Synchronized   pointer of guard owner.

void corelinux::CoreLinuxGuardPool::setExtentSize ( Short aExtentSize ) throw ( Assertion ) [static]

Run time interface for changing the extent size. The next time the pool goes into extent processing, this will be used. Parameters: short   the new extent size Exceptions: Assertion   if size < 0

---

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

• CoreLinuxGuardPool.hpp
• CoreLinuxGuardPool.cpp

---

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