ArrayBlockingQueuePool
Related Doc:
package pool
Object "destructor".
Object "destructor". This method is called whenever the object is evicted from the pool. For example, when doing connection pooling it is necessary to close the connection whenever it is evicted (i.e. permanently removed) from the pool.
Factory method for creating new objects.
Factory method for creating new objects.
a new object.
An health check that is performed on an object before its leased from the pool.
An health check that is performed on an object before its leased from the pool. If the health check passes the object is successfully leased. Otherwise, the object is destroyed (and a new one is fetched or created)
Resets the internal state of object.
Resets the internal state of object. This method is called on an object whenever it is
added/released back to the pool. For example, if pooling an object like a
java.nio.ByteBuffer it might make sense to call its reset() method whenever the object
is released to the pool, so that its future users do not observe the internal state introduced
by previous ones.
Acquire a lease for an object blocking if none is available.
Acquire a lease for an object blocking if none is available.
a lease for an object from this pool.
Returns the capacity of the pool, i.e.
Returns the capacity of the pool, i.e. the maximum number of objects the pool can hold.
the capacity of the pool.
Drains the object pool, i.e.
Drains the object pool, i.e. evicts every object currently pooled.
Fills the object pool by creating (and pooling) new objects until the number of live objects reaches the pool capacity.
Fills the object pool by creating (and pooling) new objects until the number of live objects reaches the pool capacity.
Returns the number of leased objects.
Returns the number of leased objects.
The value returned by this method is only accurate when the referenceType is
io.github.andrebeat.pool.ReferenceType.Strong, since GC-based eviction is checked only
when trying to acquire an object.
the number of leased objects.
Returns the number of live objects, i.e.
Returns the number of live objects, i.e. the number of currently pooled objects plus leased objects.
The value returned by this method is only accurate when the referenceType is
io.github.andrebeat.pool.ReferenceType.Strong, since GC-based eviction is checked only
when trying to acquire an object.
the number of live objects.
Returns the io.github.andrebeat.pool.ReferenceType of the objects stored in the pool.
Returns the io.github.andrebeat.pool.ReferenceType of the objects stored in the pool.
Returns the number of objects in the pool.
Returns the number of objects in the pool.
The value returned by this method is only accurate when the referenceType is
io.github.andrebeat.pool.ReferenceType.Strong, since GC-based eviction is checked only
when trying to acquire an object.
the number of objects in the pool.
Try to acquire a lease for an object blocking at most until the given duration.
Try to acquire a lease for an object blocking at most until the given duration.
maximum wait time for the lease to be available.
a lease for an object from this pool if available until the given duration, None otherwise.
Try to acquire a lease for an object without blocking.
Try to acquire a lease for an object without blocking.
a lease for an object from this pool if available, None otherwise.
A generic object pooling implementation based on java.util.concurrent.ArrayBlockingQueue. This implementation relies on the thread-safety and blocking/non-blocking mechanisms of the underlying data structure to implement the pool interface. Furthermore, for synchronization and tracking of live instances an java.util.concurrent.atomic.AtomicInteger is used. No locks are used in this implementation.
The type of items inserted in the queue must implement the
Iteminterface. This class defines methods for consuming the item (e.g. disposing of any resources associated with it) and a method that's called whenever an item is successfully inserted into the queue (useful for triggering a side-effect). This class is also responsible for dealing with the reference type that's wrapping the value (i.e. ensure calling its destructor if the value is defined).