-
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
28 changed files
with
105 additions
and
42 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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backend (catapult-client.Catapult_client.Backend)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><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> » <a href="../index.html">Catapult_client</a> » Backend</nav><header class="odoc-preamble"><h1>Module <code><span>Catapult_client.Backend</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><a href="../Connection/index.html#type-t">Connection.t</a> <span class="arrow">-></span></span> <a href="../../../catapult/Catapult/index.html#type-backend">Catapult.backend</a></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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Connection (catapult-client.Catapult_client.Connection)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><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> » <a href="../index.html">Catapult_client</a> » Connection</nav><header class="odoc-preamble"><h1>Module <code><span>Catapult_client.Connection</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_addr"><a href="#val-default_addr" class="anchor"></a><code><span><span class="keyword">val</span> default_addr : <a href="../../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Catapult_utils.Endpoint_address.t</a></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>addr:<a href="../../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Catapult_utils.Endpoint_address.t</a> <span class="arrow">-></span></span> | ||
| <span>?trace_id:string <span class="arrow">-></span></span> | ||
| <span>unit <span class="arrow">-></span></span> | ||
| <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_msg"><a href="#val-send_msg" class="anchor"></a><code><span><span class="keyword">val</span> send_msg : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>pid:int <span class="arrow">-></span></span> <span>now:float <span class="arrow">-></span></span> <span><a href="../../../catapult/Catapult_utils/Ser/Event/index.html#type-t">Catapult_utils.Ser.Event.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ : | ||
| <span>addr:<a href="../../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Catapult_utils.Endpoint_address.t</a> <span class="arrow">-></span></span> | ||
| <span>?trace_id:string <span class="arrow">-></span></span> | ||
| <span>unit <span class="arrow">-></span></span> | ||
| <span><span>(<span><a href="#type-t">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></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,12 @@ | ||
| <!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.1"/><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> | ||
| <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.1"/><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></header><div class="odoc-content"><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 module anchored" id="module-Backend"><a href="#module-Backend" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Backend/index.html">Backend</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-Connection"><a href="#module-Connection" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Connection/index.html">Connection</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></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-with_conn"><a href="#val-with_conn" class="anchor"></a><code><span><span class="keyword">val</span> with_conn : | ||
| <span>addr:<a href="../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Catapult_utils.Endpoint_address.t</a> <span class="arrow">-></span></span> | ||
| <span>?trace_id:string <span class="arrow">-></span></span> | ||
| <span>unit <span class="arrow">-></span></span> | ||
| <span><span>(<span><a href="Connection/index.html#type-t">Connection.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><div class="odoc-spec"><div class="spec value anchored" id="val-backend_of_conn"><a href="#val-backend_of_conn" class="anchor"></a><code><span><span class="keyword">val</span> backend_of_conn : <span><a href="Connection/index.html#type-t">Connection.t</a> <span class="arrow">-></span></span> <a href="../../catapult/Catapult/index.html#type-backend">Catapult.backend</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-addr_of_string_exn"><a href="#val-addr_of_string_exn" class="anchor"></a><code><span><span class="keyword">val</span> addr_of_string_exn : <span>string <span class="arrow">-></span></span> <a href="../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Endpoint_address.t</a></span></code></div><div class="spec-doc"><p>Parse a remote address.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-trace_collector_of_conn"><a href="#val-trace_collector_of_conn" class="anchor"></a><code><span><span class="keyword">val</span> trace_collector_of_conn : <span><a href="Connection/index.html#type-t">Connection.t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Trace_core</span>.collector</span></code></div><div class="spec-doc"><p>Obtain a trace collector from a network connection</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ : | ||
| <span>addr:<a href="../../catapult/Catapult_utils/Endpoint_address/index.html#type-t">Catapult_utils.Endpoint_address.t</a> <span class="arrow">-></span></span> | ||
| <span>?trace_id:string <span class="arrow">-></span></span> | ||
| <span>unit <span class="arrow">-></span></span> | ||
| <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 class="spec-doc"><p><code>with_ ~addr () f</code> runs <code>f()</code> in an environment where a connection to <code>addr</code> has been established and is used to forward tracing events to the remote daemon.</p></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
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>Backend (catapult-sqlite.Catapult_sqlite.Backend)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><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-sqlite</a> » <a href="../index.html">Catapult_sqlite</a> » Backend</nav><header class="odoc-preamble"><h1>Module <code><span>Catapult_sqlite.Backend</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-ARG"><a href="#module-type-ARG" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-ARG/index.html">ARG</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-Arg/index.html">Arg</a> : <a href="module-type-ARG/index.html">ARG</a>) : <a href="../../../catapult/Catapult/module-type-BACKEND/index.html">Catapult.BACKEND</a></span></code></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Backend (catapult-sqlite.Catapult_sqlite.Backend)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><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-sqlite</a> » <a href="../index.html">Catapult_sqlite</a> » Backend</nav><header class="odoc-preamble"><h1>Module <code><span>Catapult_sqlite.Backend</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-ARG"><a href="#module-type-ARG" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-ARG/index.html">ARG</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-Arg/index.html">Arg</a> : <a href="module-type-ARG/index.html">ARG</a>) : <a href="../../../catapult/Catapult/module-type-BACKEND/index.html">Catapult.BACKEND</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><a href="../Writer/index.html#type-t">Writer.t</a> <span class="arrow">-></span></span> <a href="../../../catapult/Catapult/index.html#type-backend">Catapult.backend</a></span></code></div></div></div></body></html> |
Oops, something went wrong.