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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (capnp-rpc.Capnp_rpc_proto.S)</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; <a href="../index.html">Capnp_rpc_proto</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_proto.S</span></code></h1><p>The core types and module signatures.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-brand"><a href="#type-brand" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a brand</span></span><span> = </span><span>..</span></code></div><div class="spec-doc"><p>A way for objects to provide an optional private API to certain other modules. For example, CapTP proxies appear as plain services, but use this to reveal their target details to the CapTP layer so that it can shorten the path when sending such capabilties over the network.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-attachments"><a href="#type-attachments" class="anchor"></a><code><span><span class="keyword">type</span> attachments</span><span> = </span><span>..</span></code></div><div class="spec-doc"><p>The capabilities attached to a message. This is only defined as an open type to avoid a nasty recursive type definition.</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-No_attachments"><a href="#extension-decl-No_attachments" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-attachments">attachments</a> += </span></code><ol><li id="extension-No_attachments" class="def variant extension anchored"><a href="#extension-No_attachments" class="anchor"></a><code><span>| </span><span><span class="extension">No_attachments</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-WIRE_PAYLOAD"><a href="#module-type-WIRE_PAYLOAD" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-WIRE_PAYLOAD/index.html">WIRE_PAYLOAD</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-type anchored" id="module-type-WIRE"><a href="#module-type-WIRE" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-WIRE/index.html">WIRE</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The core RPC logic can be used with different serialisation systems. The appropriate types should be provided here.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-PAYLOAD"><a href="#module-type-PAYLOAD" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-PAYLOAD/index.html">PAYLOAD</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Wraps <a href="module-type-WIRE_PAYLOAD/index.html"><code>WIRE_PAYLOAD</code></a> to deal with caps rather than attachments.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-CORE_TYPES"><a href="#module-type-CORE_TYPES" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-CORE_TYPES/index.html">CORE_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 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-type anchored" id="module-type-NETWORK_TYPES"><a href="#module-type-NETWORK_TYPES" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-NETWORK_TYPES/index.html">NETWORK_TYPES</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>