package fuseau

You can search for identifiers within the package.

in-package search v0.2.0

A simple IO and concurrency library for OCaml 5

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (1)

Authors

S

Simon Cruanes

Maintainers

S

Simon Cruanes

Sources

fuseau-0.1.tbz

sha256=8a9339d239aa371d0c4aceb23d7601a1b7da8f42d84542cee30669cc95addb6a

sha512=fa656c7311371344f0c6ebf08c666afc33296558ccc678ed87baf2f9ba54035cd4c5caca4257212416296fcdbdfc1687c46cc2ebea3548c792ea72602b85b832

doc/fuseau/Fuseau/Resource_pool/index.html

Module `Fuseau.Resource_pool`Source

Resource pool.

This pool can be used for buffers. It can be used for other resources but do note that it assumes resources are still reasonably cheap to produce and discard, and will never block waiting for a resource — it's not a good pool for DB connections.

Sourcetype 'a t

Pool of values of type 'a

Source

val create : 
  ?clear:('a -> unit) ->
  mk_item:(unit -> 'a) ->
  ?max_size:int ->
  unit ->
  'a t

Create a new pool.

parameter mk_item
produce a new item in case the pool is empty

parameter max_size
maximum number of item in the pool before we start dropping resources on the floor. This controls resource consumption.

parameter clear
a function called on items before recycling them.

Sourceval acquire : 'a t -> 'a

Acquire (or create) a new resource from the pool.

Sourceval recycle : 'a t -> 'a -> unit

Recycle a value into the pool. The value must not be used afterwards.

Sourceval with_resource : 'a t -> ('a -> 'b) -> 'b

with_resource pool f runs f x with x a resource; when f fails or returns, x is returned to the pool for future reuse.