ocaml-rpc/capnp-rpc-unix/Capnp_rpc_unix/Network/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Network (capnp-rpc-unix.Capnp_rpc_unix.Network)</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-unix</a> &#x00BB; <a href="../index.html">Capnp_rpc_unix</a> &#x00BB; Network</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_unix.Network</span></code></h1><p>A network using TCP and Unix-domain sockets.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Location"><a href="#module-Location" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Location/index.html">Location</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../capnp-rpc-net/Capnp_rpc_net/S/module-type-NETWORK/index.html">Capnp_rpc_net.S.NETWORK</a>
  <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../capnp-rpc-net/Capnp_rpc_net/S/module-type-NETWORK/index.html#type-t">t</a> = <span><span><span>[ `Generic ]</span> <span class="xref-unresolved">Eio</span>.Net.ty</span> <span class="xref-unresolved">Eio</span>.Resource.t</span></span>
   <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="../../../capnp-rpc-net/Capnp_rpc_net/S/module-type-NETWORK/Address/index.html#type-t">Address.t</a> = <a href="Location/index.html#type-t">Location.t</a> * <a href="../../../capnp-rpc-net/Capnp_rpc_net/Auth/Digest/index.html#type-t">Capnp_rpc_net.Auth.Digest.t</a></span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Types"><a href="#module-Types" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Types/index.html">Types</a></span><span> : <a href="../../../capnp-rpc/Capnp_rpc_proto/S/module-type-NETWORK_TYPES/index.html">Capnp_rpc_proto.S.NETWORK_TYPES</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Address"><a href="#module-Address" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Address/index.html">Address</a></span><span> : 
  <a href="../../../capnp-rpc-net/Capnp_rpc_net/S/module-type-ADDRESS/index.html">Capnp_rpc_net.S.ADDRESS</a>
    <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../capnp-rpc-net/Capnp_rpc_net/S/module-type-ADDRESS/index.html#type-t">t</a> = <a href="Location/index.html#type-t">Location.t</a> * <a href="../../../capnp-rpc-net/Capnp_rpc_net/Auth/Digest/index.html#type-t">Capnp_rpc_net.Auth.Digest.t</a></span></span></code></div></div><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><span> = <span><span><span>[ `Generic ]</span> <span class="xref-unresolved">Eio</span>.Net.ty</span> <span class="xref-unresolved">Eio</span>.Resource.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-connect"><a href="#val-connect" class="anchor"></a><code><span><span class="keyword">val</span> connect : 
  <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">sw</span>:<span class="xref-unresolved">Eio</span>.Switch.t <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">secret_key</span>:<span><a href="../../../capnp-rpc-net/Capnp_rpc_net/Auth/Secret_key/index.html#type-t">Capnp_rpc_net.Auth.Secret_key.t</a> <span class="xref-unresolved">Stdlib</span>.Lazy.t</span> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="Address/index.html#type-t">Address.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span>(<a href="../../../capnp-rpc-net/Capnp_rpc_net/Endpoint/index.html#type-t">Capnp_rpc_net.Endpoint.t</a>, <span>[&gt; <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>connect t ~sw ~secret_key address</code> connects to <code>address</code>, proves ownership of <code>secret_key</code> (if TLS is being used), and returns the resulting endpoint. Returns an error if no connection can be established or the target fails to authenticate itself.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_third_party_cap_id"><a href="#val-parse_third_party_cap_id" class="anchor"></a><code><span><span class="keyword">val</span> parse_third_party_cap_id : 
  <span><span class="xref-unresolved">Capnp_rpc</span>.Private.Schema.Reader.pointer_t <span class="arrow">&#45;&gt;</span></span>
  <a href="Types/index.html#type-third_party_cap_id">Types.third_party_cap_id</a></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-v"><a href="#val-v" class="anchor"></a><code><span><span class="keyword">val</span> v : <span><span><span class="type-var">_</span> <span class="xref-unresolved">Eio</span>.Net.t</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-accept_connection"><a href="#val-accept_connection" class="anchor"></a><code><span><span class="keyword">val</span> accept_connection : 
  <span><span class="label">secret_key</span>:<span><a href="../../../capnp-rpc-net/Capnp_rpc_net/Auth/Secret_key/index.html#type-t">Capnp_rpc_net.Auth.Secret_key.t</a> option</span> <span class="arrow">&#45;&gt;</span></span>
  <span><span><span>[&gt; <span class="xref-unresolved">Eio</span>.Flow.two_way_ty <span>| <span class="xref-unresolved">Eio</span>.Resource.close_ty</span> ]</span> <span class="xref-unresolved">Eio</span>.Std.r</span> <span class="arrow">&#45;&gt;</span></span>
  <span><span>(<a href="../../../capnp-rpc-net/Capnp_rpc_net/Endpoint/index.html#type-t">Capnp_rpc_net.Endpoint.t</a>, <span>[&gt; <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>accept_connection ~secret_key flow</code> is a new endpoint for <code>flow</code>. If <code>secret_key</code> is not <code>None</code>, it is used to perform a TLS server-side handshake. Otherwise, the connection is not encrypted.</p></div></div></div></body></html>