package moonpool

  1. Overview
  2. Docs

Module Moonpool.FutSource

Futures.

A future of type 'a t represents the result of a computation that will yield a value of type 'a.

Typically, the computation is running on a thread pool Pool.t and will proceed on some worker. Once set, a future cannot change. It either succeeds (storing a Ok x with x: 'a), or fail (storing a Error (exn, bt) with an exception and the corresponding backtrace).

Combinators such as map and join_array can be used to produce futures from other futures (in a monadic way). Some combinators take a pool argument to specify where the intermediate computation takes place; for example map ~pool ~f fut maps the value in fut using function f, applicatively; the call to f happens on pool pool (once fut resolves successfully with a value).

Sourcetype 'a or_error = ('a, exn * Printexc.raw_backtrace) result
Sourcetype 'a t

A future with a result of type 'a.

Sourcetype 'a promise

A promise, which can be fulfilled exactly once to set the corresponding future

Sourceval make : unit -> 'a t * 'a promise

Make a new future with the associated promise

Sourceval on_result : 'a t -> ('a or_error -> unit) -> unit

on_result fut f registers f to be called in the future when fut is set ; or calls f immediately if fut is already set.

Sourceexception Already_fulfilled
Sourceval fulfill : 'a promise -> 'a or_error -> unit

Fullfill the promise, setting the future at the same time.

Sourceval fulfill_idempotent : 'a promise -> 'a or_error -> unit

Fullfill the promise, setting the future at the same time. Does nothing if the promise is already fulfilled.

Sourceval return : 'a -> 'a t

Already settled future, with a result

Sourceval fail : exn -> Printexc.raw_backtrace -> _ t

Already settled future, with a failure

Sourceval of_result : 'a or_error -> 'a t
Sourceval is_resolved : _ t -> bool

is_resolved fut is true iff fut is resolved.

Sourceval peek : 'a t -> 'a or_error option

peek fut returns Some r if fut is currently resolved with r, and None if fut is not resolved yet.

Sourceexception Not_ready
  • since 0.2
Sourceval get_or_fail : 'a t -> 'a or_error

get_or_fail fut obtains the result from fut if it's fulfilled (i.e. if peek fut returns Some res, get_or_fail fut returns res).

  • since 0.2
Sourceval get_or_fail_exn : 'a t -> 'a

get_or_fail_exn fut obtains the result from fut if it's fulfilled, like get_or_fail. If the result is an Error _, the exception inside is re-raised.

  • since 0.2
Sourceval is_done : _ t -> bool

Is the future resolved? This is the same as peek fut |> Option.is_some.

  • since 0.2

Combinators

Sourceval spawn : on:Pool.t -> (unit -> 'a) -> 'a t

spaw ~on f runs f() on the given pool, and return a future that will hold its result.

Sourceval map : ?on:Pool.t -> f:('a -> 'b) -> 'a t -> 'b t

map ?on ~f fut returns a new future fut2 that resolves with f x if fut resolved with x; and fails with e if fut fails with e or f x raises e.

  • parameter on

    if provided, f runs on the given pool

Sourceval bind : ?on:Pool.t -> f:('a -> 'b t) -> 'a t -> 'b t

map ?on ~f fut returns a new future fut2 that resolves like the future f x if fut resolved with x; and fails with e if fut fails with e or f x raises e.

  • parameter on

    if provided, f runs on the given pool

Sourceval join : ?on:Pool.t -> 'a t t -> 'a t

join fut is fut >>= Fun.id. It joins the inner layer of the future.

  • since 0.2
Sourceval both : 'a t -> 'b t -> ('a * 'b) t

both a b succeeds with x, y if a succeeds with x and b succeeds with y, or fails if any of them fails.

Sourceval choose : 'a t -> 'b t -> ('a, 'b) Either.t t

choose a b succeeds Left x or Right y if a succeeds with x or b succeeds with y, or fails if both of them fails. If they both succeed, it is not specified which result is used.

Sourceval choose_same : 'a t -> 'a t -> 'a t

choose_same a b succeeds with the value of one of a or b if they succeed, or fails if both fail. If they both succeed, it is not specified which result is used.

Sourceval join_array : 'a t array -> 'a array t

Wait for all the futures in the array. Fails if any future fails.

Sourceval join_list : 'a t list -> 'a list t

Wait for all the futures in the list. Fails if any future fails.

Sourceval wait_array : _ t array -> unit t

wait_array arr waits for all futures in arr to resolve. It discards the individual results of futures in arr. It fails if any future fails.

Sourceval wait_list : _ t list -> unit t

wait_list l waits for all futures in l to resolve. It discards the individual results of futures in l. It fails if any future fails.

Sourceval for_ : on:Pool.t -> int -> (int -> unit) -> unit t

for_ ~on n f runs f 0, f 1, …, f (n-1) on the pool, and returns a future that resolves when all the tasks have resolved, or fails as soon as one task has failed.

Sourceval for_array : on:Pool.t -> 'a array -> (int -> 'a -> unit) -> unit t

for_array ~on arr f runs f 0 arr.(0), …, f (n-1) arr.(n-1) in the pool (where n = Array.length arr), and returns a future that resolves when all the tasks are done, or fails if any of them fails.

  • since 0.2
Sourceval for_list : on:Pool.t -> 'a list -> ('a -> unit) -> unit t

for_list ~on l f is like for_array ~on (Array.of_list l) f.

  • since 0.2

Blocking

Sourceval wait_block : 'a t -> 'a or_error

wait_block fut blocks the current thread until fut is resolved, and returns its value.

NOTE: A word of warning: this will monopolize the calling thread until the future resolves. This can also easily cause deadlocks, if enough threads in a pool call wait_block on futures running on the same pool or a pool depending on it.

A good rule to avoid deadlocks is to run this from outside of any pool, or to have an acyclic order between pools where wait_block is only called from a pool on futures evaluated in a pool that comes lower in the hierarchy. If this rule is broken, it is possible for all threads in a pool to wait for futures that can only make progress on these same threads, hence the deadlock.

Sourceval wait_block_exn : 'a t -> 'a

Same as wait_block but re-raises the exception if the future failed.

Sourcemodule type INFIX = sig ... end

Operators that run on the same thread as the first future.

include INFIX
Sourceval (>|=) : 'a t -> ('a -> 'b) -> 'b t
Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t
Sourceval (let+) : 'a t -> ('a -> 'b) -> 'b t
Sourceval (and+) : 'a t -> 'b t -> ('a * 'b) t
Sourceval (let*) : 'a t -> ('a -> 'b t) -> 'b t
Sourceval (and*) : 'a t -> 'b t -> ('a * 'b) t
Sourcemodule Infix (_ : sig ... end) : INFIX

Make infix combinators

Sourceval infix : Pool.t -> (module INFIX)

infix pool makes a new infix module.

  • since 0.2