package b0

You can search for identifiers within the package.

in-package search v0.2.0

Software construction care

Install

Dune Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (6)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.0.tbz

sha256=dadde8cfa62be9dabd805fc190b415427b4699ffe3458c153e2f3f9cc5c9b9b4

md5=f96ac96fb0182f2b97dbe9ded452544b

doc/b0.b00/B00/Exec/index.html

Module `B00.Exec`

Build operation executors.

An executor is a parallel asynchronous work queue. It has no notion of synchronisation, any scheduled operation is randomly executed in parallel up to the executor's parallelizing limits.

Executors

type feedback = [

| `Exec_submit of B0_std.Os.Cmd.pid option * Op.t

]

The type for executor feedbacks.

val pp_feedback : feedback B0_std.Fmt.t

pp_feedback formats executor feedback.

type t

The type for executors.

val create : 
  ?clock:B0_std.Time.counter ->
  ?rand:Random.State.t ->
  ?tmp_dir:B0_std.Fpath.t ->
  ?feedback:(feedback -> unit) ->
  max_spawn:int ->
  unit ->
  t

create ~clock ~rand ~tmp_dir ~notify_submit ~max_spawn with:

max_spawn the maximal number of processes spawn simultaneously.
feedback called with each scheduled operation when it gets submitted for execution. Default is a nop.
tmp_dir is a directory for temporary files, it must exist; defaults to B0_std.Os.Dir.default_tmp ().
rand random state used for internal queues; defaults to Random.State.make_self_init.
clock, the clock used to timestamp the operations; defaults to B0_std.Time.counter ().

val schedule : t -> Op.t -> unit

schedule e o schedules o for execution in e. Just before o is actually submitted for execution it is given to the notify_submit callback of e (see create).

val collect : t -> block:bool -> Op.t option

collect e ~block removes from e an operation that has completed (if any). If block is false and no completed operation exists, the call returns immediately with None. If block is true and at least one incomplete operation exists in e, the call blocks until an operation completes. If block is true and no operation exists in e None is returned.

On This Page

Executors