mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-05 19:00:33 -05:00
deploy: d79200f555
This commit is contained in:
c-cube
parent
4e362786f6
commit
1830dc8781
1346 changed files with 5887 additions and 2406 deletions
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backoff (backoff.Backoff)</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> » <a href="../index.html">backoff</a> » Backoff</nav><header class="odoc-preamble"><h1>Module <code><span>Backoff</span></code></h1><p>Randomized exponential backoff mechanism.</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>Type of backoff values.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_wait_log"><a href="#val-max_wait_log" class="anchor"></a><code><span><span class="keyword">val</span> max_wait_log : int</span></code></div><div class="spec-doc"><p>Logarithm of the maximum allowed value for wait.</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><span class="optlabel">?lower_wait_log</span>:int <span class="arrow">-></span></span> <span><span class="optlabel">?upper_wait_log</span>: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> creates a backoff value. <code>upper_wait_log</code>, <code>lower_wait_log</code> override the logarithmic upper and lower bound on the number of spins executed by <a href="#val-once"><code>once</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>default</code> is equivalent to <code>create ()</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-once"><a href="#val-once" class="anchor"></a><code><span><span class="keyword">val</span> once : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>once b</code> executes one random wait and returns a new backoff with logarithm of the current maximum value incremented unless it is already at <code>upper_wait_log</code> of <code>b</code>.</p><p>Note that this uses the default Stdlib <code>Random</code> per-domain generator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reset"><a href="#val-reset" class="anchor"></a><code><span><span class="keyword">val</span> reset : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>reset b</code> returns a backoff equivalent to <code>b</code> except with current value set to the <code>lower_wait_log</code> of <code>b</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_wait_log"><a href="#val-get_wait_log" class="anchor"></a><code><span><span class="keyword">val</span> get_wait_log : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>get_wait_log b</code> returns logarithm of the maximum value of wait for next <a href="#val-once"><code>once</code></a>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backoff (backoff.Backoff)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">backoff</a> » Backoff</nav><header class="odoc-preamble"><h1>Module <code><span>Backoff</span></code></h1><p>Randomized exponential backoff mechanism.</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>Type of backoff values.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_wait_log"><a href="#val-max_wait_log" class="anchor"></a><code><span><span class="keyword">val</span> max_wait_log : int</span></code></div><div class="spec-doc"><p>Logarithm of the maximum allowed value for wait.</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><span class="optlabel">?lower_wait_log</span>:int <span class="arrow">-></span></span> <span><span class="optlabel">?upper_wait_log</span>: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> creates a backoff value. <code>upper_wait_log</code>, <code>lower_wait_log</code> override the logarithmic upper and lower bound on the number of spins executed by <a href="#val-once"><code>once</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>default</code> is equivalent to <code>create ()</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-once"><a href="#val-once" class="anchor"></a><code><span><span class="keyword">val</span> once : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>once b</code> executes one random wait and returns a new backoff with logarithm of the current maximum value incremented unless it is already at <code>upper_wait_log</code> of <code>b</code>.</p><p>Note that this uses the default Stdlib <code>Random</code> per-domain generator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reset"><a href="#val-reset" class="anchor"></a><code><span><span class="keyword">val</span> reset : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>reset b</code> returns a backoff equivalent to <code>b</code> except with current value set to the <code>lower_wait_log</code> of <code>b</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_wait_log"><a href="#val-get_wait_log" class="anchor"></a><code><span><span class="keyword">val</span> get_wait_log : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>get_wait_log b</code> returns logarithm of the maximum value of wait for next <a href="#val-once"><code>once</code></a>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (backoff.index)</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> » backoff</nav><header class="odoc-preamble"><h1 id="package-backoff"><a href="#package-backoff" class="anchor"></a>Package backoff <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="Backoff/index.html"><code>Backoff</code></a> <span class="synopsis">Randomized exponential backoff mechanism.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><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-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.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 (backoff.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » backoff</nav><header class="odoc-preamble"><h1 id="package-backoff"><a href="#package-backoff" class="anchor"></a>Package backoff <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="Backoff/index.html"><code>Backoff</code></a> <span class="synopsis">Randomized exponential backoff mechanism.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><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-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.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>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Either__ (either.Either__)</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> » <a href="../index.html">either</a> » Either__</nav><header class="odoc-preamble"><h1>Module <code><span>Either__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Either__ (either.Either__)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">either</a> » Either__</nav><header class="odoc-preamble"><h1>Module <code><span>Either__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Either__Either_intf (either.Either__Either_intf)</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> » <a href="../index.html">either</a> » Either__Either_intf</nav><header class="odoc-preamble"><h1>Module <code><span>Either__Either_intf</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Either__Either_intf (either.Either__Either_intf)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">either</a> » Either__Either_intf</nav><header class="odoc-preamble"><h1>Module <code><span>Either__Either_intf</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (either.index)</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> » either</nav><header class="odoc-preamble"><h1 id="package-either"><a href="#package-either" class="anchor"></a>Package either <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="Either/index.html"><code>Either</code></a> </li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><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-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE">LICENSE</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 (either.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » either</nav><header class="odoc-preamble"><h1 id="package-either"><a href="#package-either" class="anchor"></a>Package either <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="Either/index.html"><code>Either</code></a> </li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><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-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE">LICENSE</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>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Exception_filter (lwt.Lwt.Exception_filter)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Exception_filter</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Exception_filter</span></code></h1></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>An <code>Exception_filter.t</code> is a value which indicates to Lwt what exceptions to catch and what exceptions to let bubble up all the way out of the main loop immediately.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-handle_all"><a href="#val-handle_all" class="anchor"></a><code><span><span class="keyword">val</span> handle_all : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>handle_all</code> is the default filter. With it the all the exceptions (including <code>Out_of_memory</code> and <code>Stack_overflow</code>) can be handled: caught and transformed into rejected promises.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-handle_all_except_runtime"><a href="#val-handle_all_except_runtime" class="anchor"></a><code><span><span class="keyword">val</span> handle_all_except_runtime : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>handle_all_except_runtime</code> is a filter which lets the OCaml runtime exceptions (<code>Out_of_memory</code> and <code>Stack_overflow</code>) go through all the Lwt abstractions and bubble all the way out of the call to <code>Lwt_main.run</code>.</p><p>Note that if you set this handler, then the runtime exceptions leave the Lwt internal state inconsistent. For this reason, you will not be able to call <code>Lwt_main.run</code> again after such an exception has escaped <code>Lwt_main.run</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>set</code> sets the given exception filter globally. You should call this function at most once during the start of your program, before the first call to <code>Lwt_main.run</code>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Exception_filter (lwt.Lwt.Exception_filter)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Exception_filter</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Exception_filter</span></code></h1></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>An <code>Exception_filter.t</code> is a value which indicates to Lwt what exceptions to catch and what exceptions to let bubble up all the way out of the main loop immediately.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-handle_all"><a href="#val-handle_all" class="anchor"></a><code><span><span class="keyword">val</span> handle_all : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>handle_all</code> is the default filter. With it the all the exceptions (including <code>Out_of_memory</code> and <code>Stack_overflow</code>) can be handled: caught and transformed into rejected promises.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-handle_all_except_runtime"><a href="#val-handle_all_except_runtime" class="anchor"></a><code><span><span class="keyword">val</span> handle_all_except_runtime : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>handle_all_except_runtime</code> is a filter which lets the OCaml runtime exceptions (<code>Out_of_memory</code> and <code>Stack_overflow</code>) go through all the Lwt abstractions and bubble all the way out of the call to <code>Lwt_main.run</code>.</p><p>Note that if you set this handler, then the runtime exceptions leave the Lwt internal state inconsistent. For this reason, you will not be able to call <code>Lwt_main.run</code> again after such an exception has escaped <code>Lwt_main.run</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>set</code> sets the given exception filter globally. You should call this function at most once during the start of your program, before the first call to <code>Lwt_main.run</code>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Open_on_rhs (lwt.Lwt.Infix.Let_syntax.Open_on_rhs)</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> » <a href="../../../../index.html">lwt</a> » <a href="../../../index.html">Lwt</a> » <a href="../../index.html">Infix</a> » <a href="../index.html">Let_syntax</a> » Open_on_rhs</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Open_on_rhs</span></code></h1></header><div class="odoc-content"></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Open_on_rhs (lwt.Lwt.Infix.Let_syntax.Open_on_rhs)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../../index.html">lwt</a> » <a href="../../../index.html">Lwt</a> » <a href="../../index.html">Infix</a> » <a href="../index.html">Let_syntax</a> » Open_on_rhs</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Open_on_rhs</span></code></h1></header><div class="odoc-content"></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt.Infix.Let_syntax)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt</a> » <a href="../index.html">Infix</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Infix.Let_syntax</span></code></h1><p>This module provides support for <a href="https://github.com/janestreet/ppx_let">ppx_let</a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-return"><code>Lwt.return</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-map"><code>Lwt.map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind"><a href="#val-bind" class="anchor"></a><code><span><span class="keyword">val</span> bind : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-bind"><code>Lwt.bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-both"><a href="#val-both" class="anchor"></a><code><span><span class="keyword">val</span> both : <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 class="spec-doc"><p>See <a href="../../index.html#val-both"><code>Lwt.both</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Open_on_rhs"><a href="#module-Open_on_rhs" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Open_on_rhs/index.html">Open_on_rhs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt.Infix.Let_syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt</a> » <a href="../index.html">Infix</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Infix.Let_syntax</span></code></h1><p>This module provides support for <a href="https://github.com/janestreet/ppx_let">ppx_let</a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-return"><code>Lwt.return</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-map"><code>Lwt.map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind"><a href="#val-bind" class="anchor"></a><code><span><span class="keyword">val</span> bind : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-bind"><code>Lwt.bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-both"><a href="#val-both" class="anchor"></a><code><span><span class="keyword">val</span> both : <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 class="spec-doc"><p>See <a href="../../index.html#val-both"><code>Lwt.both</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Open_on_rhs"><a href="#module-Open_on_rhs" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Open_on_rhs/index.html">Open_on_rhs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (lwt.Lwt.Infix)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Infix</span></code></h1><p>This module provides several infix operators for making programming with Lwt more convenient.</p><p>To use it, open <code>Lwt.Infix</code>.</p><p>Of the operators declared in this module, only <code>>|=</code> is recommended for new code. The only other commonly-used operator is <code>>>=</code>.</p></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><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 class="spec-doc"><p><code>p >>= f</code> is the same as <a href="../index.html#val-bind"><code>Lwt.bind</code></a><code> p f</code>. It requires <code>Lwt.Infix</code> to be opened in scope:</p><pre class="language-ocaml"><code>open Lwt.Infix
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (lwt.Lwt.Infix)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Infix</span></code></h1><p>This module provides several infix operators for making programming with Lwt more convenient.</p><p>To use it, open <code>Lwt.Infix</code>.</p><p>Of the operators declared in this module, only <code>>|=</code> is recommended for new code. The only other commonly-used operator is <code>>>=</code>.</p></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><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 class="spec-doc"><p><code>p >>= f</code> is the same as <a href="../index.html#val-bind"><code>Lwt.bind</code></a><code> p f</code>. It requires <code>Lwt.Infix</code> to be opened in scope:</p><pre class="language-ocaml"><code>open Lwt.Infix
|
||||
|
||||
let () =
|
||||
Lwt_main.run
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Open_on_rhs (lwt.Lwt.Let_syntax.Let_syntax.Open_on_rhs)</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> » <a href="../../../../index.html">lwt</a> » <a href="../../../index.html">Lwt</a> » <a href="../../index.html">Let_syntax</a> » <a href="../index.html">Let_syntax</a> » Open_on_rhs</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Open_on_rhs</span></code></h1></header><div class="odoc-content"></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Open_on_rhs (lwt.Lwt.Let_syntax.Let_syntax.Open_on_rhs)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../../index.html">lwt</a> » <a href="../../../index.html">Lwt</a> » <a href="../../index.html">Let_syntax</a> » <a href="../index.html">Let_syntax</a> » Open_on_rhs</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Open_on_rhs</span></code></h1></header><div class="odoc-content"></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt.Let_syntax.Let_syntax)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt</a> » <a href="../index.html">Let_syntax</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-return"><code>Lwt.return</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-map"><code>Lwt.map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind"><a href="#val-bind" class="anchor"></a><code><span><span class="keyword">val</span> bind : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-bind"><code>Lwt.bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-both"><a href="#val-both" class="anchor"></a><code><span><span class="keyword">val</span> both : <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 class="spec-doc"><p>See <a href="../../index.html#val-both"><code>Lwt.both</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Open_on_rhs"><a href="#module-Open_on_rhs" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Open_on_rhs/index.html">Open_on_rhs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt.Let_syntax.Let_syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt</a> » <a href="../index.html">Let_syntax</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-return"><code>Lwt.return</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-map"><code>Lwt.map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind"><a href="#val-bind" class="anchor"></a><code><span><span class="keyword">val</span> bind : <span><span><span class="type-var">'a</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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 class="spec-doc"><p>See <a href="../../index.html#val-bind"><code>Lwt.bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-both"><a href="#val-both" class="anchor"></a><code><span><span class="keyword">val</span> both : <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 class="spec-doc"><p>See <a href="../../index.html#val-both"><code>Lwt.both</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Open_on_rhs"><a href="#module-Open_on_rhs" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Open_on_rhs/index.html">Open_on_rhs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt.Let_syntax)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Let_syntax"><a href="#module-Let_syntax" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Let_syntax/index.html">Let_syntax</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt.Let_syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Let_syntax"><a href="#module-Let_syntax" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Let_syntax/index.html">Let_syntax</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (lwt.Lwt.Syntax)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Syntax</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#let-syntax">Let syntax</a></li><li><a href="#monadic-syntax">Monadic syntax</a></li><li><a href="#applicative-syntax">Applicative syntax</a></li></ul></nav></div><div class="odoc-content"><h4 id="let-syntax"><a href="#let-syntax" class="anchor"></a>Let syntax</h4><h2 id="monadic-syntax"><a href="#monadic-syntax" class="anchor"></a>Monadic syntax</h2><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 class="spec-doc"><p>Syntax for <a href="../index.html#val-bind"><code>bind</code></a>.</p></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 class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div><h2 id="applicative-syntax"><a href="#applicative-syntax" class="anchor"></a>Applicative syntax</h2><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 class="spec-doc"><p>Syntax for <a href="../index.html#val-map"><code>map</code></a>.</p></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 class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (lwt.Lwt.Syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt</a> » Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt.Syntax</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#let-syntax">Let syntax</a></li><li><a href="#monadic-syntax">Monadic syntax</a></li><li><a href="#applicative-syntax">Applicative syntax</a></li></ul></nav></div><div class="odoc-content"><h4 id="let-syntax"><a href="#let-syntax" class="anchor"></a>Let syntax</h4><h2 id="monadic-syntax"><a href="#monadic-syntax" class="anchor"></a>Monadic syntax</h2><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 class="spec-doc"><p>Syntax for <a href="../index.html#val-bind"><code>bind</code></a>.</p></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 class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div><h2 id="applicative-syntax"><a href="#applicative-syntax" class="anchor"></a>Applicative syntax</h2><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 class="spec-doc"><p>Syntax for <a href="../index.html#val-map"><code>map</code></a>.</p></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 class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt (lwt.Lwt)</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> » <a href="../index.html">lwt</a> » Lwt</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt</span></code></h1><p>Asynchronous programming with promises.</p><p>A <b>promise</b> is a placeholder for a single value which might take a long time to compute. Speaking roughly, a promise is a <code>ref</code> that can be filled in later. To make that precise, here is how promises differ from <code>ref</code>s:</p><ul><li>A promise might not have a value yet. A promise in this state is called a <em>pending</em> promise.</li><li>Writing a value into a promise is called <em>resolving</em> it. A promise with a value is called a <em>resolved</em> promise.</li><li>Each promise can be resolved only once. After a promise has a value, the promise is immutable.</li><li>It's possible to attach <b>callbacks</b> to a promise. They will run when the promise has a value, i.e. is resolved. If the promise is already resolved when a callback is attached, the callback is run (almost) right away. If the promise is pending, the callback is put into a list and waits.</li></ul><p>So, promises are optional, write-once references, and when they don't yet have a value, they store a list of callbacks that are waiting for the value.</p><p>The waiting callbacks make promises a natural data type for asynchronous programming. For example, you can ask Lwt to <code>read</code> a file. Lwt immediately returns you only a <em>promise</em> for the data.</p><p>You can neglect this promise for a while. You can do some other computation, request more I/O, etc. At some point, you might decide to attach a callback to the <code>read</code> promise, maybe several callbacks.</p><p>In the meantime, the <code>read</code> operation is running in the background. Once it finishes, Lwt <em>resolves</em> the <code>read</code> promise by putting the data into it. Lwt then runs the callbacks you attached.</p><p>One of those might take the data, and ask Lwt to <code>write</code> it to STDOUT. Lwt gives you a promise for that, too, and the process repeats.</p><p>Lwt has a small amount of syntactic sugar to make this look as natural as possible:</p><pre class="language-ocaml"><code>let () =
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt (lwt.Lwt)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt</span></code></h1><p>Asynchronous programming with promises.</p><p>A <b>promise</b> is a placeholder for a single value which might take a long time to compute. Speaking roughly, a promise is a <code>ref</code> that can be filled in later. To make that precise, here is how promises differ from <code>ref</code>s:</p><ul><li>A promise might not have a value yet. A promise in this state is called a <em>pending</em> promise.</li><li>Writing a value into a promise is called <em>resolving</em> it. A promise with a value is called a <em>resolved</em> promise.</li><li>Each promise can be resolved only once. After a promise has a value, the promise is immutable.</li><li>It's possible to attach <b>callbacks</b> to a promise. They will run when the promise has a value, i.e. is resolved. If the promise is already resolved when a callback is attached, the callback is run (almost) right away. If the promise is pending, the callback is put into a list and waits.</li></ul><p>So, promises are optional, write-once references, and when they don't yet have a value, they store a list of callbacks that are waiting for the value.</p><p>The waiting callbacks make promises a natural data type for asynchronous programming. For example, you can ask Lwt to <code>read</code> a file. Lwt immediately returns you only a <em>promise</em> for the data.</p><p>You can neglect this promise for a while. You can do some other computation, request more I/O, etc. At some point, you might decide to attach a callback to the <code>read</code> promise, maybe several callbacks.</p><p>In the meantime, the <code>read</code> operation is running in the background. Once it finishes, Lwt <em>resolves</em> the <code>read</code> promise by putting the data into it. Lwt then runs the callbacks you attached.</p><p>One of those might take the data, and ask Lwt to <code>write</code> it to STDOUT. Lwt gives you a promise for that, too, and the process repeats.</p><p>Lwt has a small amount of syntactic sugar to make this look as natural as possible:</p><pre class="language-ocaml"><code>let () =
|
||||
Lwt_main.run begin
|
||||
let%lwt data = Lwt_io.(read_line stdin) in
|
||||
let%lwt () = Lwt_io.printl data in
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_condition (lwt.Lwt_condition)</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> » <a href="../index.html">lwt</a> » Lwt_condition</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_condition</span></code></h1><p>Conditions</p></header><div class="odoc-content"><p>Condition variables to synchronize between threads.</p><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> <span>'a t</span></span></code></div><div class="spec-doc"><p>Condition variable type. The type parameter denotes the type of value propagated from notifier to waiter.</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>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create ()</code> creates a new condition variable.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-wait"><a href="#val-wait" class="anchor"></a><code><span><span class="keyword">val</span> wait : <span><span class="optlabel">?mutex</span>:<a href="../Lwt_mutex/index.html#type-t">Lwt_mutex.t</a> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>wait mutex condvar</code> will cause the current thread to block, awaiting notification for a condition variable, <code>condvar</code>. If provided, the <code>mutex</code> must have been previously locked (within the scope of <code>Lwt_mutex.with_lock</code>, for example) and is temporarily unlocked until the condition is notified. Upon notification, <code>mutex</code> is re-locked before <code>wait</code> returns and the thread's activity is resumed. When the awaited condition is notified, the value parameter passed to <code>signal</code> is returned.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal"><a href="#val-signal" class="anchor"></a><code><span><span class="keyword">val</span> signal : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>signal condvar value</code> notifies that a condition is ready. A single waiting thread will be awoken and will receive the notification value which will be returned from <code>wait</code>. Note that condition notification is not "sticky", i.e. if there is no waiter when <code>signal</code> is called, the notification will be missed and the value discarded.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-broadcast"><a href="#val-broadcast" class="anchor"></a><code><span><span class="keyword">val</span> broadcast : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>broadcast condvar value</code> notifies all waiting threads. Each will be awoken in turn and will receive the same notification value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-broadcast_exn"><a href="#val-broadcast_exn" class="anchor"></a><code><span><span class="keyword">val</span> broadcast_exn : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span>exn <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>broadcast_exn condvar exn</code> fails all waiting threads with exception <code>exn</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.6.0</li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_condition (lwt.Lwt_condition)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_condition</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_condition</span></code></h1><p>Conditions</p></header><div class="odoc-content"><p>Condition variables to synchronize between threads.</p><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> <span>'a t</span></span></code></div><div class="spec-doc"><p>Condition variable type. The type parameter denotes the type of value propagated from notifier to waiter.</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>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create ()</code> creates a new condition variable.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-wait"><a href="#val-wait" class="anchor"></a><code><span><span class="keyword">val</span> wait : <span><span class="optlabel">?mutex</span>:<a href="../Lwt_mutex/index.html#type-t">Lwt_mutex.t</a> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>wait mutex condvar</code> will cause the current thread to block, awaiting notification for a condition variable, <code>condvar</code>. If provided, the <code>mutex</code> must have been previously locked (within the scope of <code>Lwt_mutex.with_lock</code>, for example) and is temporarily unlocked until the condition is notified. Upon notification, <code>mutex</code> is re-locked before <code>wait</code> returns and the thread's activity is resumed. When the awaited condition is notified, the value parameter passed to <code>signal</code> is returned.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal"><a href="#val-signal" class="anchor"></a><code><span><span class="keyword">val</span> signal : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>signal condvar value</code> notifies that a condition is ready. A single waiting thread will be awoken and will receive the notification value which will be returned from <code>wait</code>. Note that condition notification is not "sticky", i.e. if there is no waiter when <code>signal</code> is called, the notification will be missed and the value discarded.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-broadcast"><a href="#val-broadcast" class="anchor"></a><code><span><span class="keyword">val</span> broadcast : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>broadcast condvar value</code> notifies all waiting threads. Each will be awoken in turn and will receive the same notification value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-broadcast_exn"><a href="#val-broadcast_exn" class="anchor"></a><code><span><span class="keyword">val</span> broadcast_exn : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span>exn <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>broadcast_exn condvar exn</code> fails all waiting threads with exception <code>exn</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.6.0</li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ev_backend (lwt.Lwt_engine.Ev_backend)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » Ev_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_engine.Ev_backend</span></code></h1></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><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-select"><a href="#val-select" class="anchor"></a><code><span><span class="keyword">val</span> select : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-poll"><a href="#val-poll" class="anchor"></a><code><span><span class="keyword">val</span> poll : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-epoll"><a href="#val-epoll" class="anchor"></a><code><span><span class="keyword">val</span> epoll : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kqueue"><a href="#val-kqueue" class="anchor"></a><code><span><span class="keyword">val</span> kqueue : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-devpoll"><a href="#val-devpoll" class="anchor"></a><code><span><span class="keyword">val</span> devpoll : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-port"><a href="#val-port" class="anchor"></a><code><span><span class="keyword">val</span> port : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ev_backend (lwt.Lwt_engine.Ev_backend)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » Ev_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_engine.Ev_backend</span></code></h1></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><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-select"><a href="#val-select" class="anchor"></a><code><span><span class="keyword">val</span> select : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-poll"><a href="#val-poll" class="anchor"></a><code><span><span class="keyword">val</span> poll : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-epoll"><a href="#val-epoll" class="anchor"></a><code><span><span class="keyword">val</span> epoll : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kqueue"><a href="#val-kqueue" class="anchor"></a><code><span><span class="keyword">val</span> kqueue : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-devpoll"><a href="#val-devpoll" class="anchor"></a><code><span><span class="keyword">val</span> devpoll : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-port"><a href="#val-port" class="anchor"></a><code><span><span class="keyword">val</span> port : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>libev_1 (lwt.Lwt_engine.Versioned.libev_1)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_engine</a> » <a href="../index.html">Versioned</a> » libev_1</nav><header class="odoc-preamble"><h1>Class <code><span>Versioned.libev_1</span></code></h1><p>Old version of <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>. The current <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a> allows selecting the libev back end.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-loop"><a href="#val-loop" class="anchor"></a><code><span><span class="keyword">val</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-backend"><a href="#method-backend" class="anchor"></a><code><span><span class="keyword">method</span> backend : <a href="../../Ev_backend/index.html#type-t">Ev_backend.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-loop"><a href="#method-loop" class="anchor"></a><code><span><span class="keyword">method</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>libev_1 (lwt.Lwt_engine.Versioned.libev_1)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_engine</a> » <a href="../index.html">Versioned</a> » libev_1</nav><header class="odoc-preamble"><h1>Class <code><span>Versioned.libev_1</span></code></h1><p>Old version of <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>. The current <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a> allows selecting the libev back end.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-loop"><a href="#val-loop" class="anchor"></a><code><span><span class="keyword">val</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-backend"><a href="#method-backend" class="anchor"></a><code><span><span class="keyword">method</span> backend : <a href="../../Ev_backend/index.html#type-t">Ev_backend.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-loop"><a href="#method-loop" class="anchor"></a><code><span><span class="keyword">method</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>libev_2 (lwt.Lwt_engine.Versioned.libev_2)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_engine</a> » <a href="../index.html">Versioned</a> » libev_2</nav><header class="odoc-preamble"><h1>Class <code><span>Versioned.libev_2</span></code></h1><p>Since Lwt 3.0.0, this is just an alias for <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-loop"><a href="#val-loop" class="anchor"></a><code><span><span class="keyword">val</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-backend"><a href="#method-backend" class="anchor"></a><code><span><span class="keyword">method</span> backend : <a href="../../Ev_backend/index.html#type-t">Ev_backend.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-loop"><a href="#method-loop" class="anchor"></a><code><span><span class="keyword">method</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>libev_2 (lwt.Lwt_engine.Versioned.libev_2)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_engine</a> » <a href="../index.html">Versioned</a> » libev_2</nav><header class="odoc-preamble"><h1>Class <code><span>Versioned.libev_2</span></code></h1><p>Since Lwt 3.0.0, this is just an alias for <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-loop"><a href="#val-loop" class="anchor"></a><code><span><span class="keyword">val</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-backend"><a href="#method-backend" class="anchor"></a><code><span><span class="keyword">method</span> backend : <a href="../../Ev_backend/index.html#type-t">Ev_backend.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-loop"><a href="#method-loop" class="anchor"></a><code><span><span class="keyword">method</span> loop : <a href="../../index.html#type-ev_loop">ev_loop</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Versioned (lwt.Lwt_engine.Versioned)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » Versioned</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_engine.Versioned</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class anchored" id="class-libev_1"><a href="#class-libev_1" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-libev_1/index.html">libev_1</a></span><span> : <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Old version of <a href="../class-libev/index.html"><code>Lwt_engine.libev</code></a>. The current <a href="../class-libev/index.html"><code>Lwt_engine.libev</code></a> allows selecting the libev back end.</p></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-libev_2"><a href="#class-libev_2" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-libev_2/index.html">libev_2</a></span><span> : <span><span class="optlabel">?backend</span>:<a href="../Ev_backend/index.html#type-t">Ev_backend.t</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Since Lwt 3.0.0, this is just an alias for <a href="../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Versioned (lwt.Lwt_engine.Versioned)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » Versioned</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_engine.Versioned</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class anchored" id="class-libev_1"><a href="#class-libev_1" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-libev_1/index.html">libev_1</a></span><span> : <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Old version of <a href="../class-libev/index.html"><code>Lwt_engine.libev</code></a>. The current <a href="../class-libev/index.html"><code>Lwt_engine.libev</code></a> allows selecting the libev back end.</p></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-libev_2"><a href="#class-libev_2" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-libev_2/index.html">libev_2</a></span><span> : <span><span class="optlabel">?backend</span>:<a href="../Ev_backend/index.html#type-t">Ev_backend.t</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Since Lwt 3.0.0, this is just an alias for <a href="../class-libev/index.html"><code>Lwt_engine.libev</code></a>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>libev (lwt.Lwt_engine.libev)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » libev</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.libev</span></code></h1><p>Engine based on libev. If not compiled with libev support, the creation of the class will raise <a href="../../Lwt_sys/index.html#exception-Not_available"><code>Lwt_sys.Not_available</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-backend"><a href="#method-backend" class="anchor"></a><code><span><span class="keyword">method</span> backend : <a href="../Ev_backend/index.html#type-t">Ev_backend.t</a></span></code></div><div class="spec-doc"><p>The backend picked by libev.</p></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-loop"><a href="#val-loop" class="anchor"></a><code><span><span class="keyword">val</span> loop : <a href="../index.html#type-ev_loop">ev_loop</a></span></code></div><div class="spec-doc"><p>The libev loop used for this engine.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-loop"><a href="#method-loop" class="anchor"></a><code><span><span class="keyword">method</span> loop : <a href="../index.html#type-ev_loop">ev_loop</a></span></code></div><div class="spec-doc"><p>Returns <code>loop</code>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>libev (lwt.Lwt_engine.libev)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » libev</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.libev</span></code></h1><p>Engine based on libev. If not compiled with libev support, the creation of the class will raise <a href="../../Lwt_sys/index.html#exception-Not_available"><code>Lwt_sys.Not_available</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-backend"><a href="#method-backend" class="anchor"></a><code><span><span class="keyword">method</span> backend : <a href="../Ev_backend/index.html#type-t">Ev_backend.t</a></span></code></div><div class="spec-doc"><p>The backend picked by libev.</p></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-loop"><a href="#val-loop" class="anchor"></a><code><span><span class="keyword">val</span> loop : <a href="../index.html#type-ev_loop">ev_loop</a></span></code></div><div class="spec-doc"><p>The libev loop used for this engine.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-loop"><a href="#method-loop" class="anchor"></a><code><span><span class="keyword">method</span> loop : <a href="../index.html#type-ev_loop">ev_loop</a></span></code></div><div class="spec-doc"><p>Returns <code>loop</code>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>poll_based (lwt.Lwt_engine.poll_based)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » poll_based</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.poll_based</span></code></h1><p>Abstract class for engines based on a poll-like function.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-poll"><a href="#method-poll" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> poll : <span><span><span>(<a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> * bool * bool)</span> list</span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>poll_based (lwt.Lwt_engine.poll_based)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » poll_based</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.poll_based</span></code></h1><p>Abstract class for engines based on a poll-like function.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-poll"><a href="#method-poll" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> poll : <span><span><span>(<a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> * bool * bool)</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>float <span class="arrow">-></span></span>
|
||||
<span><span>(<a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> * bool * bool)</span> list</span></span></code></div><div class="spec-doc"><p><code>poll fds tiomeout</code>, where <code>fds</code> is a list of tuples of the form <code>(fd, check_readable, check_writable)</code>, waits for either:</p><ul><li>one of the file descriptor with <code>check_readable</code> set to <code>true</code> to become readable</li><li>one of the file descriptor with <code>check_writable</code> set to <code>true</code> to become writable</li><li>timeout to expire</li></ul><p>and returns the list of file descriptors with their readable and writable status.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>select (lwt.Lwt_engine.select)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » select</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.select</span></code></h1><p>Engine based on <a href="../../../ocaml/Unix/index.html#val-select"><code>Unix.select</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-abstract/index.html">abstract</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-iter"><a href="#method-iter" class="anchor"></a><code><span><span class="keyword">method</span> iter : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cleanup"><a href="#method-cleanup" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> cleanup : unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-register_readable"><a href="#method-register_readable" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> register_readable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>select (lwt.Lwt_engine.select)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » select</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.select</span></code></h1><p>Engine based on <a href="../../../ocaml/Unix/index.html#val-select"><code>Unix.select</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-abstract/index.html">abstract</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-iter"><a href="#method-iter" class="anchor"></a><code><span><span class="keyword">method</span> iter : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cleanup"><a href="#method-cleanup" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> cleanup : unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-register_readable"><a href="#method-register_readable" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> register_readable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../../../ocaml/Stdlib/Lazy/index.html#type-t">Lazy.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-register_writable"><a href="#method-register_writable" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> register_writable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>select_based (lwt.Lwt_engine.select_based)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » select_based</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.select_based</span></code></h1><p>Abstract class for engines based on a select-like function.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-select"><a href="#method-select" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> select : <span><span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> list</span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>select_based (lwt.Lwt_engine.select_based)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » select_based</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_engine.select_based</span></code></h1><p>Abstract class for engines based on a select-like function.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-type-t/index.html">t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-select"><a href="#method-select" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> <span class="keyword">virtual</span> select : <span><span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> list</span> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>float <span class="arrow">-></span></span>
|
||||
<span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> list</span> * <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> list</span></span></code></div><div class="spec-doc"><p><code>select fds_r fds_w timeout</code> waits for either:</p><ul><li>one of the file descriptor of <code>fds_r</code> to become readable</li><li>one of the file descriptor of <code>fds_w</code> to become writable</li><li>timeout to expire</li></ul><p>and returns the list of readable file descriptor and the list of writable file descriptors.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (lwt.Lwt_engine.t)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » t</nav><header class="odoc-preamble"><h1>Class type <code><span>Lwt_engine.t</span></code></h1><p>Type of engines.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-abstract/index.html">abstract</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-iter"><a href="#method-iter" class="anchor"></a><code><span><span class="keyword">method</span> iter : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cleanup"><a href="#method-cleanup" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> cleanup : unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-register_readable"><a href="#method-register_readable" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> register_readable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (lwt.Lwt_engine.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_engine</a> » t</nav><header class="odoc-preamble"><h1>Class type <code><span>Lwt_engine.t</span></code></h1><p>Type of engines.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-abstract/index.html">abstract</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-iter"><a href="#method-iter" class="anchor"></a><code><span><span class="keyword">method</span> iter : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cleanup"><a href="#method-cleanup" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> cleanup : unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-register_readable"><a href="#method-register_readable" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> register_readable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../../../ocaml/Stdlib/Lazy/index.html#type-t">Lazy.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-register_writable"><a href="#method-register_writable" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">private</span> register_writable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_gc (lwt.Lwt_gc)</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> » <a href="../index.html">lwt</a> » Lwt_gc</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_gc</span></code></h1><p>Interaction with the garbage collector</p></header><div class="odoc-content"><p>This module offers a convenient way to add a finaliser launching a thread to a value, without having to use <code>Lwt_unix.run</code> in the finaliser.</p><div class="odoc-spec"><div class="spec value anchored" id="val-finalise"><a href="#val-finalise" class="anchor"></a><code><span><span class="keyword">val</span> finalise : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>finalise f x</code> ensures <code>f x</code> is evaluated after <code>x</code> has been garbage collected. If <code>f x</code> yields, then Lwt will wait for its termination at the end of the program.</p><p>Note that <code>f x</code> is not called at garbage collection time, but later in the main loop.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-finalise_or_exit"><a href="#val-finalise_or_exit" class="anchor"></a><code><span><span class="keyword">val</span> finalise_or_exit : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>finalise_or_exit f x</code> call <code>f x</code> when <code>x</code> is garbage collected or (exclusively) when the program exits.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_gc (lwt.Lwt_gc)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_gc</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_gc</span></code></h1><p>Interaction with the garbage collector</p></header><div class="odoc-content"><p>This module offers a convenient way to add a finaliser launching a thread to a value, without having to use <code>Lwt_unix.run</code> in the finaliser.</p><div class="odoc-spec"><div class="spec value anchored" id="val-finalise"><a href="#val-finalise" class="anchor"></a><code><span><span class="keyword">val</span> finalise : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>finalise f x</code> ensures <code>f x</code> is evaluated after <code>x</code> has been garbage collected. If <code>f x</code> yields, then Lwt will wait for its termination at the end of the program.</p><p>Note that <code>f x</code> is not called at garbage collection time, but later in the main loop.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-finalise_or_exit"><a href="#val-finalise_or_exit" class="anchor"></a><code><span><span class="keyword">val</span> finalise_or_exit : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>finalise_or_exit f x</code> call <code>f x</code> when <code>x</code> is garbage collected or (exclusively) when the program exits.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Versioned (lwt.Lwt_io.Versioned)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_io</a> » Versioned</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_io.Versioned</span></code></h1><p>Versioned variants of APIs undergoing breaking changes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-establish_server_1"><a href="#val-establish_server_1" class="anchor"></a><code><span><span class="keyword">val</span> establish_server_1 :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Versioned (lwt.Lwt_io.Versioned)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_io</a> » Versioned</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_io.Versioned</span></code></h1><p>Versioned variants of APIs undergoing breaking changes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-establish_server_1"><a href="#val-establish_server_1" class="anchor"></a><code><span><span class="keyword">val</span> establish_server_1 :
|
||||
<span><span class="optlabel">?fd</span>:<a href="../../Lwt_unix/index.html#type-file_descr">Lwt_unix.file_descr</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?buffer_size</span>:int <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?backlog</span>:int <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Enter_iter_hooks (lwt.Lwt_main.Enter_iter_hooks)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Enter_iter_hooks</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_main.Enter_iter_hooks</span></code></h1><p>Hooks, of type <code>unit -> unit</code>, that are called before each iteration of the Lwt main loop.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span><span> = <span class="type-var">'return_value</span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Enter_iter_hooks (lwt.Lwt_main.Enter_iter_hooks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Enter_iter_hooks</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_main.Enter_iter_hooks</span></code></h1><p>Hooks, of type <code>unit -> unit</code>, that are called before each iteration of the Lwt main loop.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span><span> = <span class="type-var">'return_value</span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Exit_hooks (lwt.Lwt_main.Exit_hooks)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Exit_hooks</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_main.Exit_hooks</span></code></h1><p>Promise-returning hooks, of type <code>unit -> unit Lwt.t</code>, that are called at process exit. Exceptions raised by these hooks are ignored.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span><span> = <span><span class="type-var">'return_value</span> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Exit_hooks (lwt.Lwt_main.Exit_hooks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Exit_hooks</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_main.Exit_hooks</span></code></h1><p>Promise-returning hooks, of type <code>unit -> unit Lwt.t</code>, that are called at process exit. Exceptions raised by these hooks are ignored.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span><span> = <span><span class="type-var">'return_value</span> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Leave_iter_hooks (lwt.Lwt_main.Leave_iter_hooks)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Leave_iter_hooks</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_main.Leave_iter_hooks</span></code></h1><p>Hooks, of type <code>unit -> unit</code>, that are called after each iteration of the Lwt main loop.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span><span> = <span class="type-var">'return_value</span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Leave_iter_hooks (lwt.Lwt_main.Leave_iter_hooks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Leave_iter_hooks</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_main.Leave_iter_hooks</span></code></h1><p>Hooks, of type <code>unit -> unit</code>, that are called after each iteration of the Lwt main loop.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span><span> = <span class="type-var">'return_value</span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Hooks (lwt.Lwt_main.Hooks)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Hooks</nav><header class="odoc-preamble"><h1>Module type <code><span>Lwt_main.Hooks</span></code></h1><p>Hook sequences. Each module of this type is a set of hooks, to be run by Lwt at certain points during execution. See modules <a href="../Enter_iter_hooks/index.html"><code>Enter_iter_hooks</code></a>, <a href="../Leave_iter_hooks/index.html"><code>Leave_iter_hooks</code></a>, and <a href="../Exit_hooks/index.html"><code>Exit_hooks</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Hooks (lwt.Lwt_main.Hooks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_main</a> » Hooks</nav><header class="odoc-preamble"><h1>Module type <code><span>Lwt_main.Hooks</span></code></h1><p>Hook sequences. Each module of this type is a set of hooks, to be run by Lwt at certain points during execution. See modules <a href="../Enter_iter_hooks/index.html"><code>Enter_iter_hooks</code></a>, <a href="../Leave_iter_hooks/index.html"><code>Leave_iter_hooks</code></a>, and <a href="../Exit_hooks/index.html"><code>Exit_hooks</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span>'return_value kind</span></span></code></div><div class="spec-doc"><p>Hooks are functions of either type <code>unit -> unit</code> or <code>unit -> unit Lwt.t</code>; this type constructor is used only to express both possibilities in one signature.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-hook"><a href="#type-hook" class="anchor"></a><code><span><span class="keyword">type</span> hook</span></code></div><div class="spec-doc"><p>Values of type <code>hook</code> represent hooks that have been added, so that they can be removed later (if needed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_first"><a href="#val-add_first" class="anchor"></a><code><span><span class="keyword">val</span> add_first : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>first</em>, before any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_last"><a href="#val-add_last" class="anchor"></a><code><span><span class="keyword">val</span> add_last : <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="#type-kind">kind</a></span>)</span> <span class="arrow">-></span></span> <a href="#type-hook">hook</a></span></code></div><div class="spec-doc"><p>Adds a hook to the hook sequence underlying this module, to be run <em>last</em>, after any other hooks already added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-hook">hook</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes a hook added by <a href="#val-add_first"><code>add_first</code></a> or <a href="#val-add_last"><code>add_last</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span><span class="keyword">val</span> remove_all : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Removes all hooks from the hook sequence underlying this module.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_mutex (lwt.Lwt_mutex)</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> » <a href="../index.html">lwt</a> » Lwt_mutex</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_mutex</span></code></h1><p>Cooperative locks for mutual exclusion</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>Type of Lwt mutexes</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>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ()</code> creates a new mutex, which is initially unlocked</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lock"><a href="#val-lock" class="anchor"></a><code><span><span class="keyword">val</span> lock : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>lock mutex</code> lockcs the mutex, that is:</p><ul><li>if the mutex is unlocked, then it is marked as locked and <a href="#val-lock"><code>lock</code></a> returns immediately</li></ul><ul><li>if it is locked, then <a href="#val-lock"><code>lock</code></a> waits for all threads waiting on the mutex to terminate, then it resumes when the last one unlocks the mutex</li></ul><p>Note: threads are woken up in the same order they try to lock the mutex</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unlock"><a href="#val-unlock" class="anchor"></a><code><span><span class="keyword">val</span> unlock : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>unlock mutex</code> unlock the mutex if no threads is waiting on it. Otherwise it will eventually removes the first one and resumes it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_locked"><a href="#val-is_locked" class="anchor"></a><code><span><span class="keyword">val</span> is_locked : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>locked mutex</code> returns whether <code>mutex</code> is currently locked</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_empty mutex</code> returns <code>true</code> if they are no thread waiting on the mutex, and <code>false</code> otherwise</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_lock"><a href="#val-with_lock" class="anchor"></a><code><span><span class="keyword">val</span> with_lock : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>with_lock lock f</code> is used to lock a mutex within a block scope. The function <code>f ()</code> is called with the mutex locked, and its result is returned from the call to <code>with_lock</code>. If an exception is raised from f, the mutex is also unlocked before the scope of <code>with_lock</code> is exited.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_mutex (lwt.Lwt_mutex)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_mutex</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_mutex</span></code></h1><p>Cooperative locks for mutual exclusion</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>Type of Lwt mutexes</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>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ()</code> creates a new mutex, which is initially unlocked</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lock"><a href="#val-lock" class="anchor"></a><code><span><span class="keyword">val</span> lock : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>lock mutex</code> lockcs the mutex, that is:</p><ul><li>if the mutex is unlocked, then it is marked as locked and <a href="#val-lock"><code>lock</code></a> returns immediately</li></ul><ul><li>if it is locked, then <a href="#val-lock"><code>lock</code></a> waits for all threads waiting on the mutex to terminate, then it resumes when the last one unlocks the mutex</li></ul><p>Note: threads are woken up in the same order they try to lock the mutex</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unlock"><a href="#val-unlock" class="anchor"></a><code><span><span class="keyword">val</span> unlock : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>unlock mutex</code> unlock the mutex if no threads is waiting on it. Otherwise it will eventually removes the first one and resumes it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_locked"><a href="#val-is_locked" class="anchor"></a><code><span><span class="keyword">val</span> is_locked : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>locked mutex</code> returns whether <code>mutex</code> is currently locked</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_empty mutex</code> returns <code>true</code> if they are no thread waiting on the mutex, and <code>false</code> otherwise</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_lock"><a href="#val-with_lock" class="anchor"></a><code><span><span class="keyword">val</span> with_lock : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>with_lock lock f</code> is used to lock a mutex within a block scope. The function <code>f ()</code> is called with the mutex locked, and its result is returned from the call to <code>with_lock</code>. If an exception is raised from f, the mutex is also unlocked before the scope of <code>with_lock</code> is exited.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_mvar (lwt.Lwt_mvar)</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> » <a href="../index.html">lwt</a> » Lwt_mvar</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_mvar</span></code></h1><p>Mailbox variables</p></header><div class="odoc-content"><p>“Mailbox” variables implement a synchronising variable, used for communication between concurrent threads.</p><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> <span>'a t</span></span></code></div><div class="spec-doc"><p>The type of a mailbox variable. Mailbox variables are used to communicate values between threads in a synchronous way. The type parameter specifies the type of the value propagated from <code>put</code> to <code>take</code>.</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><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create v</code> creates a new mailbox variable containing value <code>v</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_empty"><a href="#val-create_empty" class="anchor"></a><code><span><span class="keyword">val</span> create_empty : <span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create ()</code> creates a new empty mailbox variable.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-put"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>put mvar value</code> puts a value into a mailbox variable. This value will remain in the mailbox until <code>take</code> is called to remove it. If the mailbox is not empty, the current thread will block until it is emptied.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-take"><a href="#val-take" class="anchor"></a><code><span><span class="keyword">val</span> take : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>take mvar</code> will take any currently available value from the mailbox variable. If no value is currently available, the current thread will block, awaiting a value to be <code>put</code> by another thread.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-take_available"><a href="#val-take_available" class="anchor"></a><code><span><span class="keyword">val</span> take_available : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> option</span></span></code></div><div class="spec-doc"><p><code>take_available mvar</code> immediately takes the value from <code>mvar</code> without blocking, returning <code>None</code> if the mailbox is empty.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_empty mvar</code> indicates if <code>put mvar</code> can be called without blocking.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2.0</li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_mvar (lwt.Lwt_mvar)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_mvar</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_mvar</span></code></h1><p>Mailbox variables</p></header><div class="odoc-content"><p>“Mailbox” variables implement a synchronising variable, used for communication between concurrent threads.</p><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> <span>'a t</span></span></code></div><div class="spec-doc"><p>The type of a mailbox variable. Mailbox variables are used to communicate values between threads in a synchronous way. The type parameter specifies the type of the value propagated from <code>put</code> to <code>take</code>.</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><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create v</code> creates a new mailbox variable containing value <code>v</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_empty"><a href="#val-create_empty" class="anchor"></a><code><span><span class="keyword">val</span> create_empty : <span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>create ()</code> creates a new empty mailbox variable.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-put"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>put mvar value</code> puts a value into a mailbox variable. This value will remain in the mailbox until <code>take</code> is called to remove it. If the mailbox is not empty, the current thread will block until it is emptied.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-take"><a href="#val-take" class="anchor"></a><code><span><span class="keyword">val</span> take : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>take mvar</code> will take any currently available value from the mailbox variable. If no value is currently available, the current thread will block, awaiting a value to be <code>put</code> by another thread.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-take_available"><a href="#val-take_available" class="anchor"></a><code><span><span class="keyword">val</span> take_available : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> option</span></span></code></div><div class="spec-doc"><p><code>take_available mvar</code> immediately takes the value from <code>mvar</code> without blocking, returning <code>None</code> if the mailbox is empty.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_empty mvar</code> indicates if <code>put mvar</code> can be called without blocking.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2.0</li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_pool (lwt.Lwt_pool)</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> » <a href="../index.html">lwt</a> » Lwt_pool</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_pool</span></code></h1><p>External resource pools.</p><p>This module provides an abstraction for managing collections of resources. One example use case is for managing a pool of database connections, where instead of establishing a new connection each time you need one (which is expensive), you can keep a pool of opened connections and reuse ones that are free.</p><p>It also provides the capability of:</p><ul><li>specifying the maximum number of resources that the pool can manage simultaneously,</li><li>checking whether a resource is still valid before/after use, and</li><li>performing cleanup logic before dropping a resource.</li></ul><p>The following example illustrates how it is used with an imaginary <code>Db</code> module:</p><pre class="language-ocaml"><code>let uri = "postgresql://localhost:5432"
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_pool (lwt.Lwt_pool)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_pool</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_pool</span></code></h1><p>External resource pools.</p><p>This module provides an abstraction for managing collections of resources. One example use case is for managing a pool of database connections, where instead of establishing a new connection each time you need one (which is expensive), you can keep a pool of opened connections and reuse ones that are free.</p><p>It also provides the capability of:</p><ul><li>specifying the maximum number of resources that the pool can manage simultaneously,</li><li>checking whether a resource is still valid before/after use, and</li><li>performing cleanup logic before dropping a resource.</li></ul><p>The following example illustrates how it is used with an imaginary <code>Db</code> module:</p><pre class="language-ocaml"><code>let uri = "postgresql://localhost:5432"
|
||||
|
||||
(* Create a database connection pool with max size of 10. *)
|
||||
let pool =
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ord (lwt.Lwt_pqueue.Make.Ord)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_pqueue</a> » <a href="../index.html">Make</a> » Ord</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.Ord</span></code></h1></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><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ord (lwt.Lwt_pqueue.Make.Ord)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_pqueue</a> » <a href="../index.html">Make</a> » Ord</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.Ord</span></code></h1></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><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_pqueue (lwt.Lwt_pqueue)</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> » <a href="../index.html">lwt</a> » Lwt_pqueue</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_pqueue</span></code></h1><p>Functional priority queues (deprecated).</p><p>A priority queue maintains, in the abstract sense, a set of elements in order, and supports fast lookup and removal of the first (“minimum”) element. This is used in Lwt for organizing threads that are waiting for timeouts.</p><p>The priority queues in this module preserve “duplicates”: elements that compare equal in their order.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>This module is an internal implementation detail of Lwt, and may be removed from the API at some point in the future. For alternatives, see, for example: <a href="https://usr.lmf.cnrs.fr/~jcf/software.en.html#heap">Heaps</a> by Jean-Cristophe Filliatre, <a href="https://simon.cedeela.fr/~simon/software/containers/CCHeap.html">containers</a>, <a href="https://ocaml-batteries-team.github.io/batteries-included/hdoc2/BatHeap.html">Batteries</a>, or <a href="https://github.com/pqwy/psq">psq</a>.</p></li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-OrderedType"><a href="#module-type-OrderedType" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-OrderedType/index.html">OrderedType</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature pairing an element type with an ordering function.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature of priority queues.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-Ord/index.html">Ord</a> : <a href="module-type-OrderedType/index.html">OrderedType</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-elt">elt</a> = <a href="Make/argument-1-Ord/index.html#type-t">Ord.t</a></span></span></code></div><div class="spec-doc"><p>Generates priority queue types from ordered types.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_pqueue (lwt.Lwt_pqueue)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_pqueue</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_pqueue</span></code></h1><p>Functional priority queues (deprecated).</p><p>A priority queue maintains, in the abstract sense, a set of elements in order, and supports fast lookup and removal of the first (“minimum”) element. This is used in Lwt for organizing threads that are waiting for timeouts.</p><p>The priority queues in this module preserve “duplicates”: elements that compare equal in their order.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>This module is an internal implementation detail of Lwt, and may be removed from the API at some point in the future. For alternatives, see, for example: <a href="https://usr.lmf.cnrs.fr/~jcf/software.en.html#heap">Heaps</a> by Jean-Cristophe Filliatre, <a href="https://simon.cedeela.fr/~simon/software/containers/CCHeap.html">containers</a>, <a href="https://ocaml-batteries-team.github.io/batteries-included/hdoc2/BatHeap.html">Batteries</a>, or <a href="https://github.com/pqwy/psq">psq</a>.</p></li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-OrderedType"><a href="#module-type-OrderedType" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-OrderedType/index.html">OrderedType</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature pairing an element type with an ordering function.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature of priority queues.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-Ord/index.html">Ord</a> : <a href="module-type-OrderedType/index.html">OrderedType</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-elt">elt</a> = <a href="Make/argument-1-Ord/index.html#type-t">Ord.t</a></span></span></code></div><div class="spec-doc"><p>Generates priority queue types from ordered types.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>OrderedType (lwt.Lwt_pqueue.OrderedType)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_pqueue</a> » OrderedType</nav><header class="odoc-preamble"><h1>Module type <code><span>Lwt_pqueue.OrderedType</span></code></h1><p>Signature pairing an element type with an ordering function.</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><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>OrderedType (lwt.Lwt_pqueue.OrderedType)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_pqueue</a> » OrderedType</nav><header class="odoc-preamble"><h1>Module type <code><span>Lwt_pqueue.OrderedType</span></code></h1><p>Signature pairing an element type with an ordering function.</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><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process (lwt.Lwt_process.process)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdin"><a href="#method-stdin" class="anchor"></a><code><span><span class="keyword">method</span> stdin : <a href="../../Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdout"><a href="#method-stdout" class="anchor"></a><code><span><span class="keyword">method</span> stdout : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process (lwt.Lwt_process.process)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdin"><a href="#method-stdin" class="anchor"></a><code><span><span class="keyword">method</span> stdin : <a href="../../Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdout"><a href="#method-stdout" class="anchor"></a><code><span><span class="keyword">method</span> stdout : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_full (lwt.Lwt_process.process_full)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_full</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_full</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdin"><a href="#method-stdin" class="anchor"></a><code><span><span class="keyword">method</span> stdin : <a href="../../Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdout"><a href="#method-stdout" class="anchor"></a><code><span><span class="keyword">method</span> stdout : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stderr"><a href="#method-stderr" class="anchor"></a><code><span><span class="keyword">method</span> stderr : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_full (lwt.Lwt_process.process_full)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_full</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_full</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdin"><a href="#method-stdin" class="anchor"></a><code><span><span class="keyword">method</span> stdin : <a href="../../Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdout"><a href="#method-stdout" class="anchor"></a><code><span><span class="keyword">method</span> stdout : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stderr"><a href="#method-stderr" class="anchor"></a><code><span><span class="keyword">method</span> stderr : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_in (lwt.Lwt_process.process_in)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_in</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_in</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdout"><a href="#method-stdout" class="anchor"></a><code><span><span class="keyword">method</span> stdout : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div><div class="spec-doc"><p>The standard output of the process</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_in (lwt.Lwt_process.process_in)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_in</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_in</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdout"><a href="#method-stdout" class="anchor"></a><code><span><span class="keyword">method</span> stdout : <a href="../../Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a></span></code></div><div class="spec-doc"><p>The standard output of the process</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_none (lwt.Lwt_process.process_none)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_none</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_none</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-pid"><a href="#method-pid" class="anchor"></a><code><span><span class="keyword">method</span> pid : int</span></code></div><div class="spec-doc"><p>Pid of the sub-process</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-state"><a href="#method-state" class="anchor"></a><code><span><span class="keyword">method</span> state : <a href="../index.html#type-state">state</a></span></code></div><div class="spec-doc"><p>Return the state of the process</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-kill"><a href="#method-kill" class="anchor"></a><code><span><span class="keyword">method</span> kill : <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>kill signum</code> sends <code>signum</code> to the process if it is still running.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-terminate"><a href="#method-terminate" class="anchor"></a><code><span><span class="keyword">method</span> terminate : unit</span></code></div><div class="spec-doc"><p>Terminates the process. It is equivalent to <code>kill Sys.sigkill</code> on Unix but also works on Windows (unlike <code>Lwt_process.process_none.kill</code>).</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-status"><a href="#method-status" class="anchor"></a><code><span><span class="keyword">method</span> status : <span><a href="../../../ocaml/Unix/index.html#type-process_status">Unix.process_status</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Threads which wait for the sub-process to exit then returns its exit status</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-rusage"><a href="#method-rusage" class="anchor"></a><code><span><span class="keyword">method</span> rusage : <span><a href="../../Lwt_unix/index.html#type-resource_usage">Lwt_unix.resource_usage</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Threads which wait for the sub-process to exit then returns its resource usages</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span><a href="../../../ocaml/Unix/index.html#type-process_status">Unix.process_status</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Closes the process and returns its exit status. This closes all channels used to communicate with the process</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_none (lwt.Lwt_process.process_none)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_none</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_none</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-pid"><a href="#method-pid" class="anchor"></a><code><span><span class="keyword">method</span> pid : int</span></code></div><div class="spec-doc"><p>Pid of the sub-process</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-state"><a href="#method-state" class="anchor"></a><code><span><span class="keyword">method</span> state : <a href="../index.html#type-state">state</a></span></code></div><div class="spec-doc"><p>Return the state of the process</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-kill"><a href="#method-kill" class="anchor"></a><code><span><span class="keyword">method</span> kill : <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>kill signum</code> sends <code>signum</code> to the process if it is still running.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-terminate"><a href="#method-terminate" class="anchor"></a><code><span><span class="keyword">method</span> terminate : unit</span></code></div><div class="spec-doc"><p>Terminates the process. It is equivalent to <code>kill Sys.sigkill</code> on Unix but also works on Windows (unlike <code>Lwt_process.process_none.kill</code>).</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-status"><a href="#method-status" class="anchor"></a><code><span><span class="keyword">method</span> status : <span><a href="../../../ocaml/Unix/index.html#type-process_status">Unix.process_status</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Threads which wait for the sub-process to exit then returns its exit status</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-rusage"><a href="#method-rusage" class="anchor"></a><code><span><span class="keyword">method</span> rusage : <span><a href="../../Lwt_unix/index.html#type-resource_usage">Lwt_unix.resource_usage</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Threads which wait for the sub-process to exit then returns its resource usages</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span><a href="../../../ocaml/Unix/index.html#type-process_status">Unix.process_status</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Closes the process and returns its exit status. This closes all channels used to communicate with the process</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_out (lwt.Lwt_process.process_out)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_out</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_out</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdin"><a href="#method-stdin" class="anchor"></a><code><span><span class="keyword">method</span> stdin : <a href="../../Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a></span></code></div><div class="spec-doc"><p>The standard input of the process</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>process_out (lwt.Lwt_process.process_out)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_process</a> » process_out</nav><header class="odoc-preamble"><h1>Class <code><span>Lwt_process.process_out</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-process_none/index.html">process_none</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-stdin"><a href="#method-stdin" class="anchor"></a><code><span><span class="keyword">method</span> stdin : <a href="../../Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a></span></code></div><div class="spec-doc"><p>The standard input of the process</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (lwt.Lwt_result.Infix)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_result</a> » Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_result.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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</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-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (lwt.Lwt_result.Infix)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_result</a> » Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_result.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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</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-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Open_on_rhs (lwt.Lwt_result.Let_syntax.Let_syntax.Open_on_rhs)</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> » <a href="../../../../index.html">lwt</a> » <a href="../../../index.html">Lwt_result</a> » <a href="../../index.html">Let_syntax</a> » <a href="../index.html">Let_syntax</a> » Open_on_rhs</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Open_on_rhs</span></code></h1></header><div class="odoc-content"></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Open_on_rhs (lwt.Lwt_result.Let_syntax.Let_syntax.Open_on_rhs)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../../index.html">lwt</a> » <a href="../../../index.html">Lwt_result</a> » <a href="../../index.html">Let_syntax</a> » <a href="../index.html">Let_syntax</a> » Open_on_rhs</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Open_on_rhs</span></code></h1></header><div class="odoc-content"></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt_result.Let_syntax.Let_syntax)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_result</a> » <a href="../index.html">Let_syntax</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-return"><code>Lwt_result.return</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-map"><code>Lwt_result.map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind"><a href="#val-bind" class="anchor"></a><code><span><span class="keyword">val</span> bind : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-bind"><code>Lwt_result.bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-both"><a href="#val-both" class="anchor"></a><code><span><span class="keyword">val</span> both : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</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 class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-both"><code>Lwt_result.both</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Open_on_rhs"><a href="#module-Open_on_rhs" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Open_on_rhs/index.html">Open_on_rhs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt_result.Let_syntax.Let_syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_result</a> » <a href="../index.html">Let_syntax</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-return"><code>Lwt_result.return</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-map"><code>Lwt_result.map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind"><a href="#val-bind" class="anchor"></a><code><span><span class="keyword">val</span> bind : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="label">f</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-bind"><code>Lwt_result.bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-both"><a href="#val-both" class="anchor"></a><code><span><span class="keyword">val</span> both : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</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 class="type-var">'e</span>)</span> <a href="../../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../index.html#val-both"><code>Lwt_result.both</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Open_on_rhs"><a href="#module-Open_on_rhs" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Open_on_rhs/index.html">Open_on_rhs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt_result.Let_syntax)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_result</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_result.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Let_syntax"><a href="#module-Let_syntax" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Let_syntax/index.html">Let_syntax</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (lwt.Lwt_result.Let_syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_result</a> » Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_result.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Let_syntax"><a href="#module-Let_syntax" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Let_syntax/index.html">Let_syntax</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (lwt.Lwt_result.Syntax)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_result</a> » Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_result.Syntax</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#let-syntax">Let syntax</a></li><li><a href="#monadic-syntax">Monadic syntax</a></li><li><a href="#applicative-syntax">Applicative syntax</a></li></ul></nav></div><div class="odoc-content"><h4 id="let-syntax"><a href="#let-syntax" class="anchor"></a>Let syntax</h4><h2 id="monadic-syntax"><a href="#monadic-syntax" class="anchor"></a>Monadic syntax</h2><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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-bind"><code>bind</code></a>.</p></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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</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 class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div><h2 id="applicative-syntax"><a href="#applicative-syntax" class="anchor"></a>Applicative syntax</h2><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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-map"><code>map</code></a>.</p></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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</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 class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (lwt.Lwt_result.Syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_result</a> » Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_result.Syntax</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#let-syntax">Let syntax</a></li><li><a href="#monadic-syntax">Monadic syntax</a></li><li><a href="#applicative-syntax">Applicative syntax</a></li></ul></nav></div><div class="odoc-content"><h4 id="let-syntax"><a href="#let-syntax" class="anchor"></a>Let syntax</h4><h2 id="monadic-syntax"><a href="#monadic-syntax" class="anchor"></a>Monadic syntax</h2><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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-bind"><code>bind</code></a>.</p></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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</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 class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div><h2 id="applicative-syntax"><a href="#applicative-syntax" class="anchor"></a>Applicative syntax</h2><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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</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>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-map"><code>map</code></a>.</p></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>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</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 class="type-var">'e</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Syntax for <a href="../index.html#val-both"><code>both</code></a>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>bounded_push (lwt.Lwt_stream.bounded_push)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_stream</a> » bounded_push</nav><header class="odoc-preamble"><h1>Class type <code><span>Lwt_stream.bounded_push</span></code></h1><p>Type of sources for bounded push-streams.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-size"><a href="#method-size" class="anchor"></a><code><span><span class="keyword">method</span> size : int</span></code></div><div class="spec-doc"><p>Size of the stream.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-resize"><a href="#method-resize" class="anchor"></a><code><span><span class="keyword">method</span> resize : <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Change the size of the stream queue. Note that the new size can smaller than the current stream queue size.</p><p>It raises <code>Stdlib.Invalid_argument</code> if <code>size < 0</code>.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-push"><a href="#method-push" class="anchor"></a><code><span><span class="keyword">method</span> push : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Pushes a new element to the stream. If the stream is full then it will block until one element is consumed. If another thread is already blocked on <code>push</code>, it raises <code>Lwt_stream.Full</code>.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : unit</span></code></div><div class="spec-doc"><p>Closes the stream. Any thread currently blocked on a call to the <code>push</code> method fails with <code>Lwt_stream.Closed</code>.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-count"><a href="#method-count" class="anchor"></a><code><span><span class="keyword">method</span> count : int</span></code></div><div class="spec-doc"><p>Number of elements in the stream queue.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-blocked"><a href="#method-blocked" class="anchor"></a><code><span><span class="keyword">method</span> blocked : bool</span></code></div><div class="spec-doc"><p>Is a thread is blocked on a call to the <code>push</code> method?</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-closed"><a href="#method-closed" class="anchor"></a><code><span><span class="keyword">method</span> closed : bool</span></code></div><div class="spec-doc"><p>Is the stream closed?</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_reference"><a href="#method-set_reference" class="anchor"></a><code><span><span class="keyword">method</span> set_reference : 'a. <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set the reference to an external source.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>bounded_push (lwt.Lwt_stream.bounded_push)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_stream</a> » bounded_push</nav><header class="odoc-preamble"><h1>Class type <code><span>Lwt_stream.bounded_push</span></code></h1><p>Type of sources for bounded push-streams.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-size"><a href="#method-size" class="anchor"></a><code><span><span class="keyword">method</span> size : int</span></code></div><div class="spec-doc"><p>Size of the stream.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-resize"><a href="#method-resize" class="anchor"></a><code><span><span class="keyword">method</span> resize : <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Change the size of the stream queue. Note that the new size can smaller than the current stream queue size.</p><p>It raises <code>Stdlib.Invalid_argument</code> if <code>size < 0</code>.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-push"><a href="#method-push" class="anchor"></a><code><span><span class="keyword">method</span> push : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Pushes a new element to the stream. If the stream is full then it will block until one element is consumed. If another thread is already blocked on <code>push</code>, it raises <code>Lwt_stream.Full</code>.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : unit</span></code></div><div class="spec-doc"><p>Closes the stream. Any thread currently blocked on a call to the <code>push</code> method fails with <code>Lwt_stream.Closed</code>.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-count"><a href="#method-count" class="anchor"></a><code><span><span class="keyword">method</span> count : int</span></code></div><div class="spec-doc"><p>Number of elements in the stream queue.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-blocked"><a href="#method-blocked" class="anchor"></a><code><span><span class="keyword">method</span> blocked : bool</span></code></div><div class="spec-doc"><p>Is a thread is blocked on a call to the <code>push</code> method?</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-closed"><a href="#method-closed" class="anchor"></a><code><span><span class="keyword">method</span> closed : bool</span></code></div><div class="spec-doc"><p>Is the stream closed?</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_reference"><a href="#method-set_reference" class="anchor"></a><code><span><span class="keyword">method</span> set_reference : 'a. <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set the reference to an external source.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_switch (lwt.Lwt_switch)</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> » <a href="../index.html">lwt</a> » Lwt_switch</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_switch</span></code></h1><p>Lwt switches</p></header><div class="odoc-content"><p>Switch has two goals:</p><ul><li>being able to free multiple resources at the same time,</li><li>offer a better alternative than always returning an id to free some resource.</li></ul><p>For example, consider the following interface:</p><pre class="language-ocaml"><code> type id
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_switch (lwt.Lwt_switch)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_switch</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_switch</span></code></h1><p>Lwt switches</p></header><div class="odoc-content"><p>Switch has two goals:</p><ul><li>being able to free multiple resources at the same time,</li><li>offer a better alternative than always returning an id to free some resource.</li></ul><p>For example, consider the following interface:</p><pre class="language-ocaml"><code> type id
|
||||
|
||||
val free : id -> unit Lwt.t
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>H (lwt.Lwt_throttle.Make.H)</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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_throttle</a> » <a href="../index.html">Make</a> » H</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.H</span></code></h1></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>The type of the hashtable keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>The equality predicate used to compare keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>A hashing function on keys. It must be such that if two keys are equal according to <code>equal</code>, then they have identical hash values as computed by <code>hash</code>. Examples: suitable (<code>equal</code>, <code>hash</code>) pairs for arbitrary key types include</p><ul><li>(<code>(=)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by structure (provided objects do not contain floats)</li><li>(<code>(fun x y -> compare x y = 0)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by structure and handling <a href="../../../../ocaml/Stdlib/index.html#val-nan"><code>Stdlib.nan</code></a> correctly</li><li>(<code>(==)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by physical equality (e.g. for mutable or cyclic objects).</li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>H (lwt.Lwt_throttle.Make.H)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">lwt</a> » <a href="../../index.html">Lwt_throttle</a> » <a href="../index.html">Make</a> » H</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.H</span></code></h1></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>The type of the hashtable keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>The equality predicate used to compare keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>A hashing function on keys. It must be such that if two keys are equal according to <code>equal</code>, then they have identical hash values as computed by <code>hash</code>. Examples: suitable (<code>equal</code>, <code>hash</code>) pairs for arbitrary key types include</p><ul><li>(<code>(=)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by structure (provided objects do not contain floats)</li><li>(<code>(fun x y -> compare x y = 0)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by structure and handling <a href="../../../../ocaml/Stdlib/index.html#val-nan"><code>Stdlib.nan</code></a> correctly</li><li>(<code>(==)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by physical equality (e.g. for mutable or cyclic objects).</li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (lwt.Lwt_throttle.Make)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_throttle</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_throttle.Make</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav></div><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-H"><a href="#argument-1-H" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-H/index.html">H</a></span><span> : <a href="../../../ocaml/Stdlib/Hashtbl/module-type-HashedType/index.html">Stdlib.Hashtbl.HashedType</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-key"><a href="#type-key" class="anchor"></a><code><span><span class="keyword">type</span> key</span><span> = <a href="argument-1-H/index.html#type-t">H.t</a></span></code></div></div><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><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><span class="label">rate</span>:int <span class="arrow">-></span></span> <span><span class="label">max</span>:int <span class="arrow">-></span></span> <span><span class="label">n</span>:int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Creates a rate limiter.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">rate</span> <p>Maximum number of promise resolutions per second, per channel.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">max</span> <p>Maximum number of pending promises allowed at once, over all channels.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">n</span> <p>Initial size of the internal channel hash table. This should be approximately the number of different channels that will be used.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-wait"><a href="#val-wait" class="anchor"></a><code><span><span class="keyword">val</span> wait : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-key">key</a> <span class="arrow">-></span></span> <span>bool <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>Lwt_throttle.wait limiter channel</code> returns a new promise associated with the given rate limiter and channel.</p><p>If the maximum number of pending promises for <code>limiter</code> has <em>not</em> been reached, the promise starts pending. It will be resolved with <code>true</code> at some future time, such that the rate limit of <code>limiter</code> is not exceeded, with respect to other promises in the same <code>channel</code>.</p><p>If the maximum number of pending promises has been reached, the returned promise is already resolved with <code>false</code>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (lwt.Lwt_throttle.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_throttle</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_throttle.Make</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav></div><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-H"><a href="#argument-1-H" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-H/index.html">H</a></span><span> : <a href="../../../ocaml/Stdlib/Hashtbl/module-type-HashedType/index.html">Stdlib.Hashtbl.HashedType</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-key"><a href="#type-key" class="anchor"></a><code><span><span class="keyword">type</span> key</span><span> = <a href="argument-1-H/index.html#type-t">H.t</a></span></code></div></div><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><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><span class="label">rate</span>:int <span class="arrow">-></span></span> <span><span class="label">max</span>:int <span class="arrow">-></span></span> <span><span class="label">n</span>:int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Creates a rate limiter.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">rate</span> <p>Maximum number of promise resolutions per second, per channel.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">max</span> <p>Maximum number of pending promises allowed at once, over all channels.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">n</span> <p>Initial size of the internal channel hash table. This should be approximately the number of different channels that will be used.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-wait"><a href="#val-wait" class="anchor"></a><code><span><span class="keyword">val</span> wait : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-key">key</a> <span class="arrow">-></span></span> <span>bool <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>Lwt_throttle.wait limiter channel</code> returns a new promise associated with the given rate limiter and channel.</p><p>If the maximum number of pending promises for <code>limiter</code> has <em>not</em> been reached, the promise starts pending. It will be resolved with <code>true</code> at some future time, such that the rate limit of <code>limiter</code> is not exceeded, with respect to other promises in the same <code>channel</code>.</p><p>If the maximum number of pending promises has been reached, the returned promise is already resolved with <code>false</code>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_throttle (lwt.Lwt_throttle)</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> » <a href="../index.html">lwt</a> » Lwt_throttle</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_throttle</span></code></h1><p>Rate limiters.</p><p>A rate limiter allows generating sets of promises that will be resolved in the future, at a maximum rate of N promises per second.</p><p>The rate limiters in this module support multiple <em>channels</em>, each given a different key by the user. The rate limit applies to each channel independently.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-H/index.html">H</a> : <a href="../../ocaml/Stdlib/Hashtbl/module-type-HashedType/index.html">Stdlib.Hashtbl.HashedType</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-key">key</a> = <a href="Make/argument-1-H/index.html#type-t">H.t</a></span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_throttle (lwt.Lwt_throttle)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_throttle</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_throttle</span></code></h1><p>Rate limiters.</p><p>A rate limiter allows generating sets of promises that will be resolved in the future, at a maximum rate of N promises per second.</p><p>The rate limiters in this module support multiple <em>channels</em>, each given a different key by the user. The rate limit applies to each channel independently.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-H/index.html">H</a> : <a href="../../ocaml/Stdlib/Hashtbl/module-type-HashedType/index.html">Stdlib.Hashtbl.HashedType</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-key">key</a> = <a href="Make/argument-1-H/index.html#type-t">H.t</a></span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (lwt.Lwt_throttle.S)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_throttle</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Lwt_throttle.S</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-key"><a href="#type-key" class="anchor"></a><code><span><span class="keyword">type</span> key</span></code></div></div><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><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><span class="label">rate</span>:int <span class="arrow">-></span></span> <span><span class="label">max</span>:int <span class="arrow">-></span></span> <span><span class="label">n</span>:int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Creates a rate limiter.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">rate</span> <p>Maximum number of promise resolutions per second, per channel.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">max</span> <p>Maximum number of pending promises allowed at once, over all channels.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">n</span> <p>Initial size of the internal channel hash table. This should be approximately the number of different channels that will be used.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-wait"><a href="#val-wait" class="anchor"></a><code><span><span class="keyword">val</span> wait : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-key">key</a> <span class="arrow">-></span></span> <span>bool <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>Lwt_throttle.wait limiter channel</code> returns a new promise associated with the given rate limiter and channel.</p><p>If the maximum number of pending promises for <code>limiter</code> has <em>not</em> been reached, the promise starts pending. It will be resolved with <code>true</code> at some future time, such that the rate limit of <code>limiter</code> is not exceeded, with respect to other promises in the same <code>channel</code>.</p><p>If the maximum number of pending promises has been reached, the returned promise is already resolved with <code>false</code>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (lwt.Lwt_throttle.S)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_throttle</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Lwt_throttle.S</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-key"><a href="#type-key" class="anchor"></a><code><span><span class="keyword">type</span> key</span></code></div></div><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><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><span class="label">rate</span>:int <span class="arrow">-></span></span> <span><span class="label">max</span>:int <span class="arrow">-></span></span> <span><span class="label">n</span>:int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Creates a rate limiter.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">rate</span> <p>Maximum number of promise resolutions per second, per channel.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">max</span> <p>Maximum number of pending promises allowed at once, over all channels.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">n</span> <p>Initial size of the internal channel hash table. This should be approximately the number of different channels that will be used.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-wait"><a href="#val-wait" class="anchor"></a><code><span><span class="keyword">val</span> wait : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-key">key</a> <span class="arrow">-></span></span> <span>bool <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>Lwt_throttle.wait limiter channel</code> returns a new promise associated with the given rate limiter and channel.</p><p>If the maximum number of pending promises for <code>limiter</code> has <em>not</em> been reached, the promise starts pending. It will be resolved with <code>true</code> at some future time, such that the rate limit of <code>limiter</code> is not exceeded, with respect to other promises in the same <code>channel</code>.</p><p>If the maximum number of pending promises has been reached, the returned promise is already resolved with <code>false</code>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_timeout (lwt.Lwt_timeout)</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> » <a href="../index.html">lwt</a> » Lwt_timeout</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_timeout</span></code></h1><p>Cancelable timeouts.</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><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>int <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>Lwt_timeout.create n f</code> creates a new timeout object with duration <code>n</code> seconds. <code>f</code> is the <em>action</em>, a function to be called once the timeout expires. <code>f</code> should not raise exceptions.</p><p>The timeout is not started until <a href="#val-start"><code>Lwt_timeout.start</code></a> is called on it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-start"><a href="#val-start" class="anchor"></a><code><span><span class="keyword">val</span> start : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Starts the given timeout.</p><p>Starting a timeout that has already been started has the same effect as stopping it, and then restarting it with its original duration. So, suppose you have <code>timeout</code> with a duration of three seconds, which was started two seconds ago. The next call to its action is scheduled for one second in the future. Calling <code>Lwt_timeout.start timeout</code> at this point cancels this upcoming action call, and schedules a call three seconds from now.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stop"><a href="#val-stop" class="anchor"></a><code><span><span class="keyword">val</span> stop : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Stops (cancels) the given timeout.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-change"><a href="#val-change" class="anchor"></a><code><span><span class="keyword">val</span> change : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Changes the duration of the given timeout.</p><p>If the timeout has already been started, it is stopped, and restarted with its new duration. This is similar to how <a href="#val-start"><code>Lwt_timeout.start</code></a> works on a timeout that has already been started.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_exn_handler"><a href="#val-set_exn_handler" class="anchor"></a><code><span><span class="keyword">val</span> set_exn_handler : <span><span>(<span>exn <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>Lwt_timeout.set_exn_handler f</code> sets the handler to be used for exceptions raised by timeout actions. Recall that actions are not allowed to raise exceptions. If they do raise an exception <code>exn</code> despite this, <code>f exn</code> is called.</p><p>The default behavior of <code>f exn</code>, set by <code>Lwt_timeout</code> on program startup, is to pass <code>exn</code> to <code>!</code><a href="../Lwt/index.html#val-async_exception_hook"><code>Lwt.async_exception_hook</code></a>. The default behavior of <em>that</em> is to terminate the process.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lwt_timeout (lwt.Lwt_timeout)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">lwt</a> » Lwt_timeout</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_timeout</span></code></h1><p>Cancelable timeouts.</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><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>int <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>Lwt_timeout.create n f</code> creates a new timeout object with duration <code>n</code> seconds. <code>f</code> is the <em>action</em>, a function to be called once the timeout expires. <code>f</code> should not raise exceptions.</p><p>The timeout is not started until <a href="#val-start"><code>Lwt_timeout.start</code></a> is called on it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-start"><a href="#val-start" class="anchor"></a><code><span><span class="keyword">val</span> start : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Starts the given timeout.</p><p>Starting a timeout that has already been started has the same effect as stopping it, and then restarting it with its original duration. So, suppose you have <code>timeout</code> with a duration of three seconds, which was started two seconds ago. The next call to its action is scheduled for one second in the future. Calling <code>Lwt_timeout.start timeout</code> at this point cancels this upcoming action call, and schedules a call three seconds from now.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stop"><a href="#val-stop" class="anchor"></a><code><span><span class="keyword">val</span> stop : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Stops (cancels) the given timeout.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-change"><a href="#val-change" class="anchor"></a><code><span><span class="keyword">val</span> change : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Changes the duration of the given timeout.</p><p>If the timeout has already been started, it is stopped, and restarted with its new duration. This is similar to how <a href="#val-start"><code>Lwt_timeout.start</code></a> works on a timeout that has already been started.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_exn_handler"><a href="#val-set_exn_handler" class="anchor"></a><code><span><span class="keyword">val</span> set_exn_handler : <span><span>(<span>exn <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>Lwt_timeout.set_exn_handler f</code> sets the handler to be used for exceptions raised by timeout actions. Recall that actions are not allowed to raise exceptions. If they do raise an exception <code>exn</code> despite this, <code>f exn</code> is called.</p><p>The default behavior of <code>f exn</code>, set by <code>Lwt_timeout</code> on program startup, is to pass <code>exn</code> to <code>!</code><a href="../Lwt/index.html#val-async_exception_hook"><code>Lwt.async_exception_hook</code></a>. The default behavior of <em>that</em> is to terminate the process.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO_vectors (lwt.Lwt_unix.IO_vectors)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_unix</a> » IO_vectors</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_unix.IO_vectors</span></code></h1><p>Sequences of buffer slices for <a href="../index.html#val-writev"><code>writev</code></a>.</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>Mutable sequences of I/O vectors. An I/O vector describes a slice of a <code>bytes</code> or <code>Bigarray</code> buffer. Each I/O vector is a triple containing a reference to the buffer, an offset into the buffer where the slice begins, and the length of the slice.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-_bigarray"><a href="#type-_bigarray" class="anchor"></a><code><span><span class="keyword">type</span> _bigarray</span><span> =
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO_vectors (lwt.Lwt_unix.IO_vectors)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_unix</a> » IO_vectors</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_unix.IO_vectors</span></code></h1><p>Sequences of buffer slices for <a href="../index.html#val-writev"><code>writev</code></a>.</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>Mutable sequences of I/O vectors. An I/O vector describes a slice of a <code>bytes</code> or <code>Bigarray</code> buffer. Each I/O vector is a triple containing a reference to the buffer, an offset into the buffer where the slice begins, and the length of the slice.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-_bigarray"><a href="#type-_bigarray" class="anchor"></a><code><span><span class="keyword">type</span> _bigarray</span><span> =
|
||||
<span><span>(char, <a href="../../../ocaml/Stdlib/Bigarray/index.html#type-int8_unsigned_elt">Stdlib.Bigarray.int8_unsigned_elt</a>, <a href="../../../ocaml/Stdlib/Bigarray/index.html#type-c_layout">Stdlib.Bigarray.c_layout</a>)</span>
|
||||
<a href="../../../ocaml/Stdlib/Bigarray/Array1/index.html#type-t">Stdlib.Bigarray.Array1.t</a></span></span></code></div><div class="spec-doc"><p>Type abbreviation equivalent to <a href="../../Lwt_bytes/index.html#type-t"><code>Lwt_bytes.t</code></a>. Do not use this type name directly; use <a href="../../Lwt_bytes/index.html#type-t"><code>Lwt_bytes.t</code></a> instead.</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>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Creates an empty I/O vector sequence.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-append_bytes"><a href="#val-append_bytes" class="anchor"></a><code><span><span class="keyword">val</span> append_bytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>append_bytes vs buffer offset length</code> appends a slice of the <code>bytes</code> buffer <code>buffer</code> beginning at <code>offset</code> and with length <code>length</code> to the I/O vector sequence <code>vs</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-append_bigarray"><a href="#val-append_bigarray" class="anchor"></a><code><span><span class="keyword">val</span> append_bigarray : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-_bigarray">_bigarray</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>append_bigarray vs buffer offset length</code> appends a slice of the <code>Bigarray</code> buffer <code>buffer</code> beginning at <code>offset</code> and with length <code>length</code> to the I/O vector sequence <code>vs</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-drop"><a href="#val-drop" class="anchor"></a><code><span><span class="keyword">val</span> drop : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>drop vs n</code> adjusts the I/O vector sequence <code>vs</code> so that it no longer includes its first <code>n</code> bytes.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_empty vs</code> is <code>true</code> if and only if <code>vs</code> has no I/O vectors, or all I/O vectors in <code>vs</code> have zero bytes.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-byte_count"><a href="#val-byte_count" class="anchor"></a><code><span><span class="keyword">val</span> byte_count : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>byte_count vs</code> is the total number of bytes in <code>vs</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.2.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-system_limit"><a href="#val-system_limit" class="anchor"></a><code><span><span class="keyword">val</span> system_limit : <span>int option</span></span></code></div><div class="spec-doc"><p>Some systems limit the number of I/O vectors that can be passed in a single call to their <code>writev</code> or <code>readv</code> system calls. On those systems, if the limit is <code>n</code>, this value is equal to <code>Some n</code>. On systems without such a limit, the value is equal to <code>None</code>.</p><p>Unless you need atomic I/O operations, you can ignore this limit. The Lwt binding automatically respects it internally. See <a href="../index.html#val-writev"><code>Lwt_unix.writev</code></a>.</p><p>A typical limit is 1024 vectors.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Versioned (lwt.Lwt_unix.Versioned)</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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_unix</a> » Versioned</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_unix.Versioned</span></code></h1><p>Versioned variants of APIs undergoing breaking changes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bind_1"><a href="#val-bind_1" class="anchor"></a><code><span><span class="keyword">val</span> bind_1 : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-sockaddr">sockaddr</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Old version of <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>. The current <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a> evaluates to a promise, because the internal <code>bind(2)</code> system call can block if the given socket is a Unix domain socket.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind_2"><a href="#val-bind_2" class="anchor"></a><code><span><span class="keyword">val</span> bind_2 : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-sockaddr">sockaddr</a> <span class="arrow">-></span></span> <span>unit <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Since Lwt 3.0.0, this is just an alias for <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recv_msg_2"><a href="#val-recv_msg_2" class="anchor"></a><code><span><span class="keyword">val</span> recv_msg_2 :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Versioned (lwt.Lwt_unix.Versioned)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">lwt</a> » <a href="../index.html">Lwt_unix</a> » Versioned</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_unix.Versioned</span></code></h1><p>Versioned variants of APIs undergoing breaking changes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bind_1"><a href="#val-bind_1" class="anchor"></a><code><span><span class="keyword">val</span> bind_1 : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-sockaddr">sockaddr</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Old version of <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>. The current <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a> evaluates to a promise, because the internal <code>bind(2)</code> system call can block if the given socket is a Unix domain socket.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bind_2"><a href="#val-bind_2" class="anchor"></a><code><span><span class="keyword">val</span> bind_2 : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-sockaddr">sockaddr</a> <span class="arrow">-></span></span> <span>unit <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Since Lwt 3.0.0, this is just an alias for <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../index.html#val-bind"><code>Lwt_unix.bind</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.7.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recv_msg_2"><a href="#val-recv_msg_2" class="anchor"></a><code><span><span class="keyword">val</span> recv_msg_2 :
|
||||
<span><span class="label">socket</span>:<a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">io_vectors</span>:<a href="../IO_vectors/index.html#type-t">IO_vectors.t</a> <span class="arrow">-></span></span>
|
||||
<span><span>(int * <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> list</span>)</span> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Since Lwt 5.0.0, this is an alias for <a href="../index.html#val-recv_msg"><code>Lwt_unix.recv_msg</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p>Use <a href="../index.html#val-recv_msg"><code>Lwt_unix.recv_msg</code></a>.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_msg_2"><a href="#val-send_msg_2" class="anchor"></a><code><span><span class="keyword">val</span> send_msg_2 :
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,3 +1,21 @@
|
|||
===== 5.9.1 =====
|
||||
|
||||
====== Packaging ======
|
||||
|
||||
* lwt_ppx is compatible with newer versions of ppxlib. (Patrick Ferris, Kate Deplaix, Sora Morimoto, #1033)
|
||||
|
||||
====== Other ======
|
||||
|
||||
* Misc repository maintenance. (Sora Morimoto)
|
||||
|
||||
* Misc typo. (Kaustubh Maske Patil, #1056)
|
||||
|
||||
===== 5.9.1 =====
|
||||
|
||||
====== Fixes ======
|
||||
|
||||
* META files now carry version information. (Hugo Heuzard, #1042, #1053)
|
||||
|
||||
===== 5.9.0 =====
|
||||
|
||||
====== Additions ======
|
||||
|
|
@ -14,6 +32,12 @@
|
|||
|
||||
* Misc repository maintenance. (Sora Morimoto, Shon Feder, #1037, #1035)
|
||||
|
||||
===== 5.8.1 =====
|
||||
|
||||
====== Fixes ======
|
||||
|
||||
* META files now carry version information. (Hugo Heuzard, #1042, #1053)
|
||||
|
||||
===== 5.8.0 =====
|
||||
|
||||
====== Improvements ======
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (lwt.index)</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> » lwt</nav><header class="odoc-preamble"><h1 id="package-lwt"><a href="#package-lwt" class="anchor"></a>Package lwt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES">changes</a> <a href="#package_info">more…</a></nav></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#introduction">Introduction</a></li><li><a href="#tour">Tour</a></li><li><a href="#installing">Installing</a></li><li><a href="#additional-docs">Additional Docs</a></li><li><a href="#api:-library-lwt">API: Library <code>lwt</code></a></li><li><a href="#api:-library-lwt.unix">API: Library <code>lwt.unix</code></a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="introduction"><a href="#introduction" class="anchor"></a>Introduction</h2><p>Lwt is a concurrent programming library for OCaml. It provides a single data type: the <em>promise</em>, which is a value that will become determined in the future. Creating a promise spawns a computation. When that computation is I/O, Lwt runs it in parallel with your OCaml code.</p><p>OCaml code, including creating and waiting on promises, is run in a single thread by default, so you don't have to worry about locking or preemption. You can detach code to be run in separate threads on an opt-in basis.</p><p>Here is a simplistic Lwt program which requests the Google front page, and fails if the request is not completed in five seconds:</p><pre class="language-ocaml"><code>open Lwt.Syntax
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (lwt.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » lwt</nav><header class="odoc-preamble"><h1 id="package-lwt"><a href="#package-lwt" class="anchor"></a>Package lwt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES">changes</a> <a href="#package_info">more…</a></nav></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#introduction">Introduction</a></li><li><a href="#tour">Tour</a></li><li><a href="#installing">Installing</a></li><li><a href="#additional-docs">Additional Docs</a></li><li><a href="#api:-library-lwt">API: Library <code>lwt</code></a></li><li><a href="#api:-library-lwt.unix">API: Library <code>lwt.unix</code></a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="introduction"><a href="#introduction" class="anchor"></a>Introduction</h2><p>Lwt is a concurrent programming library for OCaml. It provides a single data type: the <em>promise</em>, which is a value that will become determined in the future. Creating a promise spawns a computation. When that computation is I/O, Lwt runs it in parallel with your OCaml code.</p><p>OCaml code, including creating and waiting on promises, is run in a single thread by default, so you don't have to worry about locking or preemption. You can detach code to be run in separate threads on an opt-in basis.</p><p>Here is a simplistic Lwt program which requests the Google front page, and fails if the request is not completed in five seconds:</p><pre class="language-ocaml"><code>open Lwt.Syntax
|
||||
|
||||
let () =
|
||||
let request =
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (moonpool-lwt.Moonpool_lwt.IO)</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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » IO</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.IO</span></code></h1><p>IO using the Lwt event loop.</p><p>These IO operations work on non-blocking file descriptors and rely on a <code>Lwt_engine</code> event loop being active (meaning, <code>Lwt_main.run</code> is currently running in some thread).</p><p>Calling these functions must be done from a moonpool runner. A function like <code>read</code> will first try to perform the IO action directly (here, call <a href="../../../ocaml/Unix/index.html#val-read"><code>Unix.read</code></a>); if the action fails because the FD is not ready, then <code>await_readable</code> is called: it suspends the fiber and subscribes it to Lwt to be awakened when the FD becomes ready.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Read from the file descriptor</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-await_readable"><a href="#val-await_readable" class="anchor"></a><code><span><span class="keyword">val</span> await_readable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Suspend the fiber until the FD is readable</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_once"><a href="#val-write_once" class="anchor"></a><code><span><span class="keyword">val</span> write_once : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Perform one write into the file descriptor</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-await_writable"><a href="#val-await_writable" class="anchor"></a><code><span><span class="keyword">val</span> await_writable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Suspend the fiber until the FD is writable</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Loop around <a href="#val-write_once"><code>write_once</code></a> to write the entire slice.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sleep_s"><a href="#val-sleep_s" class="anchor"></a><code><span><span class="keyword">val</span> sleep_s : <span>float <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Suspend the fiber for <code>n</code> seconds.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (moonpool-lwt.Moonpool_lwt.IO)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » IO</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.IO</span></code></h1><p>IO using the Lwt event loop.</p><p>These IO operations work on non-blocking file descriptors and rely on a <code>Lwt_engine</code> event loop being active (meaning, <code>Lwt_main.run</code> is currently running in some thread).</p><p>Calling these functions must be done from a moonpool runner. A function like <code>read</code> will first try to perform the IO action directly (here, call <a href="../../../ocaml/Unix/index.html#val-read"><code>Unix.read</code></a>); if the action fails because the FD is not ready, then <code>await_readable</code> is called: it suspends the fiber and subscribes it to Lwt to be awakened when the FD becomes ready.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Read from the file descriptor</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-await_readable"><a href="#val-await_readable" class="anchor"></a><code><span><span class="keyword">val</span> await_readable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Suspend the fiber until the FD is readable</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_once"><a href="#val-write_once" class="anchor"></a><code><span><span class="keyword">val</span> write_once : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Perform one write into the file descriptor</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-await_writable"><a href="#val-await_writable" class="anchor"></a><code><span><span class="keyword">val</span> await_writable : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Suspend the fiber until the FD is writable</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Loop around <a href="#val-write_once"><code>write_once</code></a> to write the entire slice.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sleep_s"><a href="#val-sleep_s" class="anchor"></a><code><span><span class="keyword">val</span> sleep_s : <span>float <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Suspend the fiber for <code>n</code> seconds.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (moonpool-lwt.Moonpool_lwt.IO_in.t)</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> » <a href="../../../index.html">moonpool-lwt</a> » <a href="../../index.html">Moonpool_lwt</a> » <a href="../index.html">IO_in</a> » t</nav><header class="odoc-preamble"><h1>Class type <code><span>IO_in.t</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-input"><a href="#method-input" class="anchor"></a><code><span><span class="keyword">method</span> input : <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Read into the slice. Returns <code>0</code> only if the stream is closed.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Close the input. Must be idempotent.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (moonpool-lwt.Moonpool_lwt.IO_in.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">moonpool-lwt</a> » <a href="../../index.html">Moonpool_lwt</a> » <a href="../index.html">IO_in</a> » t</nav><header class="odoc-preamble"><h1>Class type <code><span>IO_in.t</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-input"><a href="#method-input" class="anchor"></a><code><span><span class="keyword">method</span> input : <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Read into the slice. Returns <code>0</code> only if the stream is closed.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Close the input. Must be idempotent.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO_in (moonpool-lwt.Moonpool_lwt.IO_in)</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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » IO_in</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.IO_in</span></code></h1><p>Input channel</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t"><a href="#class-type-t" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t/index.html">t</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></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 :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO_in (moonpool-lwt.Moonpool_lwt.IO_in)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » IO_in</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.IO_in</span></code></h1><p>Input channel</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t"><a href="#class-type-t" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t/index.html">t</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></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><span class="optlabel">?close</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">input</span>:<span>(<span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int)</span> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (moonpool-lwt.Moonpool_lwt.IO_out.t)</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> » <a href="../../../index.html">moonpool-lwt</a> » <a href="../../index.html">Moonpool_lwt</a> » <a href="../index.html">IO_out</a> » t</nav><header class="odoc-preamble"><h1>Class type <code><span>IO_out.t</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-output_char"><a href="#method-output_char" class="anchor"></a><code><span><span class="keyword">method</span> output_char : <span>char <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output"><a href="#method-output" class="anchor"></a><code><span><span class="keyword">method</span> output : <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-flush"><a href="#method-flush" class="anchor"></a><code><span><span class="keyword">method</span> flush : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>t (moonpool-lwt.Moonpool_lwt.IO_out.t)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">moonpool-lwt</a> » <a href="../../index.html">Moonpool_lwt</a> » <a href="../index.html">IO_out</a> » t</nav><header class="odoc-preamble"><h1>Class type <code><span>IO_out.t</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-output_char"><a href="#method-output_char" class="anchor"></a><code><span><span class="keyword">method</span> output_char : <span>char <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-output"><a href="#method-output" class="anchor"></a><code><span><span class="keyword">method</span> output : <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-flush"><a href="#method-flush" class="anchor"></a><code><span><span class="keyword">method</span> flush : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-close"><a href="#method-close" class="anchor"></a><code><span><span class="keyword">method</span> close : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO_out (moonpool-lwt.Moonpool_lwt.IO_out)</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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » IO_out</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.IO_out</span></code></h1><p>Output channel</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t"><a href="#class-type-t" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t/index.html">t</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></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 :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO_out (moonpool-lwt.Moonpool_lwt.IO_out)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » IO_out</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.IO_out</span></code></h1><p>Output channel</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec class-type anchored" id="class-type-t"><a href="#class-type-t" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">type</span> </span><span><a href="class-type-t/index.html">t</a></span><span> = <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></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><span class="optlabel">?flush</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?close</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">output_char</span>:<span>(<span>char <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TCP_client (moonpool-lwt.Moonpool_lwt.TCP_client)</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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » TCP_client</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.TCP_client</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-connect"><a href="#val-connect" class="anchor"></a><code><span><span class="keyword">val</span> connect : <span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_connect"><a href="#val-with_connect" class="anchor"></a><code><span><span class="keyword">val</span> with_connect : <span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <span><span>(<span><a href="../IO_in/class-type-t/index.html">IO_in.t</a> <span class="arrow">-></span></span> <span><a href="../IO_out/class-type-t/index.html">IO_out.t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Open a connection, and use <a href="../IO/index.html"><code>IO</code></a> to read and write from the socket in a non blocking way.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_connect_lwt"><a href="#val-with_connect_lwt" class="anchor"></a><code><span><span class="keyword">val</span> with_connect_lwt :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TCP_client (moonpool-lwt.Moonpool_lwt.TCP_client)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » TCP_client</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.TCP_client</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-connect"><a href="#val-connect" class="anchor"></a><code><span><span class="keyword">val</span> connect : <span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <a href="../../../ocaml/Unix/index.html#type-file_descr">Unix.file_descr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_connect"><a href="#val-with_connect" class="anchor"></a><code><span><span class="keyword">val</span> with_connect : <span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <span><span>(<span><a href="../IO_in/class-type-t/index.html">IO_in.t</a> <span class="arrow">-></span></span> <span><a href="../IO_out/class-type-t/index.html">IO_out.t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Open a connection, and use <a href="../IO/index.html"><code>IO</code></a> to read and write from the socket in a non blocking way.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_connect_lwt"><a href="#val-with_connect_lwt" class="anchor"></a><code><span><span class="keyword">val</span> with_connect_lwt :
|
||||
<span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span><a href="../../../lwt/Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a> <span class="arrow">-></span></span> <span><a href="../../../lwt/Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Open a connection.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TCP_server (moonpool-lwt.Moonpool_lwt.TCP_server)</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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » TCP_server</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.TCP_server</span></code></h1></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><span> = <a href="../../../lwt/Lwt_io/index.html#type-server">Lwt_io.server</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-establish_lwt"><a href="#val-establish_lwt" class="anchor"></a><code><span><span class="keyword">val</span> establish_lwt :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TCP_server (moonpool-lwt.Moonpool_lwt.TCP_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » TCP_server</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.TCP_server</span></code></h1></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><span> = <a href="../../../lwt/Lwt_io/index.html#type-server">Lwt_io.server</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-establish_lwt"><a href="#val-establish_lwt" class="anchor"></a><code><span><span class="keyword">val</span> establish_lwt :
|
||||
<span><span class="optlabel">?backlog</span>:int <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?no_close</span>:bool <span class="arrow">-></span></span>
|
||||
<span><span class="label">runner</span>:<a href="../../../moonpool/Moonpool/Runner/index.html#type-t">Moonpool.Runner.t</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__ (moonpool-lwt.Moonpool_lwt__)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__ (moonpool-lwt.Moonpool_lwt__)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__Base (moonpool-lwt.Moonpool_lwt__Base)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__Base</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__Base</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__Base (moonpool-lwt.Moonpool_lwt__Base)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__Base</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__Base</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__IO (moonpool-lwt.Moonpool_lwt__IO)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__IO</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__IO</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__IO (moonpool-lwt.Moonpool_lwt__IO)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__IO</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__IO</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__IO_in (moonpool-lwt.Moonpool_lwt__IO_in)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__IO_in</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__IO_in</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__IO_in (moonpool-lwt.Moonpool_lwt__IO_in)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__IO_in</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__IO_in</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__IO_out (moonpool-lwt.Moonpool_lwt__IO_out)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__IO_out</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__IO_out</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__IO_out (moonpool-lwt.Moonpool_lwt__IO_out)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__IO_out</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__IO_out</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__Tcp_client (moonpool-lwt.Moonpool_lwt__Tcp_client)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__Tcp_client</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__Tcp_client</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__Tcp_client (moonpool-lwt.Moonpool_lwt__Tcp_client)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__Tcp_client</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__Tcp_client</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__Tcp_server (moonpool-lwt.Moonpool_lwt__Tcp_server)</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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__Tcp_server</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__Tcp_server</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Moonpool_lwt__Tcp_server (moonpool-lwt.Moonpool_lwt__Tcp_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../index.html">moonpool-lwt</a> » Moonpool_lwt__Tcp_server</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt__Tcp_server</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (moonpool-lwt.index)</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> » moonpool-lwt</nav><header class="odoc-preamble"><h1 id="package-moonpool-lwt"><a href="#package-moonpool-lwt" class="anchor"></a>Package moonpool-lwt <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_lwt/index.html"><code>Moonpool_lwt</code></a> <span class="synopsis">Lwt_engine-based event loop for Moonpool.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><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-lwt.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » moonpool-lwt</nav><header class="odoc-preamble"><h1 id="package-moonpool-lwt"><a href="#package-moonpool-lwt" class="anchor"></a>Package moonpool-lwt <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_lwt/index.html"><code>Moonpool_lwt</code></a> <span class="synopsis">Lwt_engine-based event loop for Moonpool.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><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>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>For_runner_implementors (moonpool.Moonpool.Background_thread.For_runner_implementors)</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> » <a href="../../../index.html">moonpool</a> » <a href="../../index.html">Moonpool</a> » <a href="../index.html">Background_thread</a> » For_runner_implementors</nav><header class="odoc-preamble"><h1>Module <code><span>Background_thread.For_runner_implementors</span></code></h1><p>This module is specifically intended for users who implement their own runners. Regular users of Moonpool should not need to look at it.</p></header><div class="odoc-content"><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 :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>For_runner_implementors (moonpool.Moonpool.Background_thread.For_runner_implementors)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../../index.html">moonpool</a> » <a href="../../index.html">Moonpool</a> » <a href="../index.html">Background_thread</a> » For_runner_implementors</nav><header class="odoc-preamble"><h1>Module <code><span>Background_thread.For_runner_implementors</span></code></h1><p>This module is specifically intended for users who implement their own runners. Regular users of Moonpool should not need to look at it.</p></header><div class="odoc-content"><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><span class="label">size</span>:<span>(<span>unit <span class="arrow">-></span></span> int)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">num_tasks</span>:<span>(<span>unit <span class="arrow">-></span></span> int)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">shutdown</span>:<span>(<span><span class="label">wait</span>:bool <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue