-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
84 changed files
with
60 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Catapult_client (catapult-client.Catapult_client)</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">catapult-client</a> » Catapult_client</nav><header class="odoc-preamble"><h1>Module <code><span>Catapult_client</span></code></h1><p>Backend for Catapult, using a connection to the daemon.</p><ul><li>The tracing is enabled/disabled via "TRACE=1".</li><li>The trace identifier is specified in "TRACE_ID" (as a unique string ID).</li><li>The daemon's address is either "TRACE_ENDPOINT=ipc://<path>" or "TRACE_ENDPOINT=tcp://host:port".</li></ul></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../catapult/Catapult/module-type-IMPL/index.html">Catapult.IMPL</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Install the catapult logger as a profiling backend.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-teardown"><a href="#val-teardown" class="anchor"></a><code><span><span class="keyword">val</span> teardown : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_setup"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup : <span><span>(<span>unit <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></details></div><div class="odoc-spec"><div class="spec module anchored" id="module-Endpoint_address"><a href="#module-Endpoint_address" class="anchor"></a><code><span><span class="keyword">module</span> Endpoint_address</span><span> = <a href="../../catapult/Catapult/Endpoint_address/index.html">Catapult.Endpoint_address</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enable"><a href="#val-enable" class="anchor"></a><code><span><span class="keyword">val</span> enable : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enabled"><a href="#val-enabled" class="anchor"></a><code><span><span class="keyword">val</span> enabled : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_trace_id"><a href="#val-set_trace_id" class="anchor"></a><code><span><span class="keyword">val</span> set_trace_id : <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Must be called before the setup.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_trace_id"><a href="#val-get_trace_id" class="anchor"></a><code><span><span class="keyword">val</span> get_trace_id : <span>unit <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_endpoint"><a href="#val-default_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> default_endpoint : <a href="../../catapult/Catapult/Endpoint_address/index.html#type-t">Endpoint_address.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_endpoint"><a href="#val-get_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> get_endpoint : <span>unit <span class="arrow">-></span></span> <a href="../../catapult/Catapult/Endpoint_address/index.html#type-t">Endpoint_address.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_endpoint"><a href="#val-set_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> set_endpoint : <span><a href="../../catapult/Catapult/Endpoint_address/index.html#type-t">Endpoint_address.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Must be called before the setup.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_tcp_endpoint"><a href="#val-set_tcp_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> set_tcp_endpoint : <span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_ipc_endpoint"><a href="#val-set_ipc_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> set_ipc_endpoint : <span>string <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Catapult_client (catapult-client.Catapult_client)</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">catapult-client</a> » Catapult_client</nav><header class="odoc-preamble"><h1>Module <code><span>Catapult_client</span></code></h1><p>Backend for Catapult, using a connection to the daemon.</p><ul><li>The tracing is enabled/disabled via "TRACE=1".</li><li>The trace identifier is specified in "TRACE_ID" (as a unique string ID).</li><li>The daemon's address is either "TRACE_ENDPOINT=ipc://<path>" or "TRACE_ENDPOINT=tcp://host:port".</li></ul></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../catapult/Catapult/module-type-IMPL/index.html">Catapult.IMPL</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Install the catapult logger as a profiling backend.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-teardown"><a href="#val-teardown" class="anchor"></a><code><span><span class="keyword">val</span> teardown : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_setup"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup : <span><span>(<span>unit <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></details></div><div class="odoc-spec"><div class="spec module anchored" id="module-Endpoint_address"><a href="#module-Endpoint_address" class="anchor"></a><code><span><span class="keyword">module</span> Endpoint_address</span><span> = <a href="../../catapult/Catapult_utils/Endpoint_address/index.html">Catapult_utils.Endpoint_address</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enable"><a href="#val-enable" class="anchor"></a><code><span><span class="keyword">val</span> enable : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enabled"><a href="#val-enabled" class="anchor"></a><code><span><span class="keyword">val</span> enabled : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_trace_id"><a href="#val-set_trace_id" class="anchor"></a><code><span><span class="keyword">val</span> set_trace_id : <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Must be called before the setup.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_trace_id"><a href="#val-get_trace_id" class="anchor"></a><code><span><span class="keyword">val</span> get_trace_id : <span>unit <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_endpoint"><a href="#val-default_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> default_endpoint : <a href="../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Endpoint_address.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_endpoint"><a href="#val-get_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> get_endpoint : <span>unit <span class="arrow">-></span></span> <a href="../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Endpoint_address.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_endpoint"><a href="#val-set_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> set_endpoint : <span><a href="../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Endpoint_address.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Must be called before the setup.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_tcp_endpoint"><a href="#val-set_tcp_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> set_tcp_endpoint : <span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_ipc_endpoint"><a href="#val-set_ipc_endpoint" class="anchor"></a><code><span><span class="keyword">val</span> set_ipc_endpoint : <span>string <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (catapult-client.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> – catapult-client</nav><header class="odoc-preamble"><h1 id="catapult-client-index"><a href="#catapult-client-index" class="anchor"></a>catapult-client index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-catapult-client">Library catapult-client</a></li></ul></nav><div class="odoc-content"><h2 id="library-catapult-client"><a href="#library-catapult-client" class="anchor"></a>Library catapult-client</h2><p>The entry point of this library is the module: <a href="Catapult_client/index.html"><code>Catapult_client</code></a>.</p></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (catapult-client.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> – catapult-client</nav><header class="odoc-preamble"><h1 id="catapult-client-index"><a href="#catapult-client-index" class="anchor"></a>catapult-client index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-catapult-client">Library catapult-client</a></li></ul></nav><div class="odoc-content"><h2 id="library-catapult-client"><a href="#library-catapult-client" class="anchor"></a>Library catapult-client</h2><p>The entry point of this library is the module: <a href="Catapult_client/index.html"><code>Catapult_client</code></a>.</p></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (catapult-daemon.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> – catapult-daemon</nav><header class="odoc-preamble"><h1 id="catapult-daemon-index"><a href="#catapult-daemon-index" class="anchor"></a>catapult-daemon index</h1></header><div class="odoc-content"></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (catapult-daemon.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> – catapult-daemon</nav><header class="odoc-preamble"><h1 id="catapult-daemon-index"><a href="#catapult-daemon-index" class="anchor"></a>catapult-daemon index</h1></header><div class="odoc-content"></div></body></html> |
Oops, something went wrong.