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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CapTP (capnp-rpc-net.Capnp_rpc_net.Networking.CapTP)</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; <a href="../index.html">Networking</a> &#x00BB; CapTP</nav><header class="odoc-preamble"><h1>Module <code><span>Networking.CapTP</span></code></h1><p>Sharing capabilities over a network link.</p></header><div class="odoc-content"><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 CapTP connection to a remote peer.</p></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><span class="label">sw</span>:<span class="xref-unresolved">Eio</span>.Switch.t <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">restore</span>:<a href="../../Restorer/index.html#type-t">Restorer.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?tags</span>:<span class="xref-unresolved">Logs</span>.Tag.set <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../Endpoint/index.html#type-t">Endpoint.t</a> <span class="arrow">&#45;&gt;</span></span>
  <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>connect ~sw ~restore ~switch endpoint</code> is fresh CapTP protocol handler that sends and receives messages using <code>endpoint</code>. <code>restore</code> is used to respond to &quot;Bootstrap&quot; messages. If the connection fails then <code>endpoint</code> will be disconnected. You must call <a href="#val-run"><code>run</code></a> to run the loop handling messages.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">sw</span> <p>Used to run methods and to run the transmit thread.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run : <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 t</code> reads and handles incoming messages until the connection is finished.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bootstrap"><a href="#val-bootstrap" class="anchor"></a><code><span><span class="keyword">val</span> bootstrap : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Restorer/Id/index.html#type-t">Restorer.Id.t</a> <span class="arrow">&#45;&gt;</span></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></code></div><div class="spec-doc"><p><code>bootstrap t object_id</code> is the peer's bootstrap object <code>object_id</code>, if any. Use <code>object_id = &quot;&quot;</code> for the main, public object.</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> <span><a href="../../../../capnp-rpc/Capnp_rpc_proto/Exception/index.html#type-t">Capnp_rpc.Exception.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>disconnect reason</code> closes the connection, sending <code>reason</code> to the peer to explain why. Capabilities and questions at both ends will break, with <code>reason</code> as the problem.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dump"><a href="#val-dump" class="anchor"></a><code><span><span class="keyword">val</span> dump : <span><a href="#type-t">t</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div><div class="spec-doc"><p><code>dump</code> dumps the state of the connection, for debugging.</p></div></div></div></body></html>