package caqti-lwt

You can search for identifiers within the package.

in-package search v0.2.0

caqti-lwt
- Caqti_lwt
  - CONNECTION
    
    Response
  - Pool
- Caqti_lwt_sql_io
caqti-lwt.v1
- Caqti1_lwt
  - CONNECTION
    
    Param
    
    Tuple
  - Pool

Legend:
Library
Module
Module type
Parameter
Class
Class type

This is an instantiation of Caqti_pool for the chosen thread monad.

type 'a t

val create : 
  ?max_size:int ->
  ?check:('a -> (bool -> unit) -> unit) ->
  ?validate:('a -> bool Lwt.t) ->
  (unit -> 'a Lwt.t) ->
  ('a -> unit Lwt.t) ->
  'a 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 t -> int

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

val use : ?priority:float -> ('a -> 'b Lwt.t) -> 'a t -> 'b Lwt.t

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 t -> unit Lwt.t

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