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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tls_wrapper (capnp-rpc-net.Capnp_rpc_net.Tls_wrapper)</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; Tls_wrapper</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_net.Tls_wrapper</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-connect_as_server"><a href="#val-connect_as_server" class="anchor"></a><code><span><span class="keyword">val</span> connect_as_server : 
  <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="../Auth/Secret_key/index.html#type-t">Auth.Secret_key.t</a> option</span> <span class="arrow">&#45;&gt;</span></span>
  <span><span>(<a href="../Endpoint/index.html#type-t">Endpoint.t</a>, <span>[&gt; <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-connect_as_client"><a href="#val-connect_as_client" class="anchor"></a><code><span><span class="keyword">val</span> connect_as_client : 
  <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="../Auth/Secret_key/index.html#type-t">Auth.Secret_key.t</a> <span class="xref-unresolved">Stdlib</span>.Lazy.t</span> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../Auth/Digest/index.html#type-t">Auth.Digest.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span>(<a href="../Endpoint/index.html#type-t">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_as_client underlying key digest</code> is an endpoint using flow <code>underlying</code>. If <code>digest</code> requires TLS, it performs a TLS handshake. It uses <code>key</code> as its private key and checks that the server is the one required by <code>auth</code>.</p></div></div></div></body></html>