mirror of
https://github.com/c-cube/linol.git
synced 2025-12-10 05:04:00 -05:00
2 lines
No EOL
7.3 KiB
HTML
2 lines
No EOL
7.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol_lwt__Task (linol-lwt.Linol_lwt__Task)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">linol-lwt</a> » Linol_lwt__Task</nav><h1>Module <code>Linol_lwt__Task</code></h1><h2 id="tasks"><a href="#tasks" class="anchor"></a>Tasks</h2><p>Tasks built on top of Lwt, for cooperative multi-threading.</p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> 'a t</code></dt><dd><p>A task</p></dd></dl><dl><dt class="spec type" id="type-m"><a href="#type-m" class="anchor"></a><code><span class="keyword">type</span> 'a m</code><code> = <span class="type-var">'a</span> Lwt.t</code></dt><dd><p>Computation within the task</p></dd></dl><dl><dt class="spec type" id="type-cancel"><a href="#type-cancel" class="anchor"></a><code><span class="keyword">type</span> cancel</code></dt></dl><dl><dt class="spec value" id="val-return"><a href="#val-return" class="anchor"></a><code><span class="keyword">val</span> return : <span class="type-var">'a</span> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-start"><a href="#val-start" class="anchor"></a><code><span class="keyword">val</span> start : ?⁠descr:string <span>-></span> ?⁠cancel:<a href="index.html#type-cancel">cancel</a> <span>-></span> (<span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-m">m</a>) <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-descr"><a href="#val-descr" class="anchor"></a><code><span class="keyword">val</span> descr : <span class="type-var">_</span> <a href="index.html#type-t">t</a> <span>-></span> string option</code></dt><dt class="spec value" id="val-run"><a href="#val-run" class="anchor"></a><code><span class="keyword">val</span> run : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span>-></span> (<span class="type-var">'a</span>, exn) Stdlib.result</code></dt><dt class="spec value" id="val-run_sub"><a href="#val-run_sub" class="anchor"></a><code><span class="keyword">val</span> run_sub : parent:<span class="type-var">_</span> <a href="index.html#type-t">t</a> <span>-></span> ?⁠descr:string <span>-></span> ?⁠cancel:<a href="index.html#type-cancel">cancel</a> <span>-></span> (<span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-m">m</a>) <span>-></span> (<span class="type-var">'a</span>, exn) Stdlib.result <a href="index.html#type-m">m</a></code></dt></dl><div class="spec module" id="module-Wrapped_error"><a href="#module-Wrapped_error" class="anchor"></a><code><span class="keyword">module</span> <a href="Wrapped_error/index.html">Wrapped_error</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec value" id="val-unwrap"><a href="#val-unwrap" class="anchor"></a><code><span class="keyword">val</span> unwrap : (<span class="type-var">'a</span>, exn) Stdlib.result <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-is_cancelled"><a href="#val-is_cancelled" class="anchor"></a><code><span class="keyword">val</span> is_cancelled : <span class="type-var">_</span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-cancel"><a href="#val-cancel" class="anchor"></a><code><span class="keyword">val</span> cancel : <span class="type-var">_</span> <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-pause"><a href="#val-pause" class="anchor"></a><code><span class="keyword">val</span> pause : <span class="type-var">_</span> <a href="index.html#type-t">t</a> <span>-></span> unit <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-wait_all"><a href="#val-wait_all" class="anchor"></a><code><span class="keyword">val</span> wait_all : (unit, exn) Stdlib.result <a href="index.html#type-m">m</a> list <span>-></span> (unit, exn) Stdlib.result <a href="index.html#type-m">m</a></code></dt></dl><div class="spec module" id="module-Infix"><a href="#module-Infix" class="anchor"></a><code><span class="keyword">module</span> <a href="Infix/index.html">Infix</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div><div class="spec include"><div class="doc"><details open="open"><summary><span class="def"><code><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <a href="index.html#module-Infix">Infix</a></code></span></summary><dl><dt class="spec value" id="val-let+"><a href="#val-let+" class="anchor"></a><code><span class="keyword">val</span> let+ : <span class="type-var">'a</span> <a href="index.html#type-m">m</a> <span>-></span> (<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>) <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-let*"><a href="#val-let*" class="anchor"></a><code><span class="keyword">val</span> let* : <span class="type-var">'a</span> <a href="index.html#type-m">m</a> <span>-></span> (<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a>) <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span class="keyword">val</span> (>|=) : <span class="type-var">'a</span> <a href="index.html#type-m">m</a> <span>-></span> (<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>) <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span class="keyword">val</span> (>>=) : <span class="type-var">'a</span> <a href="index.html#type-m">m</a> <span>-></span> (<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a>) <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a></code></dt><dt class="spec value" id="val-and+"><a href="#val-and+" class="anchor"></a><code><span class="keyword">val</span> and+ : <span class="type-var">'a</span> <a href="index.html#type-m">m</a> <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-m">m</a> <span>-></span> (<span class="type-var">'a</span> * <span class="type-var">'b</span>) <a href="index.html#type-m">m</a></code></dt></dl></details></div></div></div></div></body></html> |