hop-2012/server/thirdparty/lwt-2.3.2/src/core/lwt_pool.mli

41 lines
1.5 KiB
OCaml

(* Lwt
* http://www.ocsigen.org
* Copyright (C) 2008 Jérôme Vouillon
* Laboratoire PPS - CNRS Université Paris Diderot
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, with linking exceptions;
* either version 2.1 of the License, or (at your option) any later version.
* See COPYING file for details.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)
(** Creating pools (for example pools of connections to a database). *)
(** Instead of creating a new connection each time you need one,
keep a pool of opened connections and reuse opened connections
that are free.
*)
(** Type of pools *)
type 'a t
(** [create n f] creates a new pool with at most [n] members.
[f] is the function to use to create a new pool member. *)
val create :
int -> ?check:('a -> (bool -> unit) -> unit) -> (unit -> 'a Lwt.t) -> 'a t
(** [use p f] takes one free member of the pool [p] and gives it to the function
[f].
*)
val use : 'a t -> ('a -> 'b Lwt.t) -> 'b Lwt.t