ocaml-rpc/capnp-rpc/Capnp_rpc/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Capnp_rpc (capnp-rpc.Capnp_rpc)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">capnp-rpc</a> &#x00BB; Capnp_rpc</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc</span></code></h1><p>Cap'n Proto core API for defining and using services.</p></header><div class="odoc-content"><div class="odoc-include"><details><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="xref-unresolved">Capnp</span>.BytesMessage</span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Segment"><a href="#module-Segment" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Segment/index.html">Segment</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-Message"><a href="#module-Message" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Message/index.html">Message</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-Slice"><a href="#module-Slice" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Slice/index.html">Slice</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-StructStorage"><a href="#module-StructStorage" class="anchor"></a><code><span><span class="keyword">module</span> <a href="StructStorage/index.html">StructStorage</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-ListStorage"><a href="#module-ListStorage" class="anchor"></a><code><span><span class="keyword">module</span> <a href="ListStorage/index.html">ListStorage</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-Object"><a href="#module-Object" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Object/index.html">Object</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></details></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exception"><a href="#module-Exception" class="anchor"></a><code><span><span class="keyword">module</span> Exception</span><span> = <a href="../Capnp_rpc_proto/Exception/index.html">Capnp_rpc_proto.Exception</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Error"><a href="#module-Error" class="anchor"></a><code><span><span class="keyword">module</span> Error</span><span> = <a href="../Capnp_rpc_proto/Error/index.html">Capnp_rpc_proto.Error</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-StructRef"><a href="#module-StructRef" class="anchor"></a><code><span><span class="keyword">module</span> <a href="StructRef/index.html">StructRef</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A promise for a response structure. You can use the generated <code>_get_pipelined</code> functions on a promise to get a promise for a capability inside the promise, and then pipeline messages to that promise without waiting for the response struct to arrive.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Capability"><a href="#module-Capability" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Capability/index.html">Capability</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A capability is a reference to an object, or to a promise for an object. You can invoke methods on a capability even while it is still only a promise.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Sturdy_ref"><a href="#module-Sturdy_ref" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Sturdy_ref/index.html">Sturdy_ref</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-Service"><a href="#module-Service" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Service/index.html">Service</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Functions for service implementors.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Std"><a href="#module-Std" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Std/index.html">Std</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Some aliases for common modules.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Leak_handler"><a href="#module-Leak_handler" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Leak_handler/index.html">Leak_handler</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Handle references that got GC'd with a non-zero ref-count.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Persistence"><a href="#module-Persistence" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Persistence/index.html">Persistence</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>