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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Location (capnp-rpc-unix.Capnp_rpc_unix.Network.Location)</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; <a href="../index.html">Network</a> &#x00BB; Location</nav><header class="odoc-preamble"><h1>Module <code><span>Network.Location</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.Unix" class="def variant constructor anchored"><a href="#type-t.Unix" class="anchor"></a><code><span>| </span><span>`Unix <span class="keyword">of</span> string</span></code></li><li id="type-t.TCP" class="def variant constructor anchored"><a href="#type-t.TCP" class="anchor"></a><code><span>| </span><span>`TCP <span class="keyword">of</span> string * int</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-validate_public"><a href="#val-validate_public" class="anchor"></a><code><span><span class="keyword">val</span> validate_public : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Raises an exception if <code>t</code> is not a valid public address (e.g. the Unix path is relative)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-t">t</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unix"><a href="#val-unix" class="anchor"></a><code><span><span class="keyword">val</span> unix : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>unix path</code> is a Unix-domain socket address. <code>path</code> is made absolute if it isn't already.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tcp"><a href="#val-tcp" class="anchor"></a><code><span><span class="keyword">val</span> tcp : <span><span class="label">host</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">port</span>:int <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>tcp ~host port</code> is <code>`TCP (host, port)</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="#type-t">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-cmdliner_conv"><a href="#val-cmdliner_conv" class="anchor"></a><code><span><span class="keyword">val</span> cmdliner_conv : <span><a href="#type-t">t</a> <span class="xref-unresolved">Cmdliner</span>.Arg.conv</span></span></code></div></div></div></body></html>