mirror of
https://github.com/c-cube/tiny_httpd.git
synced 2025-12-05 19:00:32 -05:00
32 lines
1.1 KiB
OCaml
32 lines
1.1 KiB
OCaml
(** Resource pool.
|
|
|
|
This pool is 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.
|
|
|
|
@since 0.14. *)
|
|
|
|
type 'a t
|
|
(** Pool of values of type ['a] *)
|
|
|
|
val create :
|
|
?clear:('a -> unit) -> mk_item:(unit -> 'a) -> ?max_size:int -> unit -> 'a t
|
|
(** Create a new pool.
|
|
@param mk_item produce a new item in case the pool is empty
|
|
@param max_size
|
|
maximum number of item in the pool before we start dropping resources on
|
|
the floor. This controls resource consumption.
|
|
@param clear a function called on items before recycling them. *)
|
|
|
|
val 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. *)
|
|
|
|
(** Low level control over the pool. This is easier to get wrong (e.g. releasing
|
|
the same resource twice) so use with caution.
|
|
@since 0.18 *)
|
|
module Raw : sig
|
|
val acquire : 'a t -> 'a
|
|
val release : 'a t -> 'a -> unit
|
|
end
|