|
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<title>Nine Nines: cowboy_router(3)</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=7" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>cowboy_router(3)</span></h1>
<h2 id="_name">Name</h2>
<p>cowboy_router - Router middleware</p>
<h2 id="_description">Description</h2>
<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. The environment can contain the rules directly or a tuple <code>{persistent_term, Key}</code>, in which case Cowboy will call <code>persistent_term:get(Key)</code> to retrieve the dispatch rules.</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>
<ul><li><a href="../cowboy_router.compile">cowboy_router:compile(3)</a> - Compile routes to the resources
</li>
</ul>
<h2 id="_types">Types</h2>
<h3 id="_bindings">bindings()</h3>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<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>
<p>Opaque type containing the compiled routes.</p>
<h3 id="_routes">routes()</h3>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<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>}
]
<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>}
]
<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 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<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>
<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 class="span3 sidecol">
<h3>
Cowboy
2.7
Function Reference
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.7/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.7/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li>
<li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li>
<li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li>
<li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li>
<li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li>
<li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li>
</ul>
<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|