ocaml-opentelemetry/eio/Eio_mock/Net/index.html
2026-04-06 19:57:49 +00:00

9 lines
6.4 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Net (eio.Eio_mock.Net)</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> &#x00BB; <a href="../../index.html">eio</a> &#x00BB; <a href="../index.html">Eio_mock</a> &#x00BB; Net</nav><header class="odoc-preamble"><h1>Module <code><span>Eio_mock.Net</span></code></h1><p>Mock <a href="../../Eio/Net/index.html"><code>Eio.Net</code></a> networks and sockets.</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><span> = <span><span><span>[ `Generic <span>| `Mock</span> ]</span> <a href="../../Eio/Net/index.html#type-ty">Eio.Net.ty</a></span> <a href="../../Eio/Std/index.html#type-r">Eio.Std.r</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-listening_socket"><a href="#type-listening_socket" class="anchor"></a><code><span><span class="keyword">type</span> listening_socket</span><span> =
<span><span><span>[ `Generic <span>| `Mock</span> ]</span> <a href="../../Eio/Net/index.html#type-listening_socket_ty">Eio.Net.listening_socket_ty</a></span> <a href="../../Eio/Std/index.html#type-r">Eio.Std.r</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>make label</code> is a new mock network.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_connect"><a href="#val-on_connect" class="anchor"></a><code><span><span class="keyword">val</span> on_connect : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span><span class="type-var">_</span> <a href="../../Eio/Net/index.html#type-stream_socket">Eio.Net.stream_socket</a></span> <a href="../Handler/index.html#type-actions">Handler.actions</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>on_connect t actions</code> configures what to do when a client tries to connect somewhere.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_listen"><a href="#val-on_listen" class="anchor"></a><code><span><span class="keyword">val</span> on_listen : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span><span class="type-var">_</span> <a href="../../Eio/Net/index.html#type-listening_socket">Eio.Net.listening_socket</a></span> <a href="../Handler/index.html#type-actions">Handler.actions</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>on_listen t actions</code> configures what to do when a server starts listening for incoming connections.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_datagram_socket"><a href="#val-on_datagram_socket" class="anchor"></a><code><span><span class="keyword">val</span> on_datagram_socket : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span><span class="type-var">_</span> <a href="../../Eio/Net/index.html#type-datagram_socket">Eio.Net.datagram_socket</a></span> <a href="../Handler/index.html#type-actions">Handler.actions</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>on_datagram_socket t actions</code> configures how to create datagram sockets.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_getaddrinfo"><a href="#val-on_getaddrinfo" class="anchor"></a><code><span><span class="keyword">val</span> on_getaddrinfo : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span><a href="../../Eio/Net/Sockaddr/index.html#type-t">Eio.Net.Sockaddr.t</a> list</span> <a href="../Handler/index.html#type-actions">Handler.actions</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_getnameinfo"><a href="#val-on_getnameinfo" class="anchor"></a><code><span><span class="keyword">val</span> on_getnameinfo : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(string * string)</span> <a href="../Handler/index.html#type-actions">Handler.actions</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-listening_socket"><a href="#val-listening_socket" class="anchor"></a><code><span><span class="keyword">val</span> listening_socket :
<span><span class="optlabel">?listening_addr</span>:<a href="../../Eio/Net/Sockaddr/index.html#type-stream">Eio.Net.Sockaddr.stream</a> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<a href="#type-listening_socket">listening_socket</a></span></code></div><div class="spec-doc"><p><code>listening_socket label</code> can be configured to provide mock connections.</p><p>If <code>listening_addr</code> is not provided, a dummy value will be reported.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_accept"><a href="#val-on_accept" class="anchor"></a><code><span><span class="keyword">val</span> on_accept :
<span><a href="#type-listening_socket">listening_socket</a> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../Flow/index.html#type-t">Flow.t</a> * <a href="../../Eio/Net/Sockaddr/index.html#type-stream">Eio.Net.Sockaddr.stream</a>)</span> <a href="../Handler/index.html#type-actions">Handler.actions</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>on_accept socket actions</code> configures how to respond when the server calls &quot;accept&quot;.</p></div></div></div></body></html>