KeyPool

org.typelevel.keypool.KeyPool
See theKeyPool companion object
trait KeyPool[F[_], A, B]

This pools internal guarantees are that the max number of values are in the pool at any time, not maximum number of operations. To do the latter application level bounds should be used.

A background reaper thread is kept alive for the length of the key pools life.

When resources are taken from the pool they are received as a Managed. This Managed has a Ref to a Reusable which indicates whether or not the pool can reuse the resource.

Attributes

Companion
object
Source
KeyPool.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def state: F[(Int, Map[A, Int])]

The current state of the pool.

The current state of the pool.

The left value is the total number of resources currently in the pool, and the right is a map of how many resources exist for each key.

Attributes

Source
KeyPool.scala
def take(k: A): Resource[F, Managed[F, B]]

Take a Managed from the Pool.

Take a Managed from the Pool. For the lifetime of this resource this is exclusively available to this key.

At the end of the resource lifetime the state of the resource controls whether it is submitted back to the pool or removed.

Attributes

Source
KeyPool.scala