com.cs.software.engine.threadpool

Class PoolMgr

java.lang.Object

com.cs.software.engine.FrameworkBase

com.cs.software.engine.threadpool.PoolMgr

All Implemented Interfaces:

FrameworkIntf, Serializable

public class PoolMgr
extends FrameworkBase

This class PoolMgr implements a Thread Pool. Thread Pool simply keeps a bunch of suspended threads around to do some work.

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields inherited from class com.cs.software.engine.FrameworkBase

active, initMessage, inProcess, jvmService, running, serviceData, totalErrors, totalMessages, totalProcessed

Fields inherited from interface com.cs.software.api.FrameworkIntf

CATEGROY_ADAPTER, CATEGROY_APP, CATEGROY_DB_CON, CATEGROY_DB_POOL, CATEGROY_ENGINE, CATEGROY_MODULE, CATEGROY_POOL_MGR, CATEGROY_QUEUE, CATEGROY_THREAD_MGR, CATEGROY_WORKER, COMMAND_DEREGISTER_KEY, COMMAND_PAUSE, COMMAND_REGISTER_KEY, COMMAND_RESTART, COMMAND_SHUTDOWN, COMMAND_START, COMMAND_STOP, FLAG_FALSE, FLAG_TRUE, PARAM_JVM_STR, PARAM_JVMID_STR, PARAM_SERVERNAME_STR, PARAM_SERVICEACTIVE_STR, PARAM_SERVICECATAGORY_STR, PARAM_SERVICENAME_STR, PARAM_SERVICERUNNING_STR, TYPE_CLUSTER, TYPE_DISPLAY_STR, TYPE_EVENT, TYPE_JVM, TYPE_JVM_STR, TYPE_MAX, TYPE_SERVER, TYPE_SERVICE

Constructor Summary

Constructors

Constructor and Description
PoolMgr() Constructor - creates a new thread Pool

Method Summary

Modifier and Type	Method and Description
int	getDefError()
int	getMaxTotalThreads() This method getMaxTotalThreads will return the total number of max threads reached.
String	getName() This method will return the pool manager name.
MessageIntf	getPoolServiceData(String aName) This method will return a new ServiceData based on the suppplied serice name.
List<WorkerThread>	getThreadList()
int	getThreadPriority() This method will return the thread priority
Collection<WorkerThread>	getThreadsList()
int	getTotalRunning() This method will return the internal memory queue name.
List<Object>	getWorkersServiceData()
void	init(ThreadMgr aThreadMgr, int aMin, int aMax, int aPriority, Class<ServicesIntf> aServicesClass) Initializes a new Pool instance
void	performWork(MessageIntf aMsg) Request the Pool to perform some work.
void	reaper() This method is called by a cleanup thread to removed unused and inactive threads.
void	reaper(boolean aForce)
void	shutdown() This method is called to gracefully shutdown, stop the threads and free resources.

Methods inherited from class com.cs.software.engine.FrameworkBase

addInProcess, addTotalErrorNumber, addTotalMsgNumber, addTotalProcessed, deRegister, deRegister, doEventMessage, doMessage, getInProcess, getJvmId, getJvmService, getService, getServiceData, getServiceName, getStats, getTotalErrorNumber, getTotalMsgNumber, getTotalProcessed, initMessage, isActive, isRunning, register, register, resetTotals, setActive, setRunning, setServiceData, subtractInProcess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PoolMgr

public PoolMgr()

Constructor - creates a new thread Pool

Method Detail

init

public void init(ThreadMgr aThreadMgr,
                 int aMin,
                 int aMax,
                 int aPriority,
                 Class<ServicesIntf> aServicesClass)
          throws Exception

Initializes a new Pool instance

Parameters:

aThreadMgr - an ThreadMgr Manages all Thread Pools

aMin - an int Min Threads

aMax - an int Max Threads

aPriority - an int Thread Priority

aServicesClass - a Class Java Worker Class

Throws:

Exception - ex

getThreadPriority

public int getThreadPriority()

This method will return the thread priority

Returns:

int Thread priority

getName

public String getName()

This method will return the pool manager name.

Specified by:

getName in interface FrameworkIntf

Overrides:

getName in class FrameworkBase

Returns:

a String Pool manager name

getTotalRunning

public int getTotalRunning()

This method will return the internal memory queue name.

Returns:

a String Internal memory queue name

performWork

public void performWork(MessageIntf aMsg)
                 throws InstantiationException

Request the Pool to perform some work.

Parameters:

aMsg - Data to give to the Worker

Throws:

InstantiationException - Thrown if additional worker can't be created

getMaxTotalThreads

public int getMaxTotalThreads()

This method getMaxTotalThreads will return the total number of max threads reached.

Returns:

an int Total max number of threads

reaper

public void reaper()

This method is called by a cleanup thread to removed unused and inactive threads.

reaper

public void reaper(boolean aForce)

getThreadList

public List<WorkerThread> getThreadList()

getPoolServiceData

public MessageIntf getPoolServiceData(String aName)

This method will return a new ServiceData based on the suppplied serice name.

Parameters:

aName - string Service Name

Returns:

ServiceData New instance

getWorkersServiceData

public List<Object> getWorkersServiceData()

shutdown

public void shutdown()

This method is called to gracefully shutdown, stop the threads and free resources.

getThreadsList

public Collection<WorkerThread> getThreadsList()

getDefError

public int getDefError()

Overrides:

getDefError in class FrameworkBase