stormpot 3.1 · stormpot.BlazePool

Modifier and Type	Field and Description
private final AllocationController<T>	allocator
private final Expiration<? super T>	deallocRule
private final RefillPile<T>	disregardPile
pack-priv static final Exception	EXPLICIT_EXPIRE_POISON
private final LinkedTransferQueue<BSlot<T>>	live
private final MetricsRecorder	metricsRecorder
private final RefillPile<T>	newAllocations
private final BSlot<T>	poisonPill A special slot used to signal that the pool has been shut down.
private volatile boolean	shutdown
private static final Exception	SHUTDOWN_POISON
private final ThreadLocal<BSlotCache<T>>	tlr

Access	Constructor and Description
pack-priv	BlazePool(PoolBuilder<T> The pool configuration to use. builder, AllocationProcess factory) Construct a new BlazePool instance based on the given `PoolBuilder`.

Method Summary

Modifier and Type	Method and Description
public T	claim(Timeout The timeout of the maximum permitted time-slice to wait for an object to become available. A timeout with a value of zero or less means that the call will do no waiting, preferring instead to return early if no objects are available. timeout) Implements abstract stormpot.PoolTap.claim. Claim the exclusive rights until released, to an object in the pool.
private boolean	dealWithSlotPoison(BSlot<T> slot, BSlotCache<T> cache, boolean isTlr, Exception poison)
public long	getAllocationCount() Implements stormpot.ManagedPool.getAllocationCount. Return the number of objects the pool has allocated since it was created.
public double	getAllocationFailureLatencyPercentile(double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. percentile) Implements stormpot.ManagedPool.getAllocationFailureLatencyPercentile. Get the approximate latency value, in milliseconds, for failed allocation latencies within the given percentile/quantile of what has been recorded so far.
public double	getAllocationLatencyPercentile(double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. percentile) Implements stormpot.ManagedPool.getAllocationLatencyPercentile. Get the approximate Poolable object allocation latency value, in milliseconds, of the given percentile/quantile of the values recorded so far.
public double	getDeallocationLatencyPercentile(double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. percentile) Implements stormpot.ManagedPool.getDeallocationLatencyPercentile. Get the approximate latency value, in milliseconds, for deallocation latencies within the given percentile/quantile of what has been recorded so far.
public long	getFailedAllocationCount() Implements stormpot.ManagedPool.getFailedAllocationCount. Return the number of allocations that has failed, either because the allocator threw an exception or because it returned null, since the pool was created.
public long	getLeakedObjectsCount() Implements stormpot.ManagedPool.getLeakedObjectsCount. If the pool is capable of precise object leak detection, this method will return the number of object leaks that have been detected, and prevented, since the pool was created.
public ManagedPool	getManagedPool() Implements abstract stormpot.Pool.getManagedPool. Get the `ManagedPool` instance that represents this pool.
public double	getObjectLifetimePercentile(double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. percentile) Implements stormpot.ManagedPool.getObjectLifetimePercentile. Get the approximate object lifetime, in milliseconds, for the given percentile/quantile.
public double	getReallocationFailureLatencyPercentile(double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. percentile) Implements stormpot.ManagedPool.getReallocationFailureLatencyPercentile. Get the approximate latency value, in milliseconds, for failed reallocation latencies within the given percentile/quantile of what has been recorded so far.
public double	getReallocationLatencyPercentile(double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. percentile) Implements stormpot.ManagedPool.getReallocationLatencyPercentile. Get the approximate latency value, in milliseconds, for reallocation latencies within the given percentile/quantile of what has been recorded so far.
public int	getTargetSize() Implements abstract stormpot.Pool.getTargetSize. Implements stormpot.ManagedPool.getTargetSize. Get the current target size of the pool.
public PoolTap<T>	getThreadLocalTap() Implements abstract stormpot.Pool.getThreadLocalTap. Get a `PoolTap` that only support access by one thread at a time.
private boolean	handleCommonInvalidation(BSlot<T> slot, BSlotCache<T> cache, Throwable exception)
private boolean	handleUncommonInvalidation(BSlot<T> slot, BSlotCache<T> cache, boolean isTlr)
private boolean	isInvalid(BSlot<T> slot, BSlotCache<T> cache, boolean isTlr)
public boolean	isShutDown() Implements stormpot.ManagedPool.isShutDown. Returns 'true' if the shut down process has been started on this pool, 'false' otherwise.
private boolean	isUncommonlyInvalid(BSlot<T> slot)
private void	kill(BSlot<T> slot, BSlotCache<T> cache)
public void	setTargetSize(int The new target size. size) Implements abstract stormpot.Pool.setTargetSize. Implements stormpot.ManagedPool.setTargetSize. Set a new target size of the pool.
public Completion	shutdown() Implements abstract stormpot.Pool.shutdown. Initiate the shut down process on this pool, and return a `Completion` instance representing the shut down procedure.
private T	slowClaim(Timeout timeout, BSlotCache<T> cache)
pack-priv T	tlrClaim(Timeout timeout, BSlotCache<T> cache)

