diff options
Diffstat (limited to 'docs/en/cowboy/2.3/manual/cowboy_router')
-rw-r--r-- | docs/en/cowboy/2.3/manual/cowboy_router/index.html | 117 |
1 files changed, 36 insertions, 81 deletions
diff --git a/docs/en/cowboy/2.3/manual/cowboy_router/index.html b/docs/en/cowboy/2.3/manual/cowboy_router/index.html index dae2a362..a5895995 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_router/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_router/index.html @@ -62,110 +62,65 @@ <h1 class="lined-header"><span>cowboy_router(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>cowboy_router - Router middleware</p></div> -</div> -</div> -<div class="sect1"> +<p>cowboy_router - Router middleware</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>cowboy_router</code> middleware maps the requested host and -path to the handler to be used for processing the request.</p></div> -<div class="paragraph"><p>The router takes the <code>dispatch</code> rules as input from the -middleware environment. Dispatch rules are generated by -calling the -<a href="../cowboy_router.compile">cowboy_router:compile(3)</a> -function.</p></div> -<div class="paragraph"><p>When a route matches, the router sets the <code>handler</code> and -<code>handler_opts</code> middleware environment values containing -the handler module and initial state, respectively.</p></div> -<div class="paragraph"><p>The router will stop execution when no route matches. -It will send a 400 response if no host was found, and -a 404 response otherwise.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <code>cowboy_router</code> middleware maps the requested host and path to the handler to be used for processing the request.</p> +<p>The router takes the <code>dispatch</code> rules as input from the middleware environment. Dispatch rules are generated by calling the <a href="../cowboy_router.compile">cowboy_router:compile(3)</a> function.</p> +<p>When a route matches, the router sets the <code>handler</code> and <code>handler_opts</code> middleware environment values containing the handler module and initial state, respectively.</p> +<p>The router will stop execution when no route matches. It will send a 400 response if no host was found, and a 404 response otherwise.</p> <h2 id="_exports">Exports</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="../cowboy_router.compile">cowboy_router:compile(3)</a> - Compile routes to the resources -</p> +<ul><li><a href="../cowboy_router.compile">cowboy_router:compile(3)</a> - Compile routes to the resources </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_types">Types</h2> -<div class="sectionbody"> -<div class="sect2"> <h3 id="_bindings">bindings()</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">bindings</span></span>() <span style="color: #990000">::</span> #{<span style="font-weight: bold"><span style="color: #000080">atom</span></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>Bindings found during routing.</p></div> -</div> -<div class="sect2"> +<pre><tt><b><font color="#000000">bindings</font></b>() <font color="#990000">::</font> #{<b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">any</font></b>()}</tt></pre> +</div></div> +<p>Bindings found during routing.</p> <h3 id="_dispatch_rules">dispatch_rules()</h3> -<div class="paragraph"><p>Opaque type containing the compiled routes.</p></div> -</div> -<div class="sect2"> +<p>Opaque type containing the compiled routes.</p> <h3 id="_routes">routes()</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">routes</span></span>() <span style="color: #990000">=</span> [ - {<span style="color: #009900">Host</span>, <span style="color: #009900">PathList</span>} | - {<span style="color: #009900">Host</span>, <span style="color: #009900">Fields</span>, <span style="color: #009900">PathList</span>} +<pre><tt><b><font color="#000000">routes</font></b>() <font color="#990000">=</font> [ + {<font color="#009900">Host</font>, <font color="#009900">PathList</font>} | + {<font color="#009900">Host</font>, <font color="#009900">Fields</font>, <font color="#009900">PathList</font>} ] -<span style="color: #009900">PathList</span> <span style="color: #990000">::</span> [ - {<span style="color: #009900">Path</span>, <span style="color: #009900">Handler</span>, <span style="color: #009900">InitialState</span>} | - {<span style="color: #009900">Path</span>, <span style="color: #009900">Fields</span>, <span style="color: #009900">Handler</span>, <span style="color: #009900">InitialState</span>} +<font color="#009900">PathList</font> <font color="#990000">::</font> [ + {<font color="#009900">Path</font>, <font color="#009900">Handler</font>, <font color="#009900">InitialState</font>} | + {<font color="#009900">Path</font>, <font color="#009900">Fields</font>, <font color="#009900">Handler</font>, <font color="#009900">InitialState</font>} ] -<span style="color: #009900">Host</span> <span style="color: #990000">::</span> <span style="color: #FF6600">'_'</span> | <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="color: #FF6600">'_'</span> | <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Fields</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">cowboy:fields</span></span>() -<span style="color: #009900">Handler</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">module</span></span>() -<span style="color: #009900">InitialState</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>Human readable list of routes to handlers.</p></div> -<div class="paragraph"><p>Cowboy uses this list to map hosts and paths, optionally -augmented with constraints applied to the bindings, to -handler modules.</p></div> -<div class="paragraph"><p>The syntax for routes is currently defined in the user guide.</p></div> -</div> -<div class="sect2"> +<font color="#009900">Host</font> <font color="#990000">::</font> <font color="#FF6600">'_'</font> | <b><font color="#000000">iodata</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <font color="#FF6600">'_'</font> | <b><font color="#000000">iodata</font></b>() +<font color="#009900">Fields</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:fields</font></b>() +<font color="#009900">Handler</font> <font color="#990000">::</font> <b><font color="#000000">module</font></b>() +<font color="#009900">InitialState</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Human readable list of routes to handlers.</p> +<p>Cowboy uses this list to map hosts and paths, optionally augmented with constraints applied to the bindings, to handler modules.</p> +<p>The syntax for routes is currently defined in the user guide.</p> +<!-- @todo The syntax should probably be in this module,--> +<!-- and the user guide show more practical examples.--> <h3 id="_tokens">tokens()</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">tokens</span></span>() <span style="color: #990000">::</span> [<span style="font-weight: bold"><span style="color: #000080">binary</span></span>()]</tt></pre></div></div> -<div class="paragraph"><p>List of <code>host_info</code> and <code>path_info</code> tokens that were found -using the <code>...</code> syntax.</p></div> -</div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">tokens</font></b>() <font color="#990000">::</font> [<b><font color="#000080">binary</font></b>()]</tt></pre> +</div></div> +<p>List of <code>host_info</code> and <code>path_info</code> tokens that were found using the <code>...</code> syntax.</p> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="..">cowboy(7)</a>, -<a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, -<a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, -<a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>, -<a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a></p></div> -</div> -</div> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_req.binding">cowboy_req:binding(3)</a>, <a href="../cowboy_req.bindings">cowboy_req:bindings(3)</a>, <a href="../cowboy_req.host_info">cowboy_req:host_info(3)</a>, <a href="../cowboy_req.path_info">cowboy_req:path_info(3)</a></p> + |