ocaml-containers/3.0/containers-thread/CCPool/Make/index.html
Simon Cruanes 2fa8e5f507 fix doc
2020-08-04 09:49:29 -04:00

2 lines
No EOL
3.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-thread.CCPool.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><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">containers-thread</a> &#x00BB; <a href="../index.html">CCPool</a> &#x00BB; Make</nav><h1>Module <code>CCPool.Make</code></h1><h3 id="create-a-new-pool"><a href="#create-a-new-pool" class="anchor"></a>Create a new Pool</h3></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-P/index.html">P</a> : <a href="../index.html#module-type-PARAM">PARAM</a></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec value" id="val-run"><a href="#val-run" class="anchor"></a><code><span class="keyword">val</span> run : <span>(unit <span>&#45;&gt;</span> <span class="type-var">_</span>)</span> <span>&#45;&gt;</span> unit</code></dt><dd><p><code>run f</code> schedules <code>f</code> for being executed in the thread pool.</p></dd></dl><dl><dt class="spec value" id="val-run1"><a href="#val-run1" class="anchor"></a><code><span class="keyword">val</span> run1 : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">_</span>)</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> unit</code></dt><dd><p><code>run1 f x</code> is similar to <code>run (fun () -&gt; f x)</code>.</p></dd></dl><dl><dt class="spec value" id="val-run2"><a href="#val-run2" class="anchor"></a><code><span class="keyword">val</span> run2 : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">_</span>)</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-run3"><a href="#val-run3" class="anchor"></a><code><span class="keyword">val</span> run3 : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'c</span> <span>&#45;&gt;</span> <span class="type-var">_</span>)</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'c</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-set_exn_handler"><a href="#val-set_exn_handler" class="anchor"></a><code><span class="keyword">val</span> set_exn_handler : <span>(exn <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-active"><a href="#val-active" class="anchor"></a><code><span class="keyword">val</span> active : unit <span>&#45;&gt;</span> bool</code></dt><dd><p><code>active ()</code> is true as long as <code>stop()</code> has not been called yet.</p></dd></dl><dl><dt class="spec value" id="val-stop"><a href="#val-stop" class="anchor"></a><code><span class="keyword">val</span> stop : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>After calling <code>stop ()</code>, most functions will raise Stopped. This has the effect of preventing new tasks from being executed.</p></dd></dl><dl><dt class="spec module" id="module-Fut"><a href="#module-Fut" class="anchor"></a><code><span class="keyword">module</span> <a href="Fut/index.html">Fut</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl></div></body></html>