Inherited from stormpot.Pool:: from fromInline fromThreaded getThreadSafeTap of

allocator	back to summary
private final AllocationController<T> allocator

deallocRule	back to summary
private final Expiration<? super T> deallocRule

disregardPile	back to summary
private final RefillPile<T> disregardPile

EXPLICIT_EXPIRE_POISON	back to summary
pack-priv static final Exception EXPLICIT_EXPIRE_POISON

live	back to summary
private final LinkedTransferQueue<BSlot<T>> live

metricsRecorder	back to summary
private final MetricsRecorder metricsRecorder

newAllocations	back to summary
private final RefillPile<T> newAllocations

poisonPill	back to summary
private final BSlot<T> poisonPill A special slot used to signal that the pool has been shut down.

shutdown	back to summary
private volatile boolean shutdown

SHUTDOWN_POISON	back to summary
private static final Exception SHUTDOWN_POISON

tlr	back to summary
private final ThreadLocal<BSlotCache<T>> tlr

BlazePool	back to summary
pack-priv BlazePool(PoolBuilder<T> builder, AllocationProcess factory) Construct a new BlazePool instance based on the given `PoolBuilder`. Parameters builder:PoolBuilder<T> The pool configuration to use.

Method Detail

claim back to summary

claim	back to summary
public T claim(Timeout timeout) throws PoolException, InterruptedException Implements abstract stormpot.PoolTap.claim. Doc from stormpot.PoolTap.claim. Claim the exclusive rights until released, to an object in the pool. Possibly waiting up to the specified amount of time, as given by the provided `Timeout` instance, for one to become available if the pool has been depleted. If the timeout elapses before an object can be claimed, then `null` is returned instead. The timeout will be honoured even if the Allocators `allocate` methods blocks forever. If the given timeout has a zero or negative value, then the method will not wait. If the current thread has already one or more objects currently claimed, then a distinct object will be returned, if one is or becomes available. This means that it is possible for a single thread to deplete the pool, if it so desires. However, doing so is inherently deadlock prone, so avoid claiming more than one object at a time per thread, if at all possible. This method may throw a PoolException if the pool have trouble allocating objects. That is, if its assigned Allocator throws exceptions from its allocate method, or returns `null`. An `InterruptedException` will be thrown if the thread has its interrupted flag set upon entry to this method, or is interrupted while waiting. The interrupted flag on the thread will be cleared after this, as per the general contract of interruptible methods. If the pool has been shut down, then an `IllegalStateException` will be thrown when this method is called. Likewise if we are waiting for an object to become available, and someone shuts the pool down. Here's an example code snippet, where an object is claimed, printed to `System.out`, and then released back to the pool: [source,java] ---- include::../src/test/java/examples/Examples.java[tag=poolClaimPrintExample] ---- Memory effects: * The `release` of an object happens-before any subsequent claim or `deallocation` of that object, and, * The `allocation` of an object happens-before any claim of that object. Parameters timeout:Timeout The timeout of the maximum permitted time-slice to wait for an object to become available. A timeout with a value of zero or less means that the call will do no waiting, preferring instead to return early if no objects are available. Returns:T An object of the Poolable subtype T to which the exclusive rights have been claimed, or `null` if the timeout period elapsed before an object became available. Annotations @Override Exceptions PoolException: If an object allocation failed because the Allocator threw an exception from its allocate method, or returned `null`, or the `expiration check` threw an exception. InterruptedException: if the current thread is `interrupted` upon entry, or becomes interrupted while waiting.

