diff options
Diffstat (limited to 'docs/en/cowboy/2.2/manual/index.html')
-rw-r--r-- | docs/en/cowboy/2.2/manual/index.html | 178 |
1 files changed, 42 insertions, 136 deletions
diff --git a/docs/en/cowboy/2.2/manual/index.html b/docs/en/cowboy/2.2/manual/index.html index 24224831..805dfe85 100644 --- a/docs/en/cowboy/2.2/manual/index.html +++ b/docs/en/cowboy/2.2/manual/index.html @@ -62,171 +62,77 @@ <h1 class="lined-header"><span>Cowboy Function Reference</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p></div> -</div> -</div> -<div class="sect1"> +<p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Cowboy is an HTTP server for Erlang/OTP with support for the -HTTP/1.1, HTTP/2 and Websocket protocols.</p></div> -<div class="paragraph"><p>Cowboy aims to provide a complete HTTP stack. This includes -the implementation of the HTTP RFCs but also any directly -related standards, like Websocket or Server-Sent Events.</p></div> -</div> -</div> -<div class="sect1"> +<p>Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events.</p> <h2 id="_modules">Modules</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Functions:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="cowboy">cowboy(3)</a> - Listener management -</p> +<p>Functions:</p> +<ul><li><a href="cowboy">cowboy(3)</a> - Listener management </li> -<li> -<p> -<a href="cowboy_req">cowboy_req(3)</a> - Request and response -</p> +<li><a href="cowboy_req">cowboy_req(3)</a> - Request and response </li> -<li> -<p> -<a href="cowboy_router">cowboy_router(3)</a> - Router -</p> +<li><a href="cowboy_router">cowboy_router(3)</a> - Router </li> -<li> -<p> -<a href="cowboy_constraints">cowboy_constraints(3)</a> - Constraints -</p> +<li><a href="cowboy_constraints">cowboy_constraints(3)</a> - Constraints </li> -</ul></div> -<div class="paragraph"><p>Protocols:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1 -</p> +</ul> +<p>Protocols:</p> +<ul><li><a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1 </li> -<li> -<p> -<a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2 -</p> +<li><a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2 </li> -<li> -<p> -<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket -</p> +<li><a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket </li> -</ul></div> -<div class="paragraph"><p>Handlers:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="cowboy_static">cowboy_static(3)</a> - Static file handler -</p> +</ul> +<p>Handlers:</p> +<ul><li><a href="cowboy_static">cowboy_static(3)</a> - Static file handler </li> -</ul></div> -<div class="paragraph"><p>Behaviors:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers -</p> +</ul> +<p>Behaviors:</p> +<ul><li><a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers </li> -<li> -<p> -<a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers -</p> +<li><a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers </li> -<li> -<p> -<a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares -</p> +<li><a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares </li> -<li> -<p> -<a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers -</p> +<li><a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers </li> -<li> -<p> -<a href="cowboy_stream">cowboy_stream(3)</a> - Stream handlers -</p> +<li><a href="cowboy_stream">cowboy_stream(3)</a> - Stream handlers </li> -<li> -<p> -<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers -</p> +<li><a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers </li> -</ul></div> -<div class="paragraph"><p>Middlewares:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="cowboy_router">cowboy_router(3)</a> - Router middleware -</p> +</ul> +<p>Middlewares:</p> +<ul><li><a href="cowboy_router">cowboy_router(3)</a> - Router middleware </li> -<li> -<p> -<a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware -</p> +<li><a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> +<!-- @todo http_status_codes is not linked to; what to do with it?--> <h2 id="_dependencies">Dependencies</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="ranch_app">ranch(7)</a> - Socket acceptor pool for TCP protocols -</p> +<ul><li><a href="ranch_app">ranch(7)</a> - Socket acceptor pool for TCP protocols </li> -<li> -<p> -<a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols -</p> +<li><a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols </li> -<li> -<p> -ssl - Secure communication over sockets -</p> +<li>ssl - Secure communication over sockets </li> -<li> -<p> -crypto - Crypto functions -</p> +<li>crypto - Crypto functions </li> -</ul></div> -<div class="paragraph"><p>All these applications must be started before the <code>cowboy</code> -application. To start Cowboy and all dependencies at once:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +</ul> +<p>All these applications must be started before the <code>cowboy</code> application. To start Cowboy and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>{<span style="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">cowboy</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">cowboy</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_environment">Environment</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>cowboy</code> application does not define any application -environment configuration parameters.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <code>cowboy</code> application does not define any application environment configuration parameters.</p> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="ranch_app">ranch(7)</a>, -<a href="cowlib_app">cowlib(7)</a></p></div> -</div> -</div> +<p><a href="ranch_app">ranch(7)</a>, <a href="cowlib_app">cowlib(7)</a></p> + |