diff options
author | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
commit | 92b54aacc0de5446dd5497c39897b0bbff72e626 (patch) | |
tree | c3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/cowboy/2.3/manual/cowboy/index.html | |
parent | 8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff) | |
download | ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2 ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip |
Rebuild using Asciideck
Diffstat (limited to 'docs/en/cowboy/2.3/manual/cowboy/index.html')
-rw-r--r-- | docs/en/cowboy/2.3/manual/cowboy/index.html | 135 |
1 files changed, 41 insertions, 94 deletions
diff --git a/docs/en/cowboy/2.3/manual/cowboy/index.html b/docs/en/cowboy/2.3/manual/cowboy/index.html index 0b551dfa..9ea56c9e 100644 --- a/docs/en/cowboy/2.3/manual/cowboy/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy/index.html @@ -62,129 +62,76 @@ <h1 class="lined-header"><span>cowboy(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>cowboy - HTTP server</p></div> -</div> -</div> -<div class="sect1"> +<p>cowboy - HTTP server</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The module <code>cowboy</code> provides convenience functions for -manipulating Ranch listeners.</p></div> -</div> -</div> -<div class="sect1"> +<p>The module <code>cowboy</code> provides convenience functions for manipulating Ranch listeners.</p> <h2 id="_exports">Exports</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="../cowboy.start_clear">cowboy:start_clear(3)</a> - Listen for connections using plain TCP -</p> +<ul><li><a href="../cowboy.start_clear">cowboy:start_clear(3)</a> - Listen for connections using plain TCP </li> -<li> -<p> -<a href="../cowboy.start_tls">cowboy:start_tls(3)</a> - Listen for connections using TLS -</p> +<li><a href="../cowboy.start_tls">cowboy:start_tls(3)</a> - Listen for connections using TLS </li> -<li> -<p> -<a href="../cowboy.stop_listener">cowboy:stop_listener(3)</a> - Stop the given listener -</p> +<li><a href="../cowboy.stop_listener">cowboy:stop_listener(3)</a> - Stop the given listener </li> -<li> -<p> -<a href="../cowboy.set_env">cowboy:set_env(3)</a> - Update a listener’s environment value -</p> +<li><a href="../cowboy.set_env">cowboy:set_env(3)</a> - Update a listener's environment value </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_types">Types</h2> -<div class="sectionbody"> -<div class="sect2"> <h3 id="_fields">fields()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="font-weight: bold"><span style="color: #000000">fields</span></span>() <span style="color: #990000">::</span> [<span style="color: #009900">Name</span> - | {<span style="color: #009900">Name</span>, <span style="color: #009900">Constraints</span>} - | {<span style="color: #009900">Name</span>, <span style="color: #009900">Constraints</span>, <span style="color: #009900">Default</span>}] - -<span style="color: #009900">Name</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">atom</span></span>() -<span style="color: #009900">Constraints</span> <span style="color: #990000">::</span> <span style="color: #009900">Constraint</span> | [<span style="color: #009900">Constraint</span>] -<span style="color: #009900">Constraint</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">cowboy_constraints:constraint</span></span>() -<span style="color: #009900">Default</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">any</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Fields description for match operations.</p></div> -<div class="paragraph"><p>This type is used in <a href="../cowboy_router">cowboy_router(3)</a> -for matching bindings and in the match functions found in -<a href="../cowboy_req">cowboy_req(3)</a>.</p></div> -</div> -<div class="sect2"> +<pre><tt><b><font color="#000000">fields</font></b>() <font color="#990000">::</font> [<font color="#009900">Name</font> + | {<font color="#009900">Name</font>, <font color="#009900">Constraints</font>} + | {<font color="#009900">Name</font>, <font color="#009900">Constraints</font>, <font color="#009900">Default</font>}] + +<font color="#009900">Name</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>() +<font color="#009900">Constraints</font> <font color="#990000">::</font> <font color="#009900">Constraint</font> | [<font color="#009900">Constraint</font>] +<font color="#009900">Constraint</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_constraints:constraint</font></b>() +<font color="#009900">Default</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Fields description for match operations.</p> +<p>This type is used in <a href="../cowboy_router">cowboy_router(3)</a> for matching bindings and in the match functions found in <a href="../cowboy_req">cowboy_req(3)</a>.</p> <h3 id="_http_headers">http_headers()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="font-weight: bold"><span style="color: #000000">http_headers</span></span>() <span style="color: #990000">::</span> #{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>() <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}</tt></pre></div></div> -<div class="paragraph"><p>HTTP headers.</p></div> -</div> -<div class="sect2"> +<pre><tt><b><font color="#000000">http_headers</font></b>() <font color="#990000">::</font> #{<b><font color="#000080">binary</font></b>() <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>HTTP headers.</p> <h3 id="_http_status">http_status()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="font-weight: bold"><span style="color: #000000">http_status</span></span>() <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>() | <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>HTTP response status.</p></div> -<div class="paragraph"><p>A binary status can be used to set a reason phrase. Note -however that HTTP/2 only sends the status code and drops -the reason phrase entirely.</p></div> -</div> -<div class="sect2"> +<pre><tt><b><font color="#000000">http_status</font></b>() <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() | <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>HTTP response status.</p> +<p>A binary status can be used to set a reason phrase. Note however that HTTP/2 only sends the status code and drops the reason phrase entirely.</p> <h3 id="_http_version">http_version()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="font-weight: bold"><span style="color: #000000">http_version</span></span>() <span style="color: #990000">::</span> <span style="color: #FF6600">'HTTP/2'</span> | <span style="color: #FF6600">'HTTP/1.1'</span> | <span style="color: #FF6600">'HTTP/1.0'</span></tt></pre></div></div> -<div class="paragraph"><p>HTTP version.</p></div> -<div class="paragraph"><p>Note that semantically, HTTP/1.1 and HTTP/2 are equivalent.</p></div> -</div> -<div class="sect2"> +<pre><tt><b><font color="#000000">http_version</font></b>() <font color="#990000">::</font> <font color="#FF6600">'HTTP/2'</font> | <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font></tt></pre> +</div></div> +<p>HTTP version.</p> +<p>Note that semantically, HTTP/1.1 and HTTP/2 are equivalent.</p> <h3 id="_opts">opts()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="font-weight: bold"><span style="color: #000000">opts</span></span>() <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">map</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Options for the HTTP/1.1, HTTP/2 and Websocket protocols.</p></div> -<div class="paragraph"><p>The protocol options are in a map containing all the options for -the different protocols that may be involved when connecting -to the listener, including HTTP/1.1 and HTTP/2.</p></div> -<div class="paragraph"><p>The HTTP/1.1 options are documented in the -<a href="../cowboy_http">cowboy_http(3)</a> manual -and the HTTP/2 options in -<a href="../cowboy_http2">cowboy_http2(3)</a>.</p></div> -</div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> <b><font color="#000000">map</font></b>()</tt></pre> +</div></div> +<p>Options for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>The protocol options are in a map containing all the options for the different protocols that may be involved when connecting to the listener, including HTTP/1.1 and HTTP/2.</p> +<p>The HTTP/1.1 options are documented in the <a href="../cowboy_http">cowboy_http(3)</a> manual and the HTTP/2 options in <a href="../cowboy_http2">cowboy_http2(3)</a>.</p> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="..">cowboy(7)</a>, -<a href="../ranch">ranch(3)</a></p></div> -</div> -</div> +<p><a href="..">cowboy(7)</a>, <a href="../ranch">ranch(3)</a></p> + |