public T claim(Timeout timeout) throws PoolException, InterruptedException

Implements abstract stormpot.PoolTap.claim.

Doc from stormpot.PoolTap.claim.

Claim the exclusive rights until released, to an object in the pool. Possibly waiting up to the specified amount of time, as given by the provided Timeout instance, for one to become available if the pool has been depleted. If the timeout elapses before an object can be claimed, then `null` is returned instead. The timeout will be honoured even if the Allocators allocate methods blocks forever. If the given timeout has a zero or negative value, then the method will not wait. If the current thread has already one or more objects currently claimed, then a distinct object will be returned, if one is or becomes available. This means that it is possible for a single thread to deplete the pool, if it so desires. However, doing so is inherently deadlock prone, so avoid claiming more than one object at a time per thread, if at all possible. This method may throw a PoolException if the pool have trouble allocating objects. That is, if its assigned Allocator throws exceptions from its allocate method, or returns `null`. An InterruptedException will be thrown if the thread has its interrupted flag set upon entry to this method, or is interrupted while waiting. The interrupted flag on the thread will be cleared after this, as per the general contract of interruptible methods. If the pool has been shut down, then an IllegalStateException will be thrown when this method is called. Likewise if we are waiting for an object to become available, and someone shuts the pool down. Here's an example code snippet, where an object is claimed, printed to `System.out`, and then released back to the pool: [source,java] ---- include::../src/test/java/examples/Examples.java[tag=poolClaimPrintExample] ---- Memory effects: * The release of an object happens-before any subsequent claim or deallocation of that object, and, * The allocation of an object happens-before any claim of that object.

Parameters

timeout:Timeout: The timeout of the maximum permitted time-slice to wait for an object to become available. A timeout with a value of zero or less means that the call will do no waiting, preferring instead to return early if no objects are available.

Returns:T

An object of the Poolable subtype T to which the exclusive rights have been claimed, or `null` if the timeout period elapsed before an object became available.

Annotations

@Override

Exceptions

PoolException:: If an object allocation failed because the Allocator threw an exception from its allocate method, or returned `null`, or the expiration check threw an exception.
InterruptedException:: if the current thread is interrupted upon entry, or becomes interrupted while waiting.

dealWithSlotPoison	back to summary
private boolean dealWithSlotPoison(BSlot<T> slot, BSlotCache<T> cache, boolean isTlr, Exception poison)

getAllocationCount	back to summary
public long getAllocationCount() Implements stormpot.ManagedPool.getAllocationCount. Doc from stormpot.ManagedPool.getAllocationCount. Return the number of objects the pool has allocated since it was created. Returns:long The number of Poolable objects ever created by this pool. Annotations @Override

getAllocationCount

back to summary

public long getAllocationCount()

Implements stormpot.ManagedPool.getAllocationCount.

Doc from stormpot.ManagedPool.getAllocationCount.

Return the number of objects the pool has allocated since it was created.

Returns:long

The number of Poolable objects ever created by this pool.

Annotations

@Override

getAllocationFailureLatencyPercentile back to summary

getAllocationFailureLatencyPercentile	back to summary
public double getAllocationFailureLatencyPercentile(double percentile) Implements stormpot.ManagedPool.getAllocationFailureLatencyPercentile. Doc from stormpot.ManagedPool.getAllocationFailureLatencyPercentile. Get the approximate latency value, in milliseconds, for failed allocation latencies within the given percentile/quantile of what has been recorded so far. Parameters percentile:double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. Returns:double The approximate latency for failed allocations in milliseconds, for the given percentile, or Double.NaN if no `stormpot.MetricsRecorder` has been configured for the pool. Annotations @Override

