org.restcomm.media.spi.pooling

Interface ResourcePool<T extends PooledObject>

All Known Implementing Classes:

AbstractConcurrentResourcePool, AbstractResourcePool

public interface ResourcePool<T extends PooledObject>

Represents a resource pool that manages a collection of PooledObject.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Method Summary

Methods

Modifier and Type	Method and Description
int	count() Counts the number of idle elements in the pool.
boolean	isEmpty() Checks whether the pool contains at least one element.
void	offer(T resource) Offers an object to be placed into the pool.
T	poll() Polls an object from the pool. If the pool is empty, a new object shall be created.
void	release() Releases all resources held by the pool.
int	size() Gets the maximum size of the pool.

Method Detail

poll

T poll()

Polls an object from the pool.
If the pool is empty, a new object shall be created.

Returns:

An object from the pool.

offer

void offer(T resource)

Offers an object to be placed into the pool.

Parameters:

resource - The object to be placed into the pool.

release

void release()

Releases all resources held by the pool.

count

int count()

Counts the number of idle elements in the pool.

Returns:

the number of elements in the pool.

size

int size()

Gets the maximum size of the pool.

Returns:

The pool size

isEmpty

boolean isEmpty()

Checks whether the pool contains at least one element.

Returns:

Returns true is empty, false otherwise.