blob: 7a60003a9b06a87598b357d12d8b130c994fb0d9 (
plain) (
tree)
|
|
<!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">
<meta name="generator" content="Hugo 0.16" />
<title>Nine Nines: cowboy_router(3)</title>
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/99s.css" 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="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></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>
<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">
<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.
It uses the dispatch rules compiled from the routes given
to the <code>compile/1</code> function for this purpose. It adds the
handler name and options to the environment as the values
<code>handler</code> and <code>handler_opts</code> respectively.</p></div>
<div class="sect2">
<h3 id="_environment_input">Environment input</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
dispatch = dispatch_rules()
</dt>
<dd>
<p>
Dispatch table.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_environment_output">Environment output</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
handler = module()
</dt>
<dd>
<p>
Handler module.
</p>
</dd>
<dt class="hdlist1">
handler_opts = any()
</dt>
<dd>
<p>
Handler options.
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_types">Types</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_bindings_atom_binary">bindings() = [{atom(), binary()}]</h3>
<div class="paragraph"><p>List of bindings found during routing.</p></div>
</div>
<div class="sect2">
<h3 id="_dispatch_rules_opaque_to_the_user">dispatch_rules() - opaque to the user</h3>
<div class="paragraph"><p>Rules for dispatching request used by Cowboy.</p></div>
</div>
<div class="sect2">
<h3 id="_routes_host_paths_host_cowboy_fields_paths">routes() = [{Host, Paths} | {Host, cowboy:fields(), Paths}]</h3>
<div class="paragraph"><p>With types:</p></div>
<div class="ulist"><ul>
<li>
<p>
Host = Path = <em>_</em> | iodata()
</p>
</li>
<li>
<p>
Paths = [{Path, Handler, Opts} | {Path, cowboy:fields(), Handler, HandlerOpts}]
</p>
</li>
<li>
<p>
Handler = module()
</p>
</li>
<li>
<p>
HandlerOpts = any()
</p>
</li>
</ul></div>
<div class="paragraph"><p>Human readable list of routes mapping hosts and paths to handlers.</p></div>
<div class="paragraph"><p>The syntax for routes is defined in the user guide.</p></div>
</div>
<div class="sect2">
<h3 id="_tokens_binary">tokens() = [binary()]</h3>
<div class="paragraph"><p>List of host_info and path_info tokens found during routing.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_exports">Exports</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_compile_routes_8594_dispatch_rules">compile(routes()) → dispatch_rules()</h3>
<div class="paragraph"><p>Compile the routes for use by Cowboy.</p></div>
</div>
</div>
</div>
</div>
<div class="span3 sidecol">
<h3>
Cowboy
2.0
Function Reference
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.0/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.0/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li>
<li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li>
</ul>
</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-2016</p>
</div>
</div>
</div>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script src="/js/bootstrap-carousel.js"></script>
<script src="/js/bootstrap-dropdown.js"></script>
<script src="/js/custom.js"></script>
</body>
</html>
|