public double getAllocationFailureLatencyPercentile(double percentile)

Implements stormpot.ManagedPool.getAllocationFailureLatencyPercentile.

Doc from stormpot.ManagedPool.getAllocationFailureLatencyPercentile.

Get the approximate latency value, in milliseconds, for failed allocation latencies within the given percentile/quantile of what has been recorded so far.

Parameters

percentile:double: The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0.

Returns:double

The approximate latency for failed allocations in milliseconds, for the given percentile, or Double.NaN if no stormpot.MetricsRecorder has been configured for the pool.

Annotations

@Override

getAllocationLatencyPercentile back to summary

getAllocationLatencyPercentile	back to summary
public double getAllocationLatencyPercentile(double percentile) Implements stormpot.ManagedPool.getAllocationLatencyPercentile. Doc from stormpot.ManagedPool.getAllocationLatencyPercentile. Get the approximate Poolable object allocation latency value, in milliseconds, of the given percentile/quantile of the values recorded so far. Parameters percentile:double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. Returns:double The approximate latency for allocations in milliseconds, for the given percentile, or Double.NaN if no `stormpot.MetricsRecorder` has been configured for the pool. Annotations @Override

public double getAllocationLatencyPercentile(double percentile)

Implements stormpot.ManagedPool.getAllocationLatencyPercentile.

Doc from stormpot.ManagedPool.getAllocationLatencyPercentile.

Get the approximate Poolable object allocation latency value, in milliseconds, of the given percentile/quantile of the values recorded so far.

Parameters

percentile:double: The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0.

Returns:double

The approximate latency for allocations in milliseconds, for the given percentile, or Double.NaN if no stormpot.MetricsRecorder has been configured for the pool.

Annotations

@Override

getDeallocationLatencyPercentile back to summary

getDeallocationLatencyPercentile	back to summary
public double getDeallocationLatencyPercentile(double percentile) Implements stormpot.ManagedPool.getDeallocationLatencyPercentile. Doc from stormpot.ManagedPool.getDeallocationLatencyPercentile. Get the approximate latency value, in milliseconds, for deallocation latencies within the given percentile/quantile of what has been recorded so far. Parameters percentile:double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. Returns:double The approximate latency for deallocations, regardless of whether the throw exceptions or not, in milliseconds for the given percentile, or Double.NaN if no `stormpot.MetricsRecorder` has been configured for the pool. Annotations @Override

public double getDeallocationLatencyPercentile(double percentile)

Implements stormpot.ManagedPool.getDeallocationLatencyPercentile.

Doc from stormpot.ManagedPool.getDeallocationLatencyPercentile.

Get the approximate latency value, in milliseconds, for deallocation latencies within the given percentile/quantile of what has been recorded so far.

Parameters

percentile:double: The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0.

Returns:double

The approximate latency for deallocations, regardless of whether the throw exceptions or not, in milliseconds for the given percentile, or Double.NaN if no stormpot.MetricsRecorder has been configured for the pool.

Annotations

@Override

getFailedAllocationCount	back to summary
public long getFailedAllocationCount() Implements stormpot.ManagedPool.getFailedAllocationCount. Doc from stormpot.ManagedPool.getFailedAllocationCount. Return the number of allocations that has failed, either because the allocator threw an exception or because it returned null, since the pool was created. Returns:long The number of allocations that have failed for one reason or another. Annotations @Override

getFailedAllocationCount

back to summary

public long getFailedAllocationCount()

Implements stormpot.ManagedPool.getFailedAllocationCount.

Doc from stormpot.ManagedPool.getFailedAllocationCount.

Return the number of allocations that has failed, either because the allocator threw an exception or because it returned null, since the pool was created.

Returns:long

The number of allocations that have failed for one reason or another.

Annotations

@Override

