Pool (u.bf0d62e7ee2c024947452a0e4fb3c2b8.caqti.1.1.0.doc.caqti.blocking.Caqti

type ('a, +'e) t

val create : 
  ?max_size:int ->
  ?check:('a -> (bool -> unit) -> unit) ->
  ?validate:('a -> bool future) ->
  (unit -> ('a, 'e) result future) ->
  ('a -> unit future) ->
  ('a, 'e) t

Internal: create alloc free is a pool of resources allocated by alloc and freed by free. This is primarily indented for implementing the connect_pool functions.

parameter max_size
Maximum number of resources to allocate at any given time.

parameter check
A function used to check a resource after use.

parameter validate
A function to check before use that a resource is still valid.

val size : ('a, 'e) t -> int

size pool is the current number of open resources in pool.

val use : 
  ?priority:float ->
  ('a -> ('b, 'e) result future) ->
  ('a, 'e) t ->
  ('b, 'e) result future

use f pool calls f on a resource drawn from pool, handing back the resource to the pool when f exits.

parameter priority
Requests for the resource are handled in decreasing order of priority. The default priority is 0.0.

val drain : ('a, 'e) t -> unit future

drain pool closes all resources in pool. The pool is still usable, as new resources will be created on demand.