source: project/futures/doc.scm @ 3

Last change on this file since 3 was 3, checked in by felix winkelmann, 15 years ago

udp/test-infrastructure changes; added futures

File size: 2.8 KB
Line 
1(use eggdoc)
2
3(define doc
4  '((eggdoc:begin
5     (name "futures")
6     (description (p "A straightforward implementation of \"futures\" for concurrent evaluation of expressions."))
7     (author (url "mailto:felix@call-with-current-continuation.org" "Felix"))
8     (history (version "1.0" "Initial release"))
9     
10     (usage)
11     (download "futures.egg")
12     
13     (documentation
14      (p "This extension provides syntax and data types for " (i "futures") " - concurrently evaluated expressions that memoize their result")
15         
16      (group
17       (macro
18        "(future EXPRESSION)"
19         (p "Starts evaluation of " (tt "EXPRESSION") " in a separate thread and returns a " (i "future") " object"
20            " representing the computation.") )
21
22       (procedure
23        "(future? X)"
24        (p "Returns " (tt "#t") " if " (tt "X") " is an object returned by a " (tt "future") " expression or "
25           (tt "#f") " otherwise.") )
26
27       (procedure 
28        "(force X)"
29        (p "If " (tt "X") " is a future, then the current threads waits until the expression evaluated"
30           " at the point of creating the future is complete. If an error occurred during that evaluation,"
31           " or when the future executed to completion, then " (tt "force") " will return the result(s) of"
32           " the future expression.")
33        (p "If the argument is not a future, then the usual semantics of " (tt "force") " apply.") ) ) )
34
35     (license
36       "Copyright (c) 2005, Felix L. Winkelmann.  All rights reserved.
37
38Redistribution and use in source and binary forms, with or without
39modification, are permitted provided that the following conditions are met:
40
41  Redistributions of source code must retain the above copyright notice,
42  this list of conditions and the following disclaimer. Redistributions in
43  binary form must reproduce the above copyright notice, this list of
44  conditions and the following disclaimer in the documentation and/or
45  other materials provided with the distribution. Neither the name of the
46  author nor the names of its contributors may be used to endorse or
47  promote products derived from this software without specific prior
48  written permission.
49
50THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS
51IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
52THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
54CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
55EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
57PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
58LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
59NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
60SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."))))
61
62(eggdoc->html doc)
Note: See TracBrowser for help on using the repository browser.