getLeakedObjectsCount	back to summary
public long getLeakedObjectsCount() Implements stormpot.ManagedPool.getLeakedObjectsCount. Doc from stormpot.ManagedPool.getLeakedObjectsCount. If the pool is capable of precise object leak detection, this method will return the number of object leaks that have been detected, and prevented, since the pool was created. If the pool does not support precise object leak detection, then this method returns -1. There are two kinds of leaks: One where the application forgets to release an object back to the pool, but keeps a strong reference to the object, and another where the application not only forgets to release the object, but also looses the reference to the object, making it eligible for garbage collection. The precise leak detector will only count leaks of the latter kind, where the leaked object has been garbage collected. Returns:long The number of objects leaked from the users of this pool, since the pool was created, or -1 if the pool does not implement precise leak detection. Annotations @Override

getLeakedObjectsCount

back to summary

public long getLeakedObjectsCount()

Implements stormpot.ManagedPool.getLeakedObjectsCount.

Doc from stormpot.ManagedPool.getLeakedObjectsCount.

If the pool is capable of precise object leak detection, this method will return the number of object leaks that have been detected, and prevented, since the pool was created. If the pool does not support precise object leak detection, then this method returns -1. There are two kinds of leaks: One where the application forgets to release an object back to the pool, but keeps a strong reference to the object, and another where the application not only forgets to release the object, but also looses the reference to the object, making it eligible for garbage collection. The precise leak detector will only count leaks of the latter kind, where the leaked object has been garbage collected.

Returns:long

The number of objects leaked from the users of this pool, since the pool was created, or -1 if the pool does not implement precise leak detection.

Annotations

@Override

getManagedPool back to summary

getManagedPool	back to summary
public ManagedPool getManagedPool() Implements abstract stormpot.Pool.getManagedPool. Doc from stormpot.Pool.getManagedPool. Get the `ManagedPool` instance that represents this pool. Returns:ManagedPool The `ManagedPool` instance for this pool. Annotations @Override

public ManagedPool getManagedPool()

Implements abstract stormpot.Pool.getManagedPool.

Doc from stormpot.Pool.getManagedPool.

Get the ManagedPool instance that represents this pool.

Returns:ManagedPool

The ManagedPool instance for this pool.

Annotations

@Override

getObjectLifetimePercentile back to summary

getObjectLifetimePercentile	back to summary
public double getObjectLifetimePercentile(double percentile) Implements stormpot.ManagedPool.getObjectLifetimePercentile. Doc from stormpot.ManagedPool.getObjectLifetimePercentile. Get the approximate object lifetime, in milliseconds, for the given percentile/quantile. Parameters percentile:double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. Returns:double The approximate object lifetime in milliseconds, for the given percentile, or Double.NaN if no `stormpot.MetricsRecorder` has been configured for the pool. Annotations @Override

public double getObjectLifetimePercentile(double percentile)

Implements stormpot.ManagedPool.getObjectLifetimePercentile.

Doc from stormpot.ManagedPool.getObjectLifetimePercentile.

Get the approximate object lifetime, in milliseconds, for the given percentile/quantile.

Parameters

percentile:double: The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0.

Returns:double

The approximate object lifetime in milliseconds, for the given percentile, or Double.NaN if no stormpot.MetricsRecorder has been configured for the pool.

Annotations

@Override

getReallocationFailureLatencyPercentile back to summary

getReallocationFailureLatencyPercentile	back to summary
public double getReallocationFailureLatencyPercentile(double percentile) Implements stormpot.ManagedPool.getReallocationFailureLatencyPercentile. Doc from stormpot.ManagedPool.getReallocationFailureLatencyPercentile. Get the approximate latency value, in milliseconds, for failed reallocation latencies within the given percentile/quantile of what has been recorded so far. Parameters percentile:double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. Returns:double The approximate latency for failed reallocations in milliseconds, for the given percentile, or Double.NaN if no `stormpot.MetricsRecorder` has been configured for the pool. Annotations @Override

public double getReallocationFailureLatencyPercentile(double percentile)

Implements stormpot.ManagedPool.getReallocationFailureLatencyPercentile.

