-
Notifications
You must be signed in to change notification settings - Fork 253
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
7 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_info (mirage-runtime.Mirage_info)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-runtime</a> » Mirage_info</nav><h1>Module <code>Mirage_info</code></h1><p>Runtime information about the application.</p><p><em>Release 3.3.0</em></p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>Functoria_info.info</code><code><span class="keyword"> = </span></code><code>{</code><table class="record"><tr id="type-t.name" class="anchored"><td class="def field"><a href="#type-t.name" class="anchor"></a><code>name : string;</code></td></tr><tr id="type-t.libraries" class="anchored"><td class="def field"><a href="#type-t.libraries" class="anchor"></a><code>libraries : string list;</code></td></tr><tr id="type-t.packages" class="anchored"><td class="def field"><a href="#type-t.packages" class="anchor"></a><code>packages : (string<span class="keyword"> * </span>string) list;</code></td></tr></table><code>}</code></dt></dl></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_info (mirage-runtime.Mirage_info)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-runtime</a> » Mirage_info</nav><h1>Module <code>Mirage_info</code></h1><p>Runtime information about the application.</p><p><em>Release 3.3.1</em></p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>Functoria_info.info</code><code><span class="keyword"> = </span></code><code>{</code><table class="record"><tr id="type-t.name" class="anchored"><td class="def field"><a href="#type-t.name" class="anchor"></a><code>name : string;</code></td></tr><tr id="type-t.libraries" class="anchored"><td class="def field"><a href="#type-t.libraries" class="anchor"></a><code>libraries : string list;</code></td></tr><tr id="type-t.packages" class="anchored"><td class="def field"><a href="#type-t.packages" class="anchor"></a><code>packages : (string<span class="keyword"> * </span>string) list;</code></td></tr></table><code>}</code></dt></dl></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_runtime (mirage-runtime.Mirage_runtime)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-runtime</a> » Mirage_runtime</nav><h1>Module <code>Mirage_runtime</code></h1><p>Mirage run-time utilities.</p><p><em>Release 3.3.0</em></p><nav class="toc"><ul><li><a href="#log-thresholds">Log thresholds</a></li></ul></nav></header><section><header><h2 id="log-thresholds"><a href="#log-thresholds" class="anchor"></a>Log thresholds</h2></header><dl><dt class="spec type" id="type-log_threshold"><a href="#type-log_threshold" class="anchor"></a><code><span class="keyword">type </span>log_threshold</code><code><span class="keyword"> = </span>[ `All<span class="keyword"> | </span>`Src of string ]<span class="keyword"> * </span>Logs.level</code></dt><dd><p>The type for log threshold.</p></dd></dl><dl><dt class="spec value" id="val-set_level"><a href="#val-set_level" class="anchor"></a><code><span class="keyword">val </span>set_level : default:Logs.level <span>-></span> <a href="index.html#type-log_threshold">log_threshold</a> list <span>-></span> unit</code></dt><dd><p><code>set_level ~default l</code> set the log levels needed to have all of the log sources appearing in <code>l</code> be used.</p></dd></dl><div class="spec module" id="module-Arg"><a href="#module-Arg" class="anchor"></a><code><span class="keyword">module </span><a href="Arg/index.html">Arg</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div><div class="spec include"><div class="doc"><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span>Functoria_runtime<span class="keyword"> with </span><span class="keyword">module </span><a href="index.html">Mirage_runtime</a>.Arg := <a href="index.html#module-Arg">Arg</a></code></span></summary><div class="spec module" id="module-Key"><a href="#module-Key" class="anchor"></a><code><span class="keyword">module </span><a href="Key/index.html">Key</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec value" id="val-with_argv"><a href="#val-with_argv" class="anchor"></a><code><span class="keyword">val </span>with_argv : unit Cmdliner.Term.t list <span>-></span> string <span>-></span> string array <span>-></span> unit</code></dt></dl></details></div></div></div></section></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_runtime (mirage-runtime.Mirage_runtime)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-runtime</a> » Mirage_runtime</nav><h1>Module <code>Mirage_runtime</code></h1><p>Mirage run-time utilities.</p><p><em>Release 3.3.1</em></p><nav class="toc"><ul><li><a href="#log-thresholds">Log thresholds</a></li></ul></nav></header><section><header><h2 id="log-thresholds"><a href="#log-thresholds" class="anchor"></a>Log thresholds</h2></header><dl><dt class="spec type" id="type-log_threshold"><a href="#type-log_threshold" class="anchor"></a><code><span class="keyword">type </span>log_threshold</code><code><span class="keyword"> = </span>[ `All<span class="keyword"> | </span>`Src of string ]<span class="keyword"> * </span>Logs.level</code></dt><dd><p>The type for log threshold.</p></dd></dl><dl><dt class="spec value" id="val-set_level"><a href="#val-set_level" class="anchor"></a><code><span class="keyword">val </span>set_level : default:Logs.level <span>-></span> <a href="index.html#type-log_threshold">log_threshold</a> list <span>-></span> unit</code></dt><dd><p><code>set_level ~default l</code> set the log levels needed to have all of the log sources appearing in <code>l</code> be used.</p></dd></dl><div class="spec module" id="module-Arg"><a href="#module-Arg" class="anchor"></a><code><span class="keyword">module </span><a href="Arg/index.html">Arg</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div><div class="spec include"><div class="doc"><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span>Functoria_runtime<span class="keyword"> with </span><span class="keyword">module </span><a href="index.html">Mirage_runtime</a>.Arg := <a href="index.html#module-Arg">Arg</a></code></span></summary><div class="spec module" id="module-Key"><a href="#module-Key" class="anchor"></a><code><span class="keyword">module </span><a href="Key/index.html">Key</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec value" id="val-with_argv"><a href="#val-with_argv" class="anchor"></a><code><span class="keyword">val </span>with_argv : unit Cmdliner.Term.t list <span>-></span> string <span>-></span> string array <span>-></span> unit</code></dt></dl></details></div></div></div></section></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_types_lwt (mirage-types-lwt.Mirage_types_lwt)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-types-lwt</a> » Mirage_types_lwt</nav><h1>Module <code>Mirage_types_lwt</code></h1><p>lwt-compatible MirageOS signatures.</p><p><em>Release 3.3.0</em></p></header><div class="spec module-type" id="module-type-TIME"><a href="#module-type-TIME" class="anchor"></a><code><span class="keyword">module type </span>TIME = Mirage_time_lwt.S</code></div><div class="spec module-type" id="module-type-MCLOCK"><a href="#module-type-MCLOCK" class="anchor"></a><code><span class="keyword">module type </span>MCLOCK = Mirage_clock_lwt.MCLOCK</code></div><div class="spec module-type" id="module-type-PCLOCK"><a href="#module-type-PCLOCK" class="anchor"></a><code><span class="keyword">module type </span>PCLOCK = Mirage_clock_lwt.PCLOCK</code></div><div class="spec module-type" id="module-type-RANDOM"><a href="#module-type-RANDOM" class="anchor"></a><code><span class="keyword">module type </span>RANDOM = Mirage_random.C</code></div><div class="spec module-type" id="module-type-FLOW"><a href="#module-type-FLOW" class="anchor"></a><code><span class="keyword">module type </span>FLOW = Mirage_flow_lwt.S</code></div><dl><dt class="spec module-type" id="module-type-CONSOLE"><a href="#module-type-CONSOLE" class="anchor"></a><code><span class="keyword">module type </span>CONSOLE = Mirage_console_lwt.S</code></dt><dd><p>Consoles</p></dd></dl><dl><dt class="spec module-type" id="module-type-BLOCK"><a href="#module-type-BLOCK" class="anchor"></a><code><span class="keyword">module type </span>BLOCK = Mirage_block_lwt.S</code></dt><dd><p>Block devices</p></dd></dl><dl><dt class="spec module-type" id="module-type-NETWORK"><a href="#module-type-NETWORK" class="anchor"></a><code><span class="keyword">module type </span>NETWORK = Mirage_net_lwt.S</code></dt><dd><p>Network</p></dd></dl><dl><dt class="spec module-type" id="module-type-ETHIF"><a href="#module-type-ETHIF" class="anchor"></a><code><span class="keyword">module type </span>ETHIF = Mirage_protocols_lwt.ETHIF</code></dt><dd><p>Network protocol implementations from Mirage_protocols</p></dd></dl><div class="spec module-type" id="module-type-ARP"><a href="#module-type-ARP" class="anchor"></a><code><span class="keyword">module type </span>ARP = Mirage_protocols_lwt.ARP</code></div><div class="spec module-type" id="module-type-IP"><a href="#module-type-IP" class="anchor"></a><code><span class="keyword">module type </span>IP = Mirage_protocols_lwt.IP</code></div><div class="spec module-type" id="module-type-IPV4"><a href="#module-type-IPV4" class="anchor"></a><code><span class="keyword">module type </span>IPV4 = Mirage_protocols_lwt.IPV4</code></div><div class="spec module-type" id="module-type-IPV6"><a href="#module-type-IPV6" class="anchor"></a><code><span class="keyword">module type </span>IPV6 = Mirage_protocols_lwt.IPV6</code></div><div class="spec module-type" id="module-type-ICMP"><a href="#module-type-ICMP" class="anchor"></a><code><span class="keyword">module type </span>ICMP = Mirage_protocols_lwt.ICMP</code></div><div class="spec module-type" id="module-type-ICMPV4"><a href="#module-type-ICMPV4" class="anchor"></a><code><span class="keyword">module type </span>ICMPV4 = Mirage_protocols_lwt.ICMPV4</code></div><div class="spec module-type" id="module-type-UDP"><a href="#module-type-UDP" class="anchor"></a><code><span class="keyword">module type </span>UDP = Mirage_protocols_lwt.UDP</code></div><div class="spec module-type" id="module-type-UDPV4"><a href="#module-type-UDPV4" class="anchor"></a><code><span class="keyword">module type </span>UDPV4 = Mirage_protocols_lwt.UDPV4</code></div><div class="spec module-type" id="module-type-UDPV6"><a href="#module-type-UDPV6" class="anchor"></a><code><span class="keyword">module type </span>UDPV6 = Mirage_protocols_lwt.UDPV6</code></div><div class="spec module-type" id="module-type-TCP"><a href="#module-type-TCP" class="anchor"></a><code><span class="keyword">module type </span>TCP = Mirage_protocols_lwt.TCP</code></div><div class="spec module-type" id="module-type-TCPV4"><a href="#module-type-TCPV4" class="anchor"></a><code><span class="keyword">module type </span>TCPV4 = Mirage_protocols_lwt.TCPV4</code></div><div class="spec module-type" id="module-type-TCPV6"><a href="#module-type-TCPV6" class="anchor"></a><code><span class="keyword">module type </span>TCPV6 = Mirage_protocols_lwt.TCPV6</code></div><dl><dt class="spec module-type" id="module-type-CHANNEL"><a href="#module-type-CHANNEL" class="anchor"></a><code><span class="keyword">module type </span>CHANNEL = Mirage_channel_lwt.S</code></dt><dd><p>Buffered TCP channel</p></dd></dl><dl><dt class="spec module-type" id="module-type-KV_RO"><a href="#module-type-KV_RO" class="anchor"></a><code><span class="keyword">module type </span>KV_RO = Mirage_kv_lwt.RO</code></dt><dd><p>KV RO</p></dd></dl><dl><dt class="spec module-type" id="module-type-FS"><a href="#module-type-FS" class="anchor"></a><code><span class="keyword">module type </span>FS = Mirage_fs_lwt.S</code></dt><dd><p>FS</p></dd></dl><dl><dt class="spec module-type" id="module-type-STACKV4"><a href="#module-type-STACKV4" class="anchor"></a><code><span class="keyword">module type </span>STACKV4 = Mirage_stack_lwt.V4</code></dt><dd><p>Single network stack</p></dd></dl></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_types_lwt (mirage-types-lwt.Mirage_types_lwt)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-types-lwt</a> » Mirage_types_lwt</nav><h1>Module <code>Mirage_types_lwt</code></h1><p>lwt-compatible MirageOS signatures.</p><p><em>Release 3.3.1</em></p></header><div class="spec module-type" id="module-type-TIME"><a href="#module-type-TIME" class="anchor"></a><code><span class="keyword">module type </span>TIME = Mirage_time_lwt.S</code></div><div class="spec module-type" id="module-type-MCLOCK"><a href="#module-type-MCLOCK" class="anchor"></a><code><span class="keyword">module type </span>MCLOCK = Mirage_clock_lwt.MCLOCK</code></div><div class="spec module-type" id="module-type-PCLOCK"><a href="#module-type-PCLOCK" class="anchor"></a><code><span class="keyword">module type </span>PCLOCK = Mirage_clock_lwt.PCLOCK</code></div><div class="spec module-type" id="module-type-RANDOM"><a href="#module-type-RANDOM" class="anchor"></a><code><span class="keyword">module type </span>RANDOM = Mirage_random.C</code></div><div class="spec module-type" id="module-type-FLOW"><a href="#module-type-FLOW" class="anchor"></a><code><span class="keyword">module type </span>FLOW = Mirage_flow_lwt.S</code></div><dl><dt class="spec module-type" id="module-type-CONSOLE"><a href="#module-type-CONSOLE" class="anchor"></a><code><span class="keyword">module type </span>CONSOLE = Mirage_console_lwt.S</code></dt><dd><p>Consoles</p></dd></dl><dl><dt class="spec module-type" id="module-type-BLOCK"><a href="#module-type-BLOCK" class="anchor"></a><code><span class="keyword">module type </span>BLOCK = Mirage_block_lwt.S</code></dt><dd><p>Block devices</p></dd></dl><dl><dt class="spec module-type" id="module-type-NETWORK"><a href="#module-type-NETWORK" class="anchor"></a><code><span class="keyword">module type </span>NETWORK = Mirage_net_lwt.S</code></dt><dd><p>Network</p></dd></dl><dl><dt class="spec module-type" id="module-type-ETHIF"><a href="#module-type-ETHIF" class="anchor"></a><code><span class="keyword">module type </span>ETHIF = Mirage_protocols_lwt.ETHIF</code></dt><dd><p>Network protocol implementations from Mirage_protocols</p></dd></dl><div class="spec module-type" id="module-type-ARP"><a href="#module-type-ARP" class="anchor"></a><code><span class="keyword">module type </span>ARP = Mirage_protocols_lwt.ARP</code></div><div class="spec module-type" id="module-type-IP"><a href="#module-type-IP" class="anchor"></a><code><span class="keyword">module type </span>IP = Mirage_protocols_lwt.IP</code></div><div class="spec module-type" id="module-type-IPV4"><a href="#module-type-IPV4" class="anchor"></a><code><span class="keyword">module type </span>IPV4 = Mirage_protocols_lwt.IPV4</code></div><div class="spec module-type" id="module-type-IPV6"><a href="#module-type-IPV6" class="anchor"></a><code><span class="keyword">module type </span>IPV6 = Mirage_protocols_lwt.IPV6</code></div><div class="spec module-type" id="module-type-ICMP"><a href="#module-type-ICMP" class="anchor"></a><code><span class="keyword">module type </span>ICMP = Mirage_protocols_lwt.ICMP</code></div><div class="spec module-type" id="module-type-ICMPV4"><a href="#module-type-ICMPV4" class="anchor"></a><code><span class="keyword">module type </span>ICMPV4 = Mirage_protocols_lwt.ICMPV4</code></div><div class="spec module-type" id="module-type-UDP"><a href="#module-type-UDP" class="anchor"></a><code><span class="keyword">module type </span>UDP = Mirage_protocols_lwt.UDP</code></div><div class="spec module-type" id="module-type-UDPV4"><a href="#module-type-UDPV4" class="anchor"></a><code><span class="keyword">module type </span>UDPV4 = Mirage_protocols_lwt.UDPV4</code></div><div class="spec module-type" id="module-type-UDPV6"><a href="#module-type-UDPV6" class="anchor"></a><code><span class="keyword">module type </span>UDPV6 = Mirage_protocols_lwt.UDPV6</code></div><div class="spec module-type" id="module-type-TCP"><a href="#module-type-TCP" class="anchor"></a><code><span class="keyword">module type </span>TCP = Mirage_protocols_lwt.TCP</code></div><div class="spec module-type" id="module-type-TCPV4"><a href="#module-type-TCPV4" class="anchor"></a><code><span class="keyword">module type </span>TCPV4 = Mirage_protocols_lwt.TCPV4</code></div><div class="spec module-type" id="module-type-TCPV6"><a href="#module-type-TCPV6" class="anchor"></a><code><span class="keyword">module type </span>TCPV6 = Mirage_protocols_lwt.TCPV6</code></div><dl><dt class="spec module-type" id="module-type-CHANNEL"><a href="#module-type-CHANNEL" class="anchor"></a><code><span class="keyword">module type </span>CHANNEL = Mirage_channel_lwt.S</code></dt><dd><p>Buffered TCP channel</p></dd></dl><dl><dt class="spec module-type" id="module-type-KV_RO"><a href="#module-type-KV_RO" class="anchor"></a><code><span class="keyword">module type </span>KV_RO = Mirage_kv_lwt.RO</code></dt><dd><p>KV RO</p></dd></dl><dl><dt class="spec module-type" id="module-type-FS"><a href="#module-type-FS" class="anchor"></a><code><span class="keyword">module type </span>FS = Mirage_fs_lwt.S</code></dt><dd><p>FS</p></dd></dl><dl><dt class="spec module-type" id="module-type-STACKV4"><a href="#module-type-STACKV4" class="anchor"></a><code><span class="keyword">module type </span>STACKV4 = Mirage_stack_lwt.V4</code></dt><dd><p>Single network stack</p></dd></dl></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_types (mirage-types.Mirage_types)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-types</a> » Mirage_types</nav><h1>Module <code>Mirage_types</code></h1><p>MirageOS Signatures.</p><p>This module defines the basic signatures that functor parameters should implement in MirageOS to be portable.</p><h2 id="general-conventions"><a href="#general-conventions" class="anchor"></a>General conventions</h2><ul><li>errors which application programmers are expected to handle (e.g. connection refused or end of file) are encoded as result types where <code>Ok x</code> means the operation was succesful and returns <code>x</code> and where <code>Error e</code> means the operation has failed with error <code>e</code>. The error <code>e</code> uses the <span class="xref-unresolved" title="unresolved reference to "Rresult.R.msg""><span class="xref-unresolved" title="unresolved reference to "Rresult.R""><code>Rresult</code>.R</span>.msg</span> type for the most general error message, and possibly more specific ones depending on the interface.</li><li>errors which represent programming errors such as assertion failures or illegal arguments are encoded as exceptions. The application may attempt to catch exceptions and recover or simply let the exception propagate and crash the application. If the application crashes then the runtime system should output diagnostics and abort.</li><li>operations which perform I/O return values of <code>type +'a io</code> which allow the application to either wait for the I/O to be completed or leave it running asynchronously. If the I/O completes with an error then the operation may have completely failed, partially succeeded or even completely succeeded (e.g. it may only be a confirmation message in a network protocol which was missed): see individual API descriptions for details.</li></ul><p><em>Release 3.3.0</em></p><nav class="toc"><ul><li><a href="#time-and-clock-devices">Time and clock devices</a></li><li><a href="#connection-between-endpoints">Connection between endpoints</a></li><li><a href="#console">Console</a></li><li><a href="#sector-addressible-block-devices">Sector-addressible block devices</a></li><li><a href="#static-key/value-store">Static Key/value store</a></li><li><a href="#filesystem-devices">Filesystem devices</a></li></ul></nav></header><div class="spec module-type" id="module-type-DEVICE"><a href="#module-type-DEVICE" class="anchor"></a><code><span class="keyword">module type </span>DEVICE = Mirage_device.S</code></div><section><header><h2 id="time-and-clock-devices"><a href="#time-and-clock-devices" class="anchor"></a>Time and clock devices</h2></header><div class="spec module-type" id="module-type-TIME"><a href="#module-type-TIME" class="anchor"></a><code><span class="keyword">module type </span>TIME = Mirage_time.S</code></div><div class="spec module-type" id="module-type-MCLOCK"><a href="#module-type-MCLOCK" class="anchor"></a><code><span class="keyword">module type </span>MCLOCK = Mirage_clock.MCLOCK</code></div><div class="spec module-type" id="module-type-PCLOCK"><a href="#module-type-PCLOCK" class="anchor"></a><code><span class="keyword">module type </span>PCLOCK = Mirage_clock.PCLOCK</code></div><dl><dt class="spec module-type" id="module-type-RANDOM"><a href="#module-type-RANDOM" class="anchor"></a><code><span class="keyword">module type </span>RANDOM = Mirage_random.S</code></dt><dd></dd></dl></section><section><header><h2 id="connection-between-endpoints"><a href="#connection-between-endpoints" class="anchor"></a>Connection between endpoints</h2></header><div class="spec module-type" id="module-type-FLOW"><a href="#module-type-FLOW" class="anchor"></a><code><span class="keyword">module type </span>FLOW = Mirage_flow.S</code></div></section><section><header><h2 id="console"><a href="#console" class="anchor"></a>Console</h2></header><div class="spec module-type" id="module-type-CONSOLE"><a href="#module-type-CONSOLE" class="anchor"></a><code><span class="keyword">module type </span>CONSOLE = Mirage_console.S</code></div></section><section><header><h2 id="sector-addressible-block-devices"><a href="#sector-addressible-block-devices" class="anchor"></a>Sector-addressible block devices</h2></header><div class="spec module-type" id="module-type-BLOCK"><a href="#module-type-BLOCK" class="anchor"></a><code><span class="keyword">module type </span>BLOCK = Mirage_block.S</code></div><dl><dt class="spec module-type" id="module-type-NETWORK"><a href="#module-type-NETWORK" class="anchor"></a><code><span class="keyword">module type </span>NETWORK = Mirage_net.S</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-ETHIF"><a href="#module-type-ETHIF" class="anchor"></a><code><span class="keyword">module type </span>ETHIF = Mirage_protocols.ETHIF</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-IP"><a href="#module-type-IP" class="anchor"></a><code><span class="keyword">module type </span>IP = Mirage_protocols.IP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-ARP"><a href="#module-type-ARP" class="anchor"></a><code><span class="keyword">module type </span>ARP = Mirage_protocols.ARP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-IPV4"><a href="#module-type-IPV4" class="anchor"></a><code><span class="keyword">module type </span>IPV4 = Mirage_protocols.IPV4</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-IPV6"><a href="#module-type-IPV6" class="anchor"></a><code><span class="keyword">module type </span>IPV6 = Mirage_protocols.IPV6</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-ICMP"><a href="#module-type-ICMP" class="anchor"></a><code><span class="keyword">module type </span>ICMP = Mirage_protocols.ICMP</code></dt><dd></dd></dl><div class="spec module-type" id="module-type-ICMPV4"><a href="#module-type-ICMPV4" class="anchor"></a><code><span class="keyword">module type </span>ICMPV4 = Mirage_protocols.ICMPV4</code></div><dl><dt class="spec module-type" id="module-type-UDP"><a href="#module-type-UDP" class="anchor"></a><code><span class="keyword">module type </span>UDP = Mirage_protocols.UDP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-TCP"><a href="#module-type-TCP" class="anchor"></a><code><span class="keyword">module type </span>TCP = Mirage_protocols.TCP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-STACKV4"><a href="#module-type-STACKV4" class="anchor"></a><code><span class="keyword">module type </span>STACKV4 = Mirage_stack.V4</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-CHANNEL"><a href="#module-type-CHANNEL" class="anchor"></a><code><span class="keyword">module type </span>CHANNEL = Mirage_channel.S</code></dt><dd></dd></dl></section><section><header><h2 id="static-key/value-store"><a href="#static-key/value-store" class="anchor"></a>Static Key/value store</h2></header><div class="spec module-type" id="module-type-KV_RO"><a href="#module-type-KV_RO" class="anchor"></a><code><span class="keyword">module type </span>KV_RO = Mirage_kv.RO</code></div></section><section><header><h2 id="filesystem-devices"><a href="#filesystem-devices" class="anchor"></a>Filesystem devices</h2></header><div class="spec module-type" id="module-type-FS"><a href="#module-type-FS" class="anchor"></a><code><span class="keyword">module type </span>FS = Mirage_fs.S</code></div></section></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mirage_types (mirage-types.Mirage_types)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">mirage-types</a> » Mirage_types</nav><h1>Module <code>Mirage_types</code></h1><p>MirageOS Signatures.</p><p>This module defines the basic signatures that functor parameters should implement in MirageOS to be portable.</p><h2 id="general-conventions"><a href="#general-conventions" class="anchor"></a>General conventions</h2><ul><li>errors which application programmers are expected to handle (e.g. connection refused or end of file) are encoded as result types where <code>Ok x</code> means the operation was succesful and returns <code>x</code> and where <code>Error e</code> means the operation has failed with error <code>e</code>. The error <code>e</code> uses the <span class="xref-unresolved" title="unresolved reference to "Rresult.R.msg""><span class="xref-unresolved" title="unresolved reference to "Rresult.R""><code>Rresult</code>.R</span>.msg</span> type for the most general error message, and possibly more specific ones depending on the interface.</li><li>errors which represent programming errors such as assertion failures or illegal arguments are encoded as exceptions. The application may attempt to catch exceptions and recover or simply let the exception propagate and crash the application. If the application crashes then the runtime system should output diagnostics and abort.</li><li>operations which perform I/O return values of <code>type +'a io</code> which allow the application to either wait for the I/O to be completed or leave it running asynchronously. If the I/O completes with an error then the operation may have completely failed, partially succeeded or even completely succeeded (e.g. it may only be a confirmation message in a network protocol which was missed): see individual API descriptions for details.</li></ul><p><em>Release 3.3.1</em></p><nav class="toc"><ul><li><a href="#time-and-clock-devices">Time and clock devices</a></li><li><a href="#connection-between-endpoints">Connection between endpoints</a></li><li><a href="#console">Console</a></li><li><a href="#sector-addressible-block-devices">Sector-addressible block devices</a></li><li><a href="#static-key/value-store">Static Key/value store</a></li><li><a href="#filesystem-devices">Filesystem devices</a></li></ul></nav></header><div class="spec module-type" id="module-type-DEVICE"><a href="#module-type-DEVICE" class="anchor"></a><code><span class="keyword">module type </span>DEVICE = Mirage_device.S</code></div><section><header><h2 id="time-and-clock-devices"><a href="#time-and-clock-devices" class="anchor"></a>Time and clock devices</h2></header><div class="spec module-type" id="module-type-TIME"><a href="#module-type-TIME" class="anchor"></a><code><span class="keyword">module type </span>TIME = Mirage_time.S</code></div><div class="spec module-type" id="module-type-MCLOCK"><a href="#module-type-MCLOCK" class="anchor"></a><code><span class="keyword">module type </span>MCLOCK = Mirage_clock.MCLOCK</code></div><div class="spec module-type" id="module-type-PCLOCK"><a href="#module-type-PCLOCK" class="anchor"></a><code><span class="keyword">module type </span>PCLOCK = Mirage_clock.PCLOCK</code></div><dl><dt class="spec module-type" id="module-type-RANDOM"><a href="#module-type-RANDOM" class="anchor"></a><code><span class="keyword">module type </span>RANDOM = Mirage_random.S</code></dt><dd></dd></dl></section><section><header><h2 id="connection-between-endpoints"><a href="#connection-between-endpoints" class="anchor"></a>Connection between endpoints</h2></header><div class="spec module-type" id="module-type-FLOW"><a href="#module-type-FLOW" class="anchor"></a><code><span class="keyword">module type </span>FLOW = Mirage_flow.S</code></div></section><section><header><h2 id="console"><a href="#console" class="anchor"></a>Console</h2></header><div class="spec module-type" id="module-type-CONSOLE"><a href="#module-type-CONSOLE" class="anchor"></a><code><span class="keyword">module type </span>CONSOLE = Mirage_console.S</code></div></section><section><header><h2 id="sector-addressible-block-devices"><a href="#sector-addressible-block-devices" class="anchor"></a>Sector-addressible block devices</h2></header><div class="spec module-type" id="module-type-BLOCK"><a href="#module-type-BLOCK" class="anchor"></a><code><span class="keyword">module type </span>BLOCK = Mirage_block.S</code></div><dl><dt class="spec module-type" id="module-type-NETWORK"><a href="#module-type-NETWORK" class="anchor"></a><code><span class="keyword">module type </span>NETWORK = Mirage_net.S</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-ETHIF"><a href="#module-type-ETHIF" class="anchor"></a><code><span class="keyword">module type </span>ETHIF = Mirage_protocols.ETHIF</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-IP"><a href="#module-type-IP" class="anchor"></a><code><span class="keyword">module type </span>IP = Mirage_protocols.IP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-ARP"><a href="#module-type-ARP" class="anchor"></a><code><span class="keyword">module type </span>ARP = Mirage_protocols.ARP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-IPV4"><a href="#module-type-IPV4" class="anchor"></a><code><span class="keyword">module type </span>IPV4 = Mirage_protocols.IPV4</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-IPV6"><a href="#module-type-IPV6" class="anchor"></a><code><span class="keyword">module type </span>IPV6 = Mirage_protocols.IPV6</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-ICMP"><a href="#module-type-ICMP" class="anchor"></a><code><span class="keyword">module type </span>ICMP = Mirage_protocols.ICMP</code></dt><dd></dd></dl><div class="spec module-type" id="module-type-ICMPV4"><a href="#module-type-ICMPV4" class="anchor"></a><code><span class="keyword">module type </span>ICMPV4 = Mirage_protocols.ICMPV4</code></div><dl><dt class="spec module-type" id="module-type-UDP"><a href="#module-type-UDP" class="anchor"></a><code><span class="keyword">module type </span>UDP = Mirage_protocols.UDP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-TCP"><a href="#module-type-TCP" class="anchor"></a><code><span class="keyword">module type </span>TCP = Mirage_protocols.TCP</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-STACKV4"><a href="#module-type-STACKV4" class="anchor"></a><code><span class="keyword">module type </span>STACKV4 = Mirage_stack.V4</code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-CHANNEL"><a href="#module-type-CHANNEL" class="anchor"></a><code><span class="keyword">module type </span>CHANNEL = Mirage_channel.S</code></dt><dd></dd></dl></section><section><header><h2 id="static-key/value-store"><a href="#static-key/value-store" class="anchor"></a>Static Key/value store</h2></header><div class="spec module-type" id="module-type-KV_RO"><a href="#module-type-KV_RO" class="anchor"></a><code><span class="keyword">module type </span>KV_RO = Mirage_kv.RO</code></div></section><section><header><h2 id="filesystem-devices"><a href="#filesystem-devices" class="anchor"></a>Filesystem devices</h2></header><div class="spec module-type" id="module-type-FS"><a href="#module-type-FS" class="anchor"></a><code><span class="keyword">module type </span>FS = Mirage_fs.S</code></div></section></div></body></html> |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.