Update backoff doc for 0.1.0

ocaml-multicore · Aug 5, 2023 · 0c2caa1 · 0c2caa1
1 parent d88a67a
commit 0c2caa1
Show file tree

Hide file tree

Showing 27 changed files with 1,280 additions and 0 deletions.
diff --git a/0.1.0/backoff/Backoff/index.html b/0.1.0/backoff/Backoff/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backoff (backoff.Backoff)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">backoff</a> &#x00BB; 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>?lower_wait_log:int <span class="arrow">&#45;&gt;</span></span> <span>?upper_wait_log:int <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</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>
diff --git a/0.1.0/backoff/index.html b/0.1.0/backoff/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (backoff.index)</title><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – backoff</nav><header class="odoc-preamble"><h1 id="backoff-index"><a href="#backoff-index" class="anchor"></a>backoff index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-backoff">Library backoff</a></li></ul></nav><div class="odoc-content"><h2 id="library-backoff"><a href="#library-backoff" class="anchor"></a>Library backoff</h2><p>The entry point of this library is the module: <a href="Backoff/index.html"><code>Backoff</code></a>.</p></div></body></html>
diff --git a/0.1.0/index.html b/0.1.0/index.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>index</title>
+    <link rel="stylesheet" href="./odoc.support/odoc.css"/>
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
+  </head>
+  <body>
+    <main class="content">
+      <div class="by-name">
+      <h2>OCaml package documentation</h2>
+      <ol>
+      <li><a href="backoff/index.html">backoff</a></li>
+      </ol>
+      </div>
+    </main>
+  </body>
+</html>
diff --git a/0.1.0/odoc.support/fonts/KaTeX_AMS-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_AMS-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Caligraphic-Bold.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Caligraphic-Bold.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Caligraphic-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Caligraphic-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Fraktur-Bold.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Fraktur-Bold.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Fraktur-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Fraktur-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Main-Bold.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Main-Bold.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Main-BoldItalic.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Main-BoldItalic.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Main-Italic.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Main-Italic.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Main-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Main-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Math-BoldItalic.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Math-BoldItalic.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Math-Italic.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Math-Italic.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_SansSerif-Bold.woff2 b/0.1.0/odoc.support/fonts/KaTeX_SansSerif-Bold.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_SansSerif-Italic.woff2 b/0.1.0/odoc.support/fonts/KaTeX_SansSerif-Italic.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_SansSerif-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_SansSerif-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Script-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Script-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Size1-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Size1-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Size2-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Size2-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Size3-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Size3-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Size4-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Size4-Regular.woff2
diff --git a/0.1.0/odoc.support/fonts/KaTeX_Typewriter-Regular.woff2 b/0.1.0/odoc.support/fonts/KaTeX_Typewriter-Regular.woff2
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<!DOCTYPE html>
		<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backoff (backoff.Backoff)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">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>?lower_wait_log:int <span class="arrow">-></span></span> <span>?upper_wait_log: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>