Permalink
Browse files

Added documentation for *default-future-type* to readme

  • Loading branch information...
vsedach committed Nov 2, 2011
1 parent 0558f0d commit 46379331900e97c2938695d7b9b537a107c6e8ee
Showing with 8 additions and 0 deletions.
  1. +8 −0 README
View
8 README
@@ -55,6 +55,14 @@ function pcall (thunk &optional (future-type *default-future-type*)) => future
The function is called in an unspecified dynamic environment.
+special variable *default-future-type*
+
+ One of :eager, :speculative (default) or :lazy. If eager, any newly
+ created futures start their computation immediately. If speculative,
+ newly created futures are computed when thread pool threads are
+ available, in FIFO future creation order. If lazy, newly created
+ futures are not computed until asked to yield their values.
+
function ready-to-yield? (future) => nil or non-nil
Returns non-nil if the future values have been computed, nil otherwise.

0 comments on commit 4637933

Please sign in to comment.