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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Capnp_rpc_proto (capnp-rpc.Capnp_rpc_proto)</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_proto</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_proto</span></code></h1><p>The abstract and untyped Cap'n Proto RPC protocol. Users will normally want to use the <a href="../Capnp_rpc/index.html"><code>Capnp_rpc</code></a> API instead, which provides a typed interface using the Cap'n Proto serialisation.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-S"><a href="#module-S" class="anchor"></a><code><span><span class="keyword">module</span> <a href="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>The core types and module signatures.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-RO_array"><a href="#module-RO_array" class="anchor"></a><code><span><span class="keyword">module</span> <a href="RO_array/index.html">RO_array</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A read-only array.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Stats"><a href="#module-Stats" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Stats/index.html">Stats</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Statistics for CapTP connections.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Id"><a href="#module-Id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Id/index.html">Id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unique identifiers.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Debug"><a href="#module-Debug" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Debug/index.html">Debug</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Diagnostics.</p></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> <a href="Error/index.html">Error</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Errors returned by calls.</p></div></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> <a href="Exception/index.html">Exception</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Cap'n Proto exceptions.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Message_types"><a href="#module-Message_types" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Message_types/index.html">Message_types</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>This module defines the information in the messages that goes over the wire. These messages are turned into actual byte streams elsewhere.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Core_types"><a href="#module-Core_types" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Core_types/index.html">Core_types</a></span><span> (<a href="Core_types/argument-1-W/index.html">W</a> : <a href="S/module-type-WIRE/index.html">S.WIRE</a>) : <a href="S/module-type-CORE_TYPES/index.html">S.CORE_TYPES</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="S/module-type-CORE_TYPES/Wire/index.html">Wire</a> = <a href="Core_types/argument-1-W/index.html">W</a></span></span></code></div><div class="spec-doc"><p>This module defines a calling convention for invoking methods on objects. The objects could be remote, but this module doesn't define anything related to networks. These types are generated automatically from <code>WIRE</code> by <code>Core_types</code>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Local_struct_promise"><a href="#module-Local_struct_promise" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Local_struct_promise/index.html">Local_struct_promise</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A local promise for a call response. Queues messages locally.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cap_proxy"><a href="#module-Cap_proxy" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cap_proxy/index.html">Cap_proxy</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A local promise for a capability. Queues messages locally.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-CapTP"><a href="#module-CapTP" class="anchor"></a><code><span><span class="keyword">module</span> <a href="CapTP/index.html">CapTP</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The abstract Cap'n Proto RPC network protocol.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-RC"><a href="#module-RC" class="anchor"></a><code><span><span class="keyword">module</span> <a href="RC/index.html">RC</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A ref-count type that raises an exception on overflow.</p></div></div></div></body></html>