Doc from stormpot.ManagedPool.getReallocationFailureLatencyPercentile.

Get the approximate latency value, in milliseconds, for failed reallocation latencies within the given percentile/quantile of what has been recorded so far.

Parameters

percentile:double: The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0.

Returns:double

The approximate latency for failed reallocations in milliseconds, for the given percentile, or Double.NaN if no stormpot.MetricsRecorder has been configured for the pool.

Annotations

@Override

getReallocationLatencyPercentile back to summary

getReallocationLatencyPercentile	back to summary
public double getReallocationLatencyPercentile(double percentile) Implements stormpot.ManagedPool.getReallocationLatencyPercentile. Doc from stormpot.ManagedPool.getReallocationLatencyPercentile. Get the approximate latency value, in milliseconds, for reallocation latencies within the given percentile/quantile of what has been recorded so far. Parameters percentile:double The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0. Returns:double The approximate latency for reallocations in milliseconds, for the given percentile, or Double.NaN if no `stormpot.MetricsRecorder` has been configured for the pool. Annotations @Override

public double getReallocationLatencyPercentile(double percentile)

Implements stormpot.ManagedPool.getReallocationLatencyPercentile.

Doc from stormpot.ManagedPool.getReallocationLatencyPercentile.

Get the approximate latency value, in milliseconds, for reallocation latencies within the given percentile/quantile of what has been recorded so far.

Parameters

percentile:double: The percentile to get, as a decimal, e.g. a number between 0.0 and 1.0.

Returns:double

The approximate latency for reallocations in milliseconds, for the given percentile, or Double.NaN if no stormpot.MetricsRecorder has been configured for the pool.

Annotations

@Override

getTargetSize	back to summary
public int getTargetSize() Implements abstract stormpot.Pool.getTargetSize. Implements stormpot.ManagedPool.getTargetSize. Doc from stormpot.ManagedPool.getTargetSize. Get the current target size of the pool. Returns:int The current target size. Annotations @Override

getTargetSize

back to summary

public int getTargetSize()

Implements abstract stormpot.Pool.getTargetSize.

Implements stormpot.ManagedPool.getTargetSize.

Doc from stormpot.ManagedPool.getTargetSize.

Get the current target size of the pool.

Returns:int

The current target size.

Annotations

@Override

getThreadLocalTap back to summary

getThreadLocalTap	back to summary
public PoolTap<T> getThreadLocalTap() Implements abstract stormpot.Pool.getThreadLocalTap. Doc from stormpot.Pool.getThreadLocalTap. Get a `PoolTap` that only support access by one thread at a time. In other words, where `claim(Timeout)` cannot be called concurrently in multiple threads on the same tap. The pool itself will still be thread-safe, but each thread that wishes to access the pool via a thread-local tap, must have their own tap instance. It is a use error to access these pool taps concurrently from multiple threads, or to transfer them from one thread to another without safe publication. Returns:PoolTap<T> A thread-local `PoolTap`. Annotations @Override

public PoolTap<T> getThreadLocalTap()

Implements abstract stormpot.Pool.getThreadLocalTap.

Doc from stormpot.Pool.getThreadLocalTap.

Get a PoolTap that only support access by one thread at a time. In other words, where claim(Timeout) cannot be called concurrently in multiple threads *on the same tap*. The pool itself will still be thread-safe, but each thread that wishes to access the pool via a thread-local tap, must have their own tap instance. It is a use error to access these pool taps concurrently from multiple threads, or to transfer them from one thread to another without safe publication.

Returns:PoolTap<T>

A thread-local PoolTap.

Annotations

@Override

handleCommonInvalidation	back to summary
private boolean handleCommonInvalidation(BSlot<T> slot, BSlotCache<T> cache, Throwable exception)

handleUncommonInvalidation	back to summary
private boolean handleUncommonInvalidation(BSlot<T> slot, BSlotCache<T> cache, boolean isTlr)

isInvalid	back to summary
private boolean isInvalid(BSlot<T> slot, BSlotCache<T> cache, boolean isTlr)

