mirror of
https://github.com/c-cube/tiny_httpd.git
synced 2025-12-06 03:05:29 -05:00
deploy: d686ace2df
This commit is contained in:
c-cube
parent
d75810ace9
commit
9dad54a0e4
3 changed files with 2 additions and 4 deletions
|
|
@ -1,2 +0,0 @@
|
|||
theme: jekyll-theme-minimal
|
||||
include: ["_odoc-theme", "_odoc_support"]
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tiny_httpd_ws (tiny_httpd.Tiny_httpd_ws)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">tiny_httpd</a> » Tiny_httpd_ws</nav><header class="odoc-preamble"><h1>Module <code><span>Tiny_httpd_ws</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> IO</span><span> = <a href="../Tiny_httpd_io/index.html">Tiny_httpd_io</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-handler"><a href="#type-handler" class="anchor"></a><code><span><span class="keyword">type</span> handler</span><span> = <span><a href="../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <span><a href="../Tiny_httpd_io/Input/index.html#type-t">IO.Input.t</a> <span class="arrow">-></span></span> <span><a href="../Tiny_httpd_io/Output/index.html#type-t">IO.Output.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Websocket handler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-upgrade"><a href="#val-upgrade" class="anchor"></a><code><span><span class="keyword">val</span> upgrade : <span><a href="../Tiny_httpd_io/Input/index.html#type-t">IO.Input.t</a> <span class="arrow">-></span></span> <span><a href="../Tiny_httpd_io/Output/index.html#type-t">IO.Output.t</a> <span class="arrow">-></span></span> <a href="../Tiny_httpd_io/Input/index.html#type-t">IO.Input.t</a> * <a href="../Tiny_httpd_io/Output/index.html#type-t">IO.Output.t</a></span></code></div><div class="spec-doc"><p>Upgrade a byte stream to the websocket framing protocol.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_route_handler"><a href="#val-add_route_handler" class="anchor"></a><code><span><span class="keyword">val</span> add_route_handler :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tiny_httpd_ws (tiny_httpd.Tiny_httpd_ws)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">tiny_httpd</a> » Tiny_httpd_ws</nav><header class="odoc-preamble"><h1>Module <code><span>Tiny_httpd_ws</span></code></h1><p>Websockets for Tiny_httpd.</p><p>This sub-library (<code>tiny_httpd.ws</code>) exports a small implementation for a websocket server. It has no additional dependencies.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> IO</span><span> = <a href="../Tiny_httpd_io/index.html">Tiny_httpd_io</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-handler"><a href="#type-handler" class="anchor"></a><code><span><span class="keyword">type</span> handler</span><span> = <span><a href="../../ocaml/Unix/index.html#type-sockaddr">Unix.sockaddr</a> <span class="arrow">-></span></span> <span><a href="../Tiny_httpd_io/Input/index.html#type-t">IO.Input.t</a> <span class="arrow">-></span></span> <span><a href="../Tiny_httpd_io/Output/index.html#type-t">IO.Output.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Websocket handler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-upgrade"><a href="#val-upgrade" class="anchor"></a><code><span><span class="keyword">val</span> upgrade : <span><a href="../Tiny_httpd_io/Input/index.html#type-t">IO.Input.t</a> <span class="arrow">-></span></span> <span><a href="../Tiny_httpd_io/Output/index.html#type-t">IO.Output.t</a> <span class="arrow">-></span></span> <a href="../Tiny_httpd_io/Input/index.html#type-t">IO.Input.t</a> * <a href="../Tiny_httpd_io/Output/index.html#type-t">IO.Output.t</a></span></code></div><div class="spec-doc"><p>Upgrade a byte stream to the websocket framing protocol.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_route_handler"><a href="#val-add_route_handler" class="anchor"></a><code><span><span class="keyword">val</span> add_route_handler :
|
||||
<span><span class="optlabel">?accept</span>:<span>(<span><span>unit <a href="../Tiny_httpd_server/Request/index.html#type-t">Tiny_httpd_server.Request.t</a></span> <span class="arrow">-></span></span> <span><span>(unit, int * string)</span> <a href="../../ocaml/Stdlib/index.html#type-result">result</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?accept_ws_protocol</span>:<span>(<span>string <span class="arrow">-></span></span> bool)</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../Tiny_httpd_server/index.html#type-t">Tiny_httpd_server.t</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (tiny_httpd.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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> – tiny_httpd</nav><header class="odoc-preamble"><h1 id="package-tiny_httpd"><a href="#package-tiny_httpd" class="anchor"></a>Package tiny_httpd <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Tiny_httpd/index.html"><code>Tiny_httpd</code></a> <span class="synopsis">Tiny Http Server</span></li><li><a href="Tiny_httpd_atomic_/index.html"><code>Tiny_httpd_atomic_</code></a> </li><li><a href="Tiny_httpd_buf/index.html"><code>Tiny_httpd_buf</code></a> <span class="synopsis">Simple buffer.</span></li><li><a href="Tiny_httpd_dir/index.html"><code>Tiny_httpd_dir</code></a> <span class="synopsis">Serving static content from directories</span></li><li><a href="Tiny_httpd_html/index.html"><code>Tiny_httpd_html</code></a> <span class="synopsis">HTML combinators.</span></li><li><a href="Tiny_httpd_html_/index.html"><code>Tiny_httpd_html_</code></a> </li><li><a href="Tiny_httpd_io/index.html"><code>Tiny_httpd_io</code></a> <span class="synopsis">IO abstraction.</span></li><li><a href="Tiny_httpd_log/index.html"><code>Tiny_httpd_log</code></a> <span class="synopsis">Logging for tiny_httpd</span></li><li><a href="Tiny_httpd_pool/index.html"><code>Tiny_httpd_pool</code></a> <span class="synopsis">Resource pool.</span></li><li><a href="Tiny_httpd_prometheus/index.html"><code>Tiny_httpd_prometheus</code></a> <span class="synopsis">Expose metrics over HTTP in the prometheus format</span></li><li><a href="Tiny_httpd_server/index.html"><code>Tiny_httpd_server</code></a> <span class="synopsis">HTTP server.</span></li><li><a href="Tiny_httpd_stream/index.html"><code>Tiny_httpd_stream</code></a> <span class="synopsis">Byte streams.</span></li><li><a href="Tiny_httpd_util/index.html"><code>Tiny_httpd_util</code></a> </li><li><a href="Tiny_httpd_ws/index.html"><code>Tiny_httpd_ws</code></a> </li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (tiny_httpd.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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> – tiny_httpd</nav><header class="odoc-preamble"><h1 id="package-tiny_httpd"><a href="#package-tiny_httpd" class="anchor"></a>Package tiny_httpd <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Tiny_httpd/index.html"><code>Tiny_httpd</code></a> <span class="synopsis">Tiny Http Server</span></li><li><a href="Tiny_httpd_atomic_/index.html"><code>Tiny_httpd_atomic_</code></a> </li><li><a href="Tiny_httpd_buf/index.html"><code>Tiny_httpd_buf</code></a> <span class="synopsis">Simple buffer.</span></li><li><a href="Tiny_httpd_dir/index.html"><code>Tiny_httpd_dir</code></a> <span class="synopsis">Serving static content from directories</span></li><li><a href="Tiny_httpd_html/index.html"><code>Tiny_httpd_html</code></a> <span class="synopsis">HTML combinators.</span></li><li><a href="Tiny_httpd_html_/index.html"><code>Tiny_httpd_html_</code></a> </li><li><a href="Tiny_httpd_io/index.html"><code>Tiny_httpd_io</code></a> <span class="synopsis">IO abstraction.</span></li><li><a href="Tiny_httpd_log/index.html"><code>Tiny_httpd_log</code></a> <span class="synopsis">Logging for tiny_httpd</span></li><li><a href="Tiny_httpd_pool/index.html"><code>Tiny_httpd_pool</code></a> <span class="synopsis">Resource pool.</span></li><li><a href="Tiny_httpd_prometheus/index.html"><code>Tiny_httpd_prometheus</code></a> <span class="synopsis">Expose metrics over HTTP in the prometheus format</span></li><li><a href="Tiny_httpd_server/index.html"><code>Tiny_httpd_server</code></a> <span class="synopsis">HTTP server.</span></li><li><a href="Tiny_httpd_stream/index.html"><code>Tiny_httpd_stream</code></a> <span class="synopsis">Byte streams.</span></li><li><a href="Tiny_httpd_util/index.html"><code>Tiny_httpd_util</code></a> </li><li><a href="Tiny_httpd_ws/index.html"><code>Tiny_httpd_ws</code></a> <span class="synopsis">Websockets for Tiny_httpd.</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue