ocaml-rpc/capnp-rpc-net/Capnp_rpc_net/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Capnp_rpc_net (capnp-rpc-net.Capnp_rpc_net)</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-net</a> &#x00BB; Capnp_rpc_net</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_net</span></code></h1><p>This package adds networking support, including TLS. Libraries should not need to link against this package (just use capnp-rpc instead), since they generally shouldn't care whether services are local or remote.</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>Module signatures.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Endpoint"><a href="#module-Endpoint" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Endpoint/index.html">Endpoint</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Send and receive capnp messages over a byte-stream.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Two_party_network"><a href="#module-Two_party_network" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Two_party_network/index.html">Two_party_network</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A network where the is only one other addressable party.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Auth"><a href="#module-Auth" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Auth/index.html">Auth</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Vat-level authentication and encryption.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Tls_wrapper"><a href="#module-Tls_wrapper" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Tls_wrapper/index.html">Tls_wrapper</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-Restorer"><a href="#module-Restorer" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Restorer/index.html">Restorer</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-VAT_NETWORK"><a href="#module-type-VAT_NETWORK" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-VAT_NETWORK/index.html">VAT_NETWORK</a></span><span> =
  <a href="S/module-type-VAT_NETWORK/index.html">S.VAT_NETWORK</a>
    <span class="keyword">with</span> <span><span class="keyword">type</span> <span>'a <a href="S/module-type-VAT_NETWORK/index.html#type-capability">capability</a></span> := <span><span class="type-var">'a</span> <a href="../../capnp-rpc/Capnp_rpc/Capability/index.html#type-t">Capnp_rpc.Std.Capability.t</a></span></span>
     <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="S/module-type-VAT_NETWORK/index.html#type-restorer">restorer</a> := <a href="Restorer/index.html#type-t">Restorer.t</a></span>
     <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="S/module-type-VAT_NETWORK/index.html#type-service_id">service_id</a> := <a href="Restorer/Id/index.html#type-t">Restorer.Id.t</a></span>
     <span class="keyword">and</span> <span><span class="keyword">type</span> <span>'a <a href="S/module-type-VAT_NETWORK/index.html#type-sturdy_ref">sturdy_ref</a></span> := <span><span class="type-var">'a</span> <a href="../../capnp-rpc/Capnp_rpc/Sturdy_ref/index.html#type-t">Capnp_rpc.Std.Sturdy_ref.t</a></span></span></span></code></div><div class="spec-doc"><p>Stretching capability references across a network link. Note: see <code>Capnp_rpc_unix</code> for a higher-level wrapper for this API.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Networking"><a href="#module-Networking" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Networking/index.html">Networking</a></span><span> (<a href="Networking/argument-1-N/index.html">N</a> : <a href="S/module-type-NETWORK/index.html">S.NETWORK</a>) : <a href="module-type-VAT_NETWORK/index.html">VAT_NETWORK</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-VAT_NETWORK/Network/index.html">Network</a> = <a href="Networking/argument-1-N/index.html">N</a></span></span></code></div><div class="spec-doc"><p>Stretching capability references across a network link. Note: see <code>Capnp_rpc_unix</code> for a higher-level wrapper for this API.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Capnp_address"><a href="#module-Capnp_address" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Capnp_address/index.html">Capnp_address</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Handling of capnp:// URI format addresses. This code is shared between the unix and mirage networks.</p></div></div></div></body></html>