isShutDown back to summary

isShutDown	back to summary
public boolean isShutDown() Implements stormpot.ManagedPool.isShutDown. Doc from stormpot.ManagedPool.isShutDown. Returns 'true' if the shut down process has been started on this pool, 'false' otherwise. This method does not reveal whether or not the shut down process has completed. Returns:boolean 'true' if `Pool#shutdown()` has been called on this pool. Annotations @Override

public boolean isShutDown()

Implements stormpot.ManagedPool.isShutDown.

Doc from stormpot.ManagedPool.isShutDown.

Returns 'true' if the shut down process has been started on this pool, 'false' otherwise. This method does not reveal whether or not the shut down process has completed.

Returns:boolean

'true' if Pool#shutdown() has been called on this pool.

Annotations

@Override

isUncommonlyInvalid	back to summary
private boolean isUncommonlyInvalid(BSlot<T> slot)

kill	back to summary
private void kill(BSlot<T> slot, BSlotCache<T> cache)

setTargetSize	back to summary
public void setTargetSize(int size) Implements abstract stormpot.Pool.setTargetSize. Implements stormpot.ManagedPool.setTargetSize. Doc from stormpot.ManagedPool.setTargetSize. Set a new target size of the pool. Parameters size:int The new target size. Annotations @Override

setTargetSize

back to summary

public void setTargetSize(int size)

Implements abstract stormpot.Pool.setTargetSize.

Implements stormpot.ManagedPool.setTargetSize.

Doc from stormpot.ManagedPool.setTargetSize.

Set a new target size of the pool.

Parameters

size:int: The new target size.

Annotations

@Override

shutdown back to summary

shutdown	back to summary
public Completion shutdown() Implements abstract stormpot.Pool.shutdown. Doc from stormpot.Pool.shutdown. Initiate the shut down process on this pool, and return a `Completion` instance representing the shut down procedure. The shut down process is asynchronous, and the shutdown method is guaranteed to not wait for any claimed `Poolables` to be released. The shut down process cannot complete before all Poolables are released back into the pool and `deallocated`, and all internal resources (such as threads, for instance) have been released as well. Only when all of these things have been taken care of, does the await methods of the Completion return. Once the shut down process has been initiated, that is, as soon as this method is called, the pool can no longer be used and all calls to `claim(Timeout)` will throw an `IllegalStateException`. Threads that are already waiting for objects in the claim method, will also wake up and receive an `IllegalStateException`. All objects that are already claimed when this method is called, will continue to function until they are `released`. The shut down process is guaranteed to never deallocate objects that are currently claimed. Their deallocation will wait until they are released. Returns:Completion A `Completion` instance that represents the shut down process. Annotations @Override

public Completion shutdown()

Implements abstract stormpot.Pool.shutdown.

Doc from stormpot.Pool.shutdown.

Initiate the shut down process on this pool, and return a Completion instance representing the shut down procedure. The shut down process is asynchronous, and the shutdown method is guaranteed to not wait for any claimed Poolables to be released. The shut down process cannot complete before all Poolables are released back into the pool and deallocated, and all internal resources (such as threads, for instance) have been released as well. Only when all of these things have been taken care of, does the await methods of the Completion return. Once the shut down process has been initiated, that is, as soon as this method is called, the pool can no longer be used and all calls to claim(Timeout) will throw an IllegalStateException. Threads that are already waiting for objects in the claim method, will also wake up and receive an IllegalStateException. All objects that are already claimed when this method is called, will continue to function until they are released. The shut down process is guaranteed to never deallocate objects that are currently claimed. Their deallocation will wait until they are released.

Returns:Completion

A Completion instance that represents the shut down process.

Annotations

@Override

slowClaim	back to summary
private T slowClaim(Timeout timeout, BSlotCache<T> cache) throws PoolException, InterruptedException

tlrClaim	back to summary
pack-priv T tlrClaim(Timeout timeout, BSlotCache<T> cache) throws PoolException, InterruptedException

pack-priv final Class BlazePool<T extends Poolable>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail