Package com.j_spaces.kernel.pool

Class ResourcePool<R extends IResource>

java.lang.Object

com.j_spaces.kernel.pool.ResourcePool<R>

All Implemented Interfaces:

IResourcePool<R>

Direct Known Subclasses:

BlockingResourcePool, MemoryBoundedResourcePool

public class ResourcePool<R extends IResource>
extends Object
implements IResourcePool<R>

A Bound Pool of Resource objects. At construction, the pool consumes as many as minResources resources. When a resource requests is submitted, and less than maxResources are being used, a free resource will be returned from the pool. When all resources are in use, a new Resource will be allocated by the resourceFactory. There can be no more than maxResources in the pool, and excessive resources are discarded.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ResourcePool(IResourceFactory<R> resourceFactory, int minResources, int maxResources)	Creates a new Resources Pool with the specified resourceFactory, and max Resources.
protected	ResourcePool(IResourceFactory<R> resourceFactory, int minResources, int maxResources, R[] initialResources)	Creates a new Resources Pool with the specified resourceFactory, and max Resources.

Method Summary

Modifier and Type	Method	Description
int	availableResources()
void	forAllResources(IResourceProcedure<R> procedure)
void	freeResource(R resourceToFree)	Free the specified resource.
R	getResource()
R	getResource(boolean waitIfNeeded)	Returns a Resource from the pool.
protected R	handleFullPool(boolean waitIfNeeded)
int	size()
protected R	tryAllocateNewPooledResource()

Methods inherited from class java.lang.Object

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

Constructor Details

ResourcePool

public ResourcePool(IResourceFactory<R> resourceFactory,
 int minResources,
 int maxResources)

Creates a new Resources Pool with the specified resourceFactory, and max Resources.

Parameters:

resourceFactory - resource factory instance for new resources

minResources - resources to pre-allocate; can be zero

maxResources - upper bound on the number of resources

ResourcePool

protected ResourcePool(IResourceFactory<R> resourceFactory,
 int minResources,
 int maxResources,
 R[] initialResources)

Creates a new Resources Pool with the specified resourceFactory, and max Resources.

Parameters:

resourceFactory - resource factory instance for new resources

minResources - resources to pre-allocate; can be zero

maxResources - upper bound on the number of resources

initialResources - initial array of resources to init the pool with

Method Details

getResource

public R getResource()

Specified by:

getResource in interface IResourcePool<R extends IResource>

getResource

public R getResource(boolean waitIfNeeded)

Returns a Resource from the pool. If there is an un-used Resource in the pool, it is returned; otherwise, a new Resource is created and added to the pool.

Specified by:

getResource in interface IResourcePool<R extends IResource>

Returns:

free Resource allocated to this request

tryAllocateNewPooledResource

protected R tryAllocateNewPooledResource()

handleFullPool

protected R handleFullPool(boolean waitIfNeeded)

freeResource

public void freeResource(R resourceToFree)

Free the specified resource. Same as calling IResource.release()

Specified by:

freeResource in interface IResourcePool<R extends IResource>

availableResources

public int availableResources()

Specified by:

availableResources in interface IResourcePool<R extends IResource>

size

public int size()

Specified by:

size in interface IResourcePool<R extends IResource>

forAllResources

public void forAllResources(IResourceProcedure<R> procedure)

Specified by:

forAllResources in interface IResourcePool<R extends IResource>