aboutsummaryrefslogtreecommitdiff
path: root/devel/hs-async/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'devel/hs-async/pkg-descr')
-rw-r--r--devel/hs-async/pkg-descr15
1 files changed, 15 insertions, 0 deletions
diff --git a/devel/hs-async/pkg-descr b/devel/hs-async/pkg-descr
new file mode 100644
index 000000000000..c66d6cc6af2b
--- /dev/null
+++ b/devel/hs-async/pkg-descr
@@ -0,0 +1,15 @@
+This package provides a higher-level interface over threads, in which an
+Async a is a concurrent thread that will eventually deliver a value of
+type a. The package provides ways to create Async computations, wait for
+their results, and cancel them.
+
+Using Async is safer than using threads in two ways:
+
+ - When waiting for a thread to return a result, if the thread dies with
+ an exception then the caller must either re-throw the exception (wait)
+ or handle it (waitCatch); the exception cannot be ignored.
+
+ - The API makes it possible to build a tree of threads that are
+ automatically killed when their parent dies (see withAsync).
+
+WWW: https://github.com/simonmar/async