Skip to content

Commit

Permalink
Update tcpip doc to 8.0.2.
Browse files Browse the repository at this point in the history
  • Loading branch information
@hannesm
hannesm committed May 8, 2024
1 parent 09d4ee4 commit fde3a67
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="tcpip/index.html">tcpip</a> <span class="version">8.0.1</span></li>
<li><a href="tcpip/index.html">tcpip</a> <span class="version">8.0.2</span></li>
</ol>
</div>
</main>
Expand Down
2 changes: 1 addition & 1 deletion tcpip/Tcp/Flow/Make/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (tcpip.Tcp.Flow.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">tcpip</a> &#x00BB; <a href="../../index.html">Tcp</a> &#x00BB; <a href="../index.html">Flow</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Flow.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IP"><a href="#argument-1-IP" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IP/index.html">IP</a></span><span> : <a href="../../../Tcpip/Ip/module-type-S/index.html">Tcpip.Ip.S</a></span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-TM"><a href="#argument-2-TM" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>TM</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-3-C"><a href="#argument-3-C" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>C</span><span> : <span class="xref-unresolved">Mirage_clock</span>.MCLOCK</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-4-R"><a href="#argument-4-R" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>R</span><span> : <span class="xref-unresolved">Mirage_random</span>.S</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../Tcpip/Tcp/module-type-S/index.html">Tcpip.Tcp.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../Tcpip/Tcp/module-type-S/index.html#type-ipaddr">ipaddr</a> = <a href="argument-1-IP/index.html#type-ipaddr">IP.ipaddr</a></span></span></code></summary><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> error</span><span> = <span class="keyword">private</span> </span><span>[&gt; </span></code><ol><li id="type-error.Tcpip.Tcp.error" class="def variant type anchored"><a href="#type-error.Tcpip.Tcp.error" class="anchor"></a><code><span>| </span><span><a href="../../../Tcpip/Tcp/index.html#type-error">Tcpip.Tcp.error</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type for TCP errors.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-write_error"><a href="#type-write_error" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> write_error</span><span> = <span class="keyword">private</span> </span><span>[&gt; </span></code><ol><li id="type-write_error.Tcpip.Tcp.write_error" class="def variant type anchored"><a href="#type-write_error.Tcpip.Tcp.write_error" class="anchor"></a><code><span>| </span><span><a href="../../../Tcpip/Tcp/index.html#type-write_error">Tcpip.Tcp.write_error</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type for TCP write errors.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-ipaddr"><a href="#type-ipaddr" class="anchor"></a><code><span><span class="keyword">type</span> ipaddr</span><span> = <a href="argument-1-IP/index.html#type-ipaddr">IP.ipaddr</a></span></code></div><div class="spec-doc"><p>The type for IP address representations.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-flow"><a href="#type-flow" class="anchor"></a><code><span><span class="keyword">type</span> flow</span></code></div><div class="spec-doc"><p>A flow represents the state of a single TCP stream that is connected to an endpoint.</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>The type representing the internal state of the TCP layer.</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>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Disconnect from the TCP layer. While this might take some time to complete, it can never result in an error.</p></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="xref-unresolved">Mirage_flow</span>.S
<span class="keyword">with</span> <span><span class="keyword">type</span> <span class="xref-unresolved">flow</span> := <span class="xref-unresolved">flow</span></span>
<span class="keyword">and</span> <span><span class="keyword">type</span> <span class="xref-unresolved">error</span> := <span class="xref-unresolved">error</span></span>
<span class="keyword">and</span> <span><span class="keyword">type</span> <span class="xref-unresolved">write_error</span> := <span class="xref-unresolved">write_error</span></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-pp_error"><a href="#val-pp_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_error : <span><a href="#type-error">error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_write_error"><a href="#val-pp_write_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_write_error : <span><a href="#type-write_error">write_error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<span><span class="xref-unresolved">Cstruct</span>.t <span class="xref-unresolved">Mirage_flow</span>.or_eof</span>, <a href="#type-error">error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-writev"><a href="#val-writev" class="anchor"></a><code><span><span class="keyword">val</span> writev : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Cstruct</span>.t list</span> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-dst"><a href="#val-dst" class="anchor"></a><code><span><span class="keyword">val</span> dst : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-ipaddr">ipaddr</a> * int</span></code></div><div class="spec-doc"><p>Get the destination IP address and destination port that a flow is currently connected to.</p></div></div><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><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-ipaddr">ipaddr</a> * int</span></code></div><div class="spec-doc"><p>Get the source IP address and source port that a flow is currently connected to.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_nodelay"><a href="#val-write_nodelay" class="anchor"></a><code><span><span class="keyword">val</span> write_nodelay :
<span class="keyword">and</span> <span><span class="keyword">type</span> <span class="xref-unresolved">write_error</span> := <span class="xref-unresolved">write_error</span></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-pp_error"><a href="#val-pp_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_error : <span><a href="#type-error">error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_write_error"><a href="#val-pp_write_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_write_error : <span><a href="#type-write_error">write_error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<span><span class="xref-unresolved">Cstruct</span>.t <span class="xref-unresolved">Mirage_flow</span>.or_eof</span>, <a href="#type-error">error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-writev"><a href="#val-writev" class="anchor"></a><code><span><span class="keyword">val</span> writev : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Cstruct</span>.t list</span> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown"><a href="#val-shutdown" class="anchor"></a><code><span><span class="keyword">val</span> shutdown : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span>[ `read <span>| `read_write</span> <span>| `write</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-dst"><a href="#val-dst" class="anchor"></a><code><span><span class="keyword">val</span> dst : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-ipaddr">ipaddr</a> * int</span></code></div><div class="spec-doc"><p>Get the destination IP address and destination port that a flow is currently connected to.</p></div></div><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><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-ipaddr">ipaddr</a> * int</span></code></div><div class="spec-doc"><p>Get the source IP address and source port that a flow is currently connected to.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_nodelay"><a href="#val-write_nodelay" class="anchor"></a><code><span><span class="keyword">val</span> write_nodelay :
<span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>write_nodelay flow buffer</code> writes the contents of <code>buffer</code> to the flow. The thread blocks until all data has been successfully transmitted to the remote endpoint. Buffering within the layer is minimized in this mode. Note that this API will change in a future revision to be a per-flow attribute instead of a separately exposed function.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-writev_nodelay"><a href="#val-writev_nodelay" class="anchor"></a><code><span><span class="keyword">val</span> writev_nodelay :
Expand Down
Loading

0 comments on commit fde3a67

Please sign in to comment.