mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-12 05:58:42 -05:00
60 lines
2.2 KiB
OCaml
60 lines
2.2 KiB
OCaml
(** A simple thread pool in FIFO order.
|
|
|
|
FIFO: first-in, first-out. Basically tasks are put into a queue,
|
|
and worker threads pull them out of the queue at the other end.
|
|
|
|
Since this uses a single blocking queue to manage tasks, it's very
|
|
simple and reliable. The number of worker threads is fixed, but
|
|
they are spread over several domains to enable parallelism.
|
|
|
|
This can be useful for latency-sensitive applications (e.g. as a
|
|
pool of workers for network servers). Work-stealing pools might
|
|
have higher throughput but they're very unfair to some tasks; by
|
|
contrast, here, older tasks have priority over younger tasks.
|
|
|
|
@since 0.5 *)
|
|
|
|
include module type of Runner
|
|
|
|
type ('a, 'b) create_args =
|
|
?on_init_thread:(dom_id:int -> t_id:int -> unit -> unit) ->
|
|
?on_exit_thread:(dom_id:int -> t_id:int -> unit -> unit) ->
|
|
?on_exn:(exn -> Printexc.raw_backtrace -> unit) ->
|
|
?around_task:(t -> 'b) * (t -> 'b -> unit) ->
|
|
?num_threads:int ->
|
|
?name:string ->
|
|
'a
|
|
(** Arguments used in {!create}. See {!create} for explanations. *)
|
|
|
|
val create : (unit -> t, _) create_args
|
|
(** [create ()] makes a new thread pool.
|
|
@param on_init_thread called at the beginning of each new thread in the pool.
|
|
@param min minimum size of the pool. See {!Pool.create_args}.
|
|
The default is [Domain.recommended_domain_count()], ie one worker per
|
|
CPU core.
|
|
On OCaml 4 the default is [4] (since there is only one domain).
|
|
@param on_exit_thread called at the end of each worker thread in the pool.
|
|
@param around_task a pair of [before, after] functions
|
|
ran around each task. See {!Pool.create_args}.
|
|
@param name name for the pool, used in tracing (since NEXT_RELEASE)
|
|
*)
|
|
|
|
val with_ : (unit -> (t -> 'a) -> 'a, _) create_args
|
|
(** [with_ () f] calls [f pool], where [pool] is obtained via {!create}.
|
|
When [f pool] returns or fails, [pool] is shutdown and its resources
|
|
are released.
|
|
Most parameters are the same as in {!create}. *)
|
|
|
|
(**/**)
|
|
|
|
module Private_ : sig
|
|
type state
|
|
|
|
val create_state : threads:Thread.t array -> unit -> state
|
|
val runner_of_state : state -> Runner.t
|
|
|
|
val run_thread :
|
|
state -> t -> on_exn:(exn -> Printexc.raw_backtrace -> unit) -> unit
|
|
end
|
|
|
|
(**/**)
|