-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
45 changed files
with
2,169 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cachet_lwt (cachet-lwt.Cachet_lwt)</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">cachet-lwt</a> » Cachet_lwt</nav><header class="odoc-preamble"><h1>Module <code><span>Cachet_lwt</span></code></h1><p>The Lwt variation of Cachet implies a point of cooperation (<code>Lwt.pause</code>) as soon as the syscall <code>map</code> is called. In other words, a task developed with Cachet_lwt will make itself available to be rescheduled if we internally call <code>map</code> instead of using the cache.</p><p>In the event that the functions below were to use the cache, they would retain the exclusive right to execute and would not allow any cooperation points to appear.</p><p>Such an approach increases the task's availability if it does I/O in cooperation with other tasks that would also like to do I/O.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-load"><a href="#val-load" class="anchor"></a><code><span><span class="keyword">val</span> load : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span><span class="optlabel">?len</span>:int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span><span><a href="../../cachet/Cachet/index.html#type-slice">Cachet.slice</a> option</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int8"><a href="#val-get_int8" class="anchor"></a><code><span><span class="keyword">val</span> get_int8 : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>get_int8 t logical_address</code> is <code>t</code>'s signed 8-bit integer starting at byte index <code>logical_address</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Out_of_bounds</code> <p>if <code>logical_address</code> is not accessible.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint8"><a href="#val-get_uint8" class="anchor"></a><code><span><span class="keyword">val</span> get_uint8 : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>get_uint8 t logical_address</code> is <code>t</code>'s unsigned 8-bit integer starting at byte index <code>logical_address</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Out_of_bounds</code> <p>if <code>logical_address</code> is not accessible.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint16_ne"><a href="#val-get_uint16_ne" class="anchor"></a><code><span><span class="keyword">val</span> get_uint16_ne : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint16_le"><a href="#val-get_uint16_le" class="anchor"></a><code><span><span class="keyword">val</span> get_uint16_le : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_uint16_be"><a href="#val-get_uint16_be" class="anchor"></a><code><span><span class="keyword">val</span> get_uint16_be : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int16_ne"><a href="#val-get_int16_ne" class="anchor"></a><code><span><span class="keyword">val</span> get_int16_ne : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int16_le"><a href="#val-get_int16_le" class="anchor"></a><code><span><span class="keyword">val</span> get_int16_le : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int16_be"><a href="#val-get_int16_be" class="anchor"></a><code><span><span class="keyword">val</span> get_int16_be : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int32_ne"><a href="#val-get_int32_ne" class="anchor"></a><code><span><span class="keyword">val</span> get_int32_ne : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int32 <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int32_le"><a href="#val-get_int32_le" class="anchor"></a><code><span><span class="keyword">val</span> get_int32_le : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int32 <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int32_be"><a href="#val-get_int32_be" class="anchor"></a><code><span><span class="keyword">val</span> get_int32_be : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int32 <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int64_ne"><a href="#val-get_int64_ne" class="anchor"></a><code><span><span class="keyword">val</span> get_int64_ne : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int64 <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int64_le"><a href="#val-get_int64_le" class="anchor"></a><code><span><span class="keyword">val</span> get_int64_le : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int64 <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_int64_be"><a href="#val-get_int64_be" class="anchor"></a><code><span><span class="keyword">val</span> get_int64_be : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int64 <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_string"><a href="#val-get_string" class="anchor"></a><code><span><span class="keyword">val</span> get_string : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span><span class="label">len</span>:int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>string <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-next"><a href="#val-next" class="anchor"></a><code><span><span class="keyword">val</span> next : <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> <span><a href="../../cachet/Cachet/index.html#type-slice">Cachet.slice</a> <span class="arrow">-></span></span> <span><span><a href="../../cachet/Cachet/index.html#type-slice">Cachet.slice</a> option</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-blit_to_bytes"><a href="#val-blit_to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> blit_to_bytes : | ||
| <span><span><span class="type-var">'fd</span> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span> <span class="arrow">-></span></span> | ||
| <span><span class="label">src_off</span>:int <span class="arrow">-></span></span> | ||
| <span>bytes <span class="arrow">-></span></span> | ||
| <span><span class="label">dst_off</span>:int <span class="arrow">-></span></span> | ||
| <span><span class="label">len</span>:int <span class="arrow">-></span></span> | ||
| <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div></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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cachet-lwt.index)</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> – cachet-lwt</nav><header class="odoc-preamble"><h1 id="cachet-lwt-index"><a href="#cachet-lwt-index" class="anchor"></a>cachet-lwt index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-cachet-lwt">Library cachet-lwt</a></li></ul></nav><div class="odoc-content"><h2 id="library-cachet-lwt"><a href="#library-cachet-lwt" class="anchor"></a>Library cachet-lwt</h2><p>The entry point of this library is the module: <a href="Cachet_lwt/index.html"><code>Cachet_lwt</code></a>.</p></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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cachet_solo5 (cachet-solo5.Cachet_solo5)</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">cachet-solo5</a> » Cachet_solo5</nav><header class="odoc-preamble"><h1>Module <code><span>Cachet_solo5</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-file_descr"><a href="#type-file_descr" class="anchor"></a><code><span><span class="keyword">type</span> file_descr</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-connect"><a href="#val-connect" class="anchor"></a><code><span><span class="keyword">val</span> connect : <span><span class="optlabel">?cachesize</span>:int <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><a href="#type-file_descr">file_descr</a> <a href="../../cachet/Cachet/index.html#type-t">Cachet.t</a></span></span></code></div></div></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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cachet-solo5.index)</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> – cachet-solo5</nav><header class="odoc-preamble"><h1 id="cachet-solo5-index"><a href="#cachet-solo5-index" class="anchor"></a>cachet-solo5 index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-cachet-solo5">Library cachet-solo5</a></li></ul></nav><div class="odoc-content"><h2 id="library-cachet-solo5"><a href="#library-cachet-solo5" class="anchor"></a>Library cachet-solo5</h2><p>The entry point of this library is the module: <a href="Cachet_solo5/index.html"><code>Cachet_solo5</code></a>.</p></div></body></html> |
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.