package pool
This library provides classes for dealing with object pooling that allow:
- blocking/non-blocking object acquisition
- object invalidation
- capping the number of pooled objects
- creating new objects lazily, as needed
- health checking
- time-based pool eviction (idle instances)
- GC-based pool eviction (soft and weak references)
- efficient thread-safety
Overview
In order create a new io.github.andrebeat.pool.Pool the constructor method should be used like so
scala> val pool = Pool(4, () => new Object) pool: io.github.andrebeat.pool.SimplePool[Object] = _ scala> val lease = pool.acquire() lease: io.github.andrebeat.pool.Lease[Object] = _ scala> lease.release()
Additionally, in order to avoid manually releasing the lease after its used,
you can use the use method on the lease:
scala> val pool = Pool(4, () => new Object) pool: io.github.andrebeat.pool.SimplePool[Object] = _ scala> val lease = pool.acquire() lease: io.github.andrebeat.pool.Lease[Object] = _ scala> lease(println) // the lease is released automatically after its used java.lang.Object@7970d6d
- Alphabetic
- By Inheritance
- pool
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract class ArrayBlockingQueuePool[A <: AnyRef] extends Pool[A]
A generic object pooling implementation based on java.util.concurrent.ArrayBlockingQueue.
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). - class ExpiringPool[A <: AnyRef] extends ArrayBlockingQueuePool[A]
An object pool that creates the objects as needed until a maximum number of objects has been created and automatically evicts objects after they have been idle for a given amount of time.
- trait Lease[A <: AnyRef] extends AnyRef
A lease on an object requested from a io.github.andrebeat.pool.Pool allowing the object to be accessed and then released back to the pool when no longer needed.
A lease on an object requested from a io.github.andrebeat.pool.Pool allowing the object to be accessed and then released back to the pool when no longer needed.
- A
the type of object stored in this lease
- trait Pool[A <: AnyRef] extends AnyRef
A pool of objects that may be leased.
A pool of objects that may be leased. It is expected that all implementations of this trait are thread-safe.
- A
the type of object to pool
- sealed trait ReferenceType extends AnyRef
An enum-type for Java reference types.
- class SimplePool[A <: AnyRef] extends ArrayBlockingQueuePool[A]
A simple object pool that creates the objects as needed until a maximum number of objects has been created.
Value Members
- object ExpiringPool
Object containing factory methods for io.github.andrebeat.pool.ExpiringPool.
- object Pool
Object containing factory methods for io.github.andrebeat.pool.Pool.
- object ReferenceType
- object SimplePool
Object containing factory methods for io.github.andrebeat.pool.SimplePool.