mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-10 05:03:58 -05:00
missing
This commit is contained in:
Simon Cruanes
parent
240b47b737
commit
f2ee18f9f9
8 changed files with 27 additions and 0 deletions
0
moonpool/Moonpool/.dummy
Normal file
0
moonpool/Moonpool/.dummy
Normal file
2
moonpool/Moonpool/Fut/Infix/argument-1-_/index.html
Normal file
2
moonpool/Moonpool/Fut/Infix/argument-1-_/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>_ (moonpool.Moonpool.Fut.Infix._)</title><link rel="stylesheet" href="../../../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">moonpool</a> » <a href="../../../index.html">Moonpool</a> » <a href="../../index.html">Fut</a> » <a href="../index.html">Infix</a> » _</nav><header class="odoc-preamble"><h1>Parameter <code><span>Infix._</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-pool"><a href="#val-pool" class="anchor"></a><code><span><span class="keyword">val</span> pool : <a href="../../../Pool/index.html#type-t">Pool.t</a></span></code></div></div></div></body></html>
|
||||
2
moonpool/Moonpool/Fut/Infix/index.html
Normal file
2
moonpool/Moonpool/Fut/Infix/index.html
Normal file
File diff suppressed because one or more lines are too long
2
moonpool/Moonpool/Fut/index.html
Normal file
2
moonpool/Moonpool/Fut/index.html
Normal file
File diff suppressed because one or more lines are too long
2
moonpool/Moonpool/Fut/module-type-INFIX/index.html
Normal file
2
moonpool/Moonpool/Fut/module-type-INFIX/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>INFIX (moonpool.Moonpool.Fut.INFIX)</title><link rel="stylesheet" href="../../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">moonpool</a> » <a href="../../index.html">Moonpool</a> » <a href="../index.html">Fut</a> » INFIX</nav><header class="odoc-preamble"><h1>Module type <code><span>Fut.INFIX</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span><span class="keyword">val</span> (>|=) : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-let+"><a href="#val-let+" class="anchor"></a><code><span><span class="keyword">val</span> let+ : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-and+"><a href="#val-and+" class="anchor"></a><code><span><span class="keyword">val</span> and+ : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-let*"><a href="#val-let*" class="anchor"></a><code><span><span class="keyword">val</span> let* : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-and*"><a href="#val-and*" class="anchor"></a><code><span><span class="keyword">val</span> and* : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div></div></div></body></html>
|
||||
15
moonpool/Moonpool/Pool/index.html
Normal file
15
moonpool/Moonpool/Pool/index.html
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pool (moonpool.Moonpool.Pool)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">moonpool</a> » <a href="../index.html">Moonpool</a> » Pool</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool.Pool</span></code></h1><p>Thread pool.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>A pool of threads.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-thread_loop_wrapper"><a href="#type-thread_loop_wrapper" class="anchor"></a><code><span><span class="keyword">type</span> thread_loop_wrapper</span><span> =
|
||||
<span>thread:<span class="xref-unresolved">Thread</span>.t <span class="arrow">-></span></span>
|
||||
<span>pool:<a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>a thread wrapper <code>f</code> takes the current thread, the current pool, and the worker function <code>loop : unit -> unit</code> which is the worker's main loop, and returns a new loop function. By default it just returns the same loop function but it can be used to install tracing, effect handlers, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_global_thread_loop_wrapper"><a href="#val-add_global_thread_loop_wrapper" class="anchor"></a><code><span><span class="keyword">val</span> add_global_thread_loop_wrapper : <span><a href="#type-thread_loop_wrapper">thread_loop_wrapper</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>add_global_thread_loop_wrapper f</code> installs <code>f</code> to be installed in every new pool worker thread, for all existing pools, and all new pools created with <code>create</code>. These wrappers accumulate: they all apply, but their order is not specified.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create :
|
||||
<span>?on_init_thread:<span>(<span>dom_id:int <span class="arrow">-></span></span> <span>t_id:int <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>?on_exit_thread:<span>(<span>dom_id:int <span class="arrow">-></span></span> <span>t_id:int <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>?thread_wrappers:<span><a href="#type-thread_loop_wrapper">thread_loop_wrapper</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>?on_exn:<span>(<span>exn <span class="arrow">-></span></span> <span><span class="xref-unresolved">Stdlib</span>.Printexc.raw_backtrace <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>?min:int <span class="arrow">-></span></span>
|
||||
<span>?per_domain:int <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ()</code> makes a new thread pool.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_init_thread</span> <p>called at the beginning of each new thread in the pool.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_exit_thread</span> <p>called at the end of each thread in the pool</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">thread_wrappers</span> <p>a list of <a href="#type-thread_loop_wrapper"><code>thread_loop_wrapper</code></a> functions to use for this pool's workers.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown"><a href="#val-shutdown" class="anchor"></a><code><span><span class="keyword">val</span> shutdown : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Shutdown the pool and wait for it to terminate. Idempotent.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>run pool f</code> schedules <code>f</code> for later execution on the pool in one of the threads.</p></div></div></div></body></html>
|
||||
2
moonpool/Moonpool/index.html
Normal file
2
moonpool/Moonpool/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool (moonpool.Moonpool)</title><link rel="stylesheet" href="../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">moonpool</a> » Moonpool</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool</span></code></h1><p>Moonpool</p><p>A pool within a bigger pool (ie the ocean). Here, we're talking about pools of <code>Thread.t</code> which live within a fixed pool of <code>Domain.t</code>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Pool"><a href="#module-Pool" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Pool/index.html">Pool</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Thread pool.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-start_thread_on_some_domain"><a href="#val-start_thread_on_some_domain" class="anchor"></a><code><span><span class="keyword">val</span> start_thread_on_some_domain : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="xref-unresolved">Thread</span>.t</span></code></div><div class="spec-doc"><p>Similar to <code>Thread</code>.create, but it picks a background domain at random to run the thread. This ensures that we don't always pick the same domain to run all the various threads needed in an application (timers, event loops, etc.)</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Fut"><a href="#module-Fut" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Fut/index.html">Fut</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Futures.</p></div></div></div></body></html>
|
||||
2
moonpool/index.html
Normal file
2
moonpool/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (moonpool.index)</title><link rel="stylesheet" href="../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – moonpool</nav><header class="odoc-preamble"><h1 id="moonpool-index"><a href="#moonpool-index" class="anchor"></a>moonpool index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-moonpool">Library moonpool</a></li></ul></nav><div class="odoc-content"><h2 id="library-moonpool"><a href="#library-moonpool" class="anchor"></a>Library moonpool</h2><p>The entry point of this library is the module: <a href="Moonpool/index.html"><code>Moonpool</code></a>.</p></div></body></html>
|
||||
Loading…
Add table
Reference in a new issue