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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Endpoint (capnp-rpc-net.Capnp_rpc_net.Endpoint)</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; <a href="../index.html">Capnp_rpc_net</a> &#x00BB; Endpoint</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_net.Endpoint</span></code></h1><p>Send and receive capnp messages over a byte-stream.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-src"><a href="#val-src" class="anchor"></a><code><span><span class="keyword">val</span> src : <span class="xref-unresolved">Logs</span>.src</span></code></div><div class="spec-doc"><p>Control the log level.</p></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></code></div><div class="spec-doc"><p>A wrapper for a byte-stream (flow).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send"><a href="#val-send" class="anchor"></a><code><span><span class="keyword">val</span> send : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> <span class="xref-unresolved">Capnp</span>.BytesMessage.Message.t</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>send t msg</code> enqueues <code>msg</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run_writer"><a href="#val-run_writer" class="anchor"></a><code><span><span class="keyword">val</span> run_writer : <span><span class="label">tags</span>:<span class="xref-unresolved">Logs</span>.Tag.set <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>run_writer ~tags t</code> runs a loop that transmits batches of messages from <code>t</code>. It returns when the flow is closed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recv"><a href="#val-recv" class="anchor"></a><code><span><span class="keyword">val</span> recv : 
  <span><span class="label">tags</span>:<span class="xref-unresolved">Logs</span>.Tag.set <span class="arrow">&#45;&gt;</span></span>
  <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span>(<span><span class="xref-unresolved">Capnp</span>.Message.ro <span class="xref-unresolved">Capnp</span>.BytesMessage.Message.t</span>, <span>[&gt; `Closed ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>recv ~tags t</code> reads the next message from the remote peer. It returns <code>Error `Closed</code> if the connection to the peer is lost.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_flow"><a href="#val-of_flow" class="anchor"></a><code><span><span class="keyword">val</span> of_flow : <span><span class="label">peer_id</span>:<a href="../Auth/Digest/index.html#type-t">Auth.Digest.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">_</span> <span class="xref-unresolved">Eio</span>.Flow.two_way</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>of_flow ~peer_id flow</code> sends and receives on <code>flow</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-peer_id"><a href="#val-peer_id" class="anchor"></a><code><span><span class="keyword">val</span> peer_id : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Auth/Digest/index.html#type-t">Auth.Digest.t</a></span></code></div><div class="spec-doc"><p><code>peer_id t</code> is the fingerprint of the peer's public key, or <code>Auth.Digest.insecure</code> if TLS isn't being used.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown_send"><a href="#val-shutdown_send" class="anchor"></a><code><span><span class="keyword">val</span> shutdown_send : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>shutdown_send t</code> closes the writer, causing <code>run_writer</code> to return once all buffered data has been written.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-disconnect"><a href="#val-disconnect" class="anchor"></a><code><span><span class="keyword">val</span> disconnect : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>disconnect t</code> shuts down the underlying flow.</p></div></div></div></body></html>