com.mongodb

Class ConcurrentPool<T>

java.lang.Object

com.mongodb.ConcurrentPool<T>

class ConcurrentPool<T>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static interface	ConcurrentPool.ItemFactory<T> Factory for creating and closing pooled items.

Field Summary

Fields

Modifier and Type	Field and Description
private Deque<T>	available
private boolean	closed
private ConcurrentPool.ItemFactory<T>	itemFactory
private int	maxSize
private java.util.concurrent.Semaphore	permits

Constructor Summary

Constructors

Constructor and Description
ConcurrentPool(int maxSize, ConcurrentPool.ItemFactory<T> itemFactory) Initializes a new pool of objects.

Method Summary

Modifier and Type	Method and Description
protected boolean	acquirePermit(long timeout, java.util.concurrent.TimeUnit timeUnit)
void	close() Clears the pool of all objects.
private void	close(T t)
private T	createNewAndReleasePermitIfFailure()
void	ensureMinSize(int minSize)
T	get() Gets an object from the pool.
T	get(long timeout, java.util.concurrent.TimeUnit timeUnit) Gets an object from the pool - will block if none are available
int	getAvailableCount()
int	getCount()
int	getInUseCount()
int	getMaxSize()
void	prune()
void	release(T t) Return an instance of T to the pool.
void	release(T t, boolean prune) call done when you are done with an object from the pool if there is room and the object is ok will get added
protected void	releasePermit()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

maxSize

private final int maxSize

itemFactory

private final ConcurrentPool.ItemFactory<T> itemFactory

available

private final Deque<T> available

permits

private final java.util.concurrent.Semaphore permits

closed

private volatile boolean closed

Constructor Detail

ConcurrentPool

public ConcurrentPool(int maxSize,
                      ConcurrentPool.ItemFactory<T> itemFactory)

Initializes a new pool of objects.

Parameters:

maxSize - max to hold to at any given time. if < 0 then no limit

itemFactory - factory used to create and close items in the pool

Method Detail

release

public void release(T t)

Return an instance of T to the pool. This method simply calls release(t, false)

Parameters:

t - item to return to the pool

release

public void release(T t,
                    boolean prune)

call done when you are done with an object from the pool if there is room and the object is ok will get added

Parameters:

t - item to return to the pool

prune - true if the item should be closed, false if it should be put back in the pool

get

public T get()

Gets an object from the pool. This method will block until a permit is available.

Returns:

An object from the pool.

get

public T get(long timeout,
             java.util.concurrent.TimeUnit timeUnit)

Gets an object from the pool - will block if none are available

Parameters:

timeout - negative - forever 0 - return immediately no matter what positive ms to wait

timeUnit - the time unit of the timeout

Returns:

An object from the pool, or null if can't get one in the given waitTime

Throws:

MongoTimeoutException - if the timeout has been exceeded

prune

public void prune()

ensureMinSize

public void ensureMinSize(int minSize)

createNewAndReleasePermitIfFailure

private T createNewAndReleasePermitIfFailure()

acquirePermit

protected boolean acquirePermit(long timeout,
                                java.util.concurrent.TimeUnit timeUnit)

releasePermit

protected void releasePermit()

close

public void close()

Clears the pool of all objects.

getMaxSize

public int getMaxSize()

getInUseCount

public int getInUseCount()

getAvailableCount

public int getAvailableCount()

getCount

public int getCount()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

private void close(T t)