nanoev/picos/Picos_domain/index.html
2025-05-05 14:16:16 +00:00

2 lines
2.7 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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>Picos_domain (picos.Picos_domain)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><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">Index</a> &#x00BB; <a href="../index.html">picos</a> &#x00BB; Picos_domain</nav><header class="odoc-preamble"><h1>Module <code><span>Picos_domain</span></code></h1><p>Minimalistic domain API available both on OCaml 5 and on OCaml 4.</p><p> On OCaml 4 there is always only a single domain.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-at_exit"><a href="#val-at_exit" class="anchor"></a><code><span><span class="keyword">val</span> at_exit : <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>at_exit action</code> registers <code>action</code> to be called when the current domain exits.</p><p>On OCaml 5 this calls <code>Domain.at_exit</code>. On OCaml 4 this calls <a href="../../ocaml/Stdlib/index.html#val-at_exit"><code>Stdlib.at_exit</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recommended_domain_count"><a href="#val-recommended_domain_count" class="anchor"></a><code><span><span class="keyword">val</span> recommended_domain_count : <span>unit <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>recommended_domain_count ()</code> returns <code>1</code> on OCaml 4 and calls <code>Domain.recommended_domain_count</code> on OCaml 5.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_main_domain"><a href="#val-is_main_domain" class="anchor"></a><code><span><span class="keyword">val</span> is_main_domain : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>is_main_domain ()</code> returns <code>true</code> on OCaml 4 and calls <code>Domain.is_main_domain</code> on OCaml 5.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DLS"><a href="#module-DLS" class="anchor"></a><code><span><span class="keyword">module</span> <a href="DLS/index.html">DLS</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Domain-local storage for Picos.</p></div></div></div></body></html>