mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-10 05:03:58 -05:00
14 lines
4.1 KiB
HTML
14 lines
4.1 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TCP_server (moonpool-lwt.Moonpool_lwt.TCP_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../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">Index</a> » <a href="../../index.html">moonpool-lwt</a> » <a href="../index.html">Moonpool_lwt</a> » TCP_server</nav><header class="odoc-preamble"><h1>Module <code><span>Moonpool_lwt.TCP_server</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> = <a href="../../../lwt/Lwt_io/index.html#type-server">Lwt_io.server</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-establish_lwt"><a href="#val-establish_lwt" class="anchor"></a><code><span><span class="keyword">val</span> establish_lwt :
|
||
<span><span class="optlabel">?backlog</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?no_close</span>:bool <span class="arrow">-></span></span>
|
||
<span><span class="label">runner</span>:<a href="../../../moonpool/Moonpool/Runner/index.html#type-t">Moonpool.Runner.t</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span>
|
||
<span><span>(<span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <span><a href="../../../lwt/Lwt_io/index.html#type-input_channel">Lwt_io.input_channel</a> <span class="arrow">-></span></span> <span><a href="../../../lwt/Lwt_io/index.html#type-output_channel">Lwt_io.output_channel</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>establish ~runner addr handler</code> runs a TCP server in the Lwt thread. When a client connects, a moonpool fiber is started on <code>runner</code> to handle it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-establish"><a href="#val-establish" class="anchor"></a><code><span><span class="keyword">val</span> establish :
|
||
<span><span class="optlabel">?backlog</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?no_close</span>:bool <span class="arrow">-></span></span>
|
||
<span><span class="label">runner</span>:<a href="../../../moonpool/Moonpool/Runner/index.html#type-t">Moonpool.Runner.t</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span>
|
||
<span><span>(<span><a href="../../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <span><a href="../IO_in/class-type-t/index.html">IO_in.t</a> <span class="arrow">-></span></span> <span><a href="../IO_out/class-type-t/index.html">IO_out.t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Like <a href="#val-establish_lwt"><code>establish_lwt</code></a> but uses <a href="../IO/index.html"><code>IO</code></a> to directly handle reads and writes on client sockets.</p></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-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Shutdown the server</p></div></div></div></body></html>
|