aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/future.mli
diff options
context:
space:
mode:
authorGravatar Enrico Tassi <Enrico.Tassi@inria.fr>2014-02-21 18:17:03 +0100
committerGravatar Enrico Tassi <Enrico.Tassi@inria.fr>2014-02-26 14:53:08 +0100
commit83ee68ba8beda04343514d9e5905ea062cbeada0 (patch)
tree3a9d1fab786e5d3483b433f1f8c03649439f1b70 /lib/future.mli
parent7726a81d850020b6402f445912f3a3d9310da69d (diff)
Future: make ~greedy:true the default + new sink commodity API
Diffstat (limited to 'lib/future.mli')
-rw-r--r--lib/future.mli5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/future.mli b/lib/future.mli
index 13f8ee961..785b2df53 100644
--- a/lib/future.mli
+++ b/lib/future.mli
@@ -115,7 +115,7 @@ val uuid : 'a computation -> UUID.t
* [force c; chain ~pure:false c g] is correct.
* [greedy]:
* The [greedy] parameter forces immediately the new computation if
- * the old one is_over (Exn or Val). Defaults to false. *)
+ * the old one is_over (Exn or Val). Defaults to true. *)
val chain : ?greedy:bool -> pure:bool ->
'a computation -> ('a -> 'b) -> 'b computation
@@ -128,6 +128,9 @@ val compute : 'a computation -> 'a value
* in a computation obtained by chaining on a joined future. *)
val join : 'a computation -> 'a
+(* Call this before stocking the future. If it is_val then it is joined *)
+val sink : 'a computation -> unit
+
(*** Utility functions ************************************************* ***)
val split2 : ?greedy:bool ->
('a * 'b) computation -> 'a computation * 'b computation