simon/moonpool
1
0
Fork 0
mirror of https://github.com/c-cube/moonpool.git synced 2025-12-10 05:03:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: 3bdd269ca3

Browse source
This commit is contained in:
c-cube 2024-03-05 02:05:14 +00:00
parent c34156bfc1
commit 270c7fe66f
2 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
moonpool/Moonpool_dpool/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_dpool (moonpool.Moonpool_dpool)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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> &#x00BB; Moonpool_dpool</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_dpool</span></code></h1><p>Static pool of domains.</p><p>These domains are shared between <b>all</b> the pools in moonpool. The rationale is that we should not have more domains than cores, so it's easier to reserve exactly that many domain slots, and run more flexible thread pools on top (each domain being shared by potentially multiple threads from multiple pools).</p><p>The pool should not contain actual domains if it's not in use, ie if no runner is presently actively using one or more of the domain slots.</p><p><b>NOTE</b>: Interface is still experimental.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</li></ul></header><nav class="odoc-toc"><ul><li><a href="#low-level-interface-for-resouce-handling">Low level interface for resouce handling</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-domain"><a href="#type-domain" class="anchor"></a><code><span><span class="keyword">type</span> domain</span><span> = <a href="../Moonpool_private/Domain_/index.html#type-t">Moonpool_private.Domain_.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_number_of_domains"><a href="#val-max_number_of_domains" class="anchor"></a><code><span><span class="keyword">val</span> max_number_of_domains : <span>unit <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Number of domains in the pool when all domains are active.</p></div></div><h3 id="low-level-interface-for-resouce-handling"><a href="#low-level-interface-for-resouce-handling" class="anchor"></a>Low level interface for resouce handling</h3><p>Be very cautious with this interface, or resource leaks might occur.</p><div class="odoc-spec"><div class="spec value anchored" id="val-run_on"><a href="#val-run_on" class="anchor"></a><code><span><span class="keyword">val</span> run_on : <span>int <span class="arrow">&#45;&gt;</span></span> <span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>run_on i f</code> runs <code>f()</code> on the domain with index <code>i</code>. Precondition: <code>0 &lt;= i &lt; n_domains()</code>. The thread must call <a href="#val-decr_on"><code>decr_on</code></a> with <code>i</code> once it's done.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decr_on"><a href="#val-decr_on" class="anchor"></a><code><span><span class="keyword">val</span> decr_on : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal that a thread is stopping on the domain with index <code>i</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run_on_and_wait"><a href="#val-run_on_and_wait" class="anchor"></a><code><span><span class="keyword">val</span> run_on_and_wait : <span>int <span class="arrow">&#45;&gt;</span></span> <span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>run_on_and_wait i f</code> runs <code>f()</code> on the domain with index <code>i</code>, and blocks until the result of <code>f()</code> is returned back.</p></div></div></div></body></html>

2
moonpool/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (moonpool.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../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="package-moonpool"><a href="#package-moonpool" class="anchor"></a>Package moonpool <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Moonpool/index.html"><code>Moonpool</code></a> <span class="synopsis">Moonpool</span></li><li><a href="Moonpool_fib/index.html"><code>Moonpool_fib</code></a> <span class="synopsis">Fiber for moonpool</span></li><li><a href="Moonpool_forkjoin/index.html"><code>Moonpool_forkjoin</code></a> <span class="synopsis">Fork-join primitives.</span></li><li><a href="Moonpool_private/index.html"><code>Moonpool_private</code></a> </li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (moonpool.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../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="package-moonpool"><a href="#package-moonpool" class="anchor"></a>Package moonpool <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Moonpool/index.html"><code>Moonpool</code></a> <span class="synopsis">Moonpool</span></li><li><a href="Moonpool_dpool/index.html"><code>Moonpool_dpool</code></a> <span class="synopsis">Static pool of domains.</span></li><li><a href="Moonpool_fib/index.html"><code>Moonpool_fib</code></a> <span class="synopsis">Fiber for moonpool</span></li><li><a href="Moonpool_forkjoin/index.html"><code>Moonpool_forkjoin</code></a> <span class="synopsis">Fork-join primitives.</span></li><li><a href="Moonpool_private/index.html"><code>Moonpool_private</code></a> </li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>