diff options
| author | Loïc Hoguin <[email protected]> | 2019-07-18 09:59:28 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2019-07-18 10:08:46 +0200 |
| commit | 136d443b5c38bee96f5d995dfea3629ef07564c3 (patch) | |
| tree | 1d31540baebc43ca0b2dceeda212c44f5da7e7a8 /_build/static/docs/en/cowboy/1.0/manual | |
| parent | e031713c0e8bd871248dbbbbdec1ea28609f4431 (diff) | |
| download | ninenines.eu-136d443b5c38bee96f5d995dfea3629ef07564c3.tar.gz ninenines.eu-136d443b5c38bee96f5d995dfea3629ef07564c3.tar.bz2 ninenines.eu-136d443b5c38bee96f5d995dfea3629ef07564c3.zip | |
Announce Ranch 2.0.0-rc.1
Adds Ranch 2.0 documentation and removes documentation for
very old Cowboy and Ranch, along with Erlang.mk documentation
which is available on its own website.
Diffstat (limited to '_build/static/docs/en/cowboy/1.0/manual')
17 files changed, 0 insertions, 4982 deletions
diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy/index.html deleted file mode 100644 index e4ca1e2c..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy/index.html +++ /dev/null @@ -1,273 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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</span></h1> - -<p>The <code>cowboy</code> module provides convenience functions for manipulating Ranch listeners.</p> - -<h2 id="types">Types</h2> - -<h3 id="http_headers">http_headers() = [{binary(), iodata()}]</h3> - -<p>HTTP headers as a list of key/values.</p> - -<h3 id="http_status">http_status() = non_neg_integer() | binary()</h3> - -<p>HTTP status.</p> - -<p>A binary status can be used to set a custom message.</p> - -<h3 id="http_version">http_version() = 'HTTP/1.1' | 'HTTP/1.0'</h3> - -<p>HTTP version.</p> - -<h3 id="onrequest_fun">onrequest_fun() = fun((cowboy_req:req()) -> cowboy_req:req())</h3> - -<p>Fun called immediately after receiving a request.</p> - -<p>It can perform any operation on the Req object, including reading the request body or replying. If a reply is sent, the processing of the request ends here, before any middleware is executed.</p> - -<h3 id="onresponse_fun">onresponse_fun() = fun((http_status(), http_headers(), iodata(), cowboy_req:req()) -> cowboy_req:req())</h3> - -<p>Fun called immediately before sending the response.</p> - -<p>It can perform any operation on the Req object, including reading the request body or replying. If a reply is sent, it overrides the reply initially sent. The callback will not be called again for the new reply.</p> - -<h2 id="exports">Exports</h2> - -<h3 id="start_http">start_http(Ref, NbAcceptors, TransOpts, ProtoOpts) -> {ok, pid()}</h3> - -<p>Types:</p> - -<ul> -<li>Ref = ranch:ref()</li> -<li>NbAcceptors = non_neg_integer()</li> -<li>TransOpts = ranch_tcp:opts()</li> -<li>ProtoOpts = cowboy_protocol:opts()</li> -</ul> - -<p>Start listening for HTTP connections. Returns the pid for this listener's supervisor.</p> - -<h3 id="start_https">start_https(Ref, NbAcceptors, TransOpts, ProtoOpts) -> {ok, pid()}</h3> - -<p>Types:</p> - -<ul> -<li>Ref = ranch:ref()</li> -<li>NbAcceptors = non_neg_integer()</li> -<li>TransOpts = ranch_ssl:opts()</li> -<li>ProtoOpts = cowboy_protocol:opts()</li> -</ul> - -<p>Start listening for HTTPS connections. Returns the pid for this listener's supervisor.</p> - -<h3 id="start_spdy">start_spdy(Ref, NbAcceptors, TransOpts, ProtoOpts) -> {ok, pid()}</h3> - -<p>Types:</p> - -<ul> -<li>Ref = ranch:ref()</li> -<li>NbAcceptors = non_neg_integer()</li> -<li>TransOpts = ranch_ssl:opts()</li> -<li>ProtoOpts = cowboy_spdy:opts()</li> -</ul> - -<p>Start listening for SPDY connections. Returns the pid for this listener's supervisor.</p> - -<h3 id="stop_listener">stop_listener(Ref) -> ok | {error, not_found}</h3> - -<p>Types:</p> - -<ul> -<li>Ref = ranch:ref()</li> -</ul> - -<p>Stop a previously started listener.</p> - -<h3 id="set_env">set_env(Ref, Name, Value) -> ok</h3> - -<p>Types:</p> - -<ul> -<li>Ref = ranch:ref()</li> -<li>Name = atom()</li> -<li>Value = any()</li> -</ul> - -<p>Set or update an environment value for an already running listener. This will take effect on all subsequent connections.</p> - -<h2 id="see_also">See also</h2> - -<p>The <a href="http://ninenines.eu/docs/en/ranch/HEAD/guide">Ranch guide</a> provides detailed information about how listeners work.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_app/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_app/index.html deleted file mode 100644 index 66b266f5..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_app/index.html +++ /dev/null @@ -1,188 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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>The Cowboy Application</span></h1> - -<p>Small, fast, modular HTTP server.</p> - -<h2 id="dependencies">Dependencies</h2> - -<p>The <code>cowboy</code> application uses the Erlang applications <code>ranch</code> for listening and accepting TCP connections, <code>crypto</code> for establishing Websocket connections, and <code>cowlib</code> for parsing and building messages for Web protocols. These dependencies must be loaded for the <code>cowboy</code> application to work. In an embedded environment this means that they need to be started with the <code>application:start/{1,2}</code> function before the <code>cowboy</code> application is started.</p> - -<p>The <code>cowboy</code> application also uses the Erlang applications <code>asn1</code>, <code>public_key</code> and <code>ssl</code> when listening for HTTPS connections. These are started automatically if they weren't before.</p> - -<h2 id="environment">Environment</h2> - -<p>The <code>cowboy</code> application does not define any application environment configuration parameters.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_handler/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_handler/index.html deleted file mode 100644 index 8806c3cc..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_handler/index.html +++ /dev/null @@ -1,199 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_handler</span></h1> - -<p>The <code>cowboy_handler</code> middleware executes the handler passed through the environment values <code>handler</code> and <code>handler_opts</code>, and adds the result of this execution to the environment as the value <code>result</code>, indicating that the request has been handled and received a response.</p> - -<p>Environment input:</p> - -<ul> -<li>handler = module()</li> -<li>handler_opts = any()</li> -</ul> - -<p>Environment output:</p> - -<ul> -<li>result = ok</li> -</ul> - -<h2 id="types">Types</h2> - -<p>None.</p> - -<h2 id="exports">Exports</h2> - -<p>None.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_http_handler/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_http_handler/index.html deleted file mode 100644 index e257ebc2..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_http_handler/index.html +++ /dev/null @@ -1,229 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_http_handler</span></h1> - -<p>The <code>cowboy_http_handler</code> behaviour defines the interface used by plain HTTP handlers.</p> - -<p>Unless noted otherwise, the callbacks will be executed sequentially.</p> - -<h2 id="types">Types</h2> - -<p>None.</p> - -<h2 id="callbacks">Callbacks</h2> - -<h3 id="init">init({TransportName, ProtocolName}, Req, Opts) -> {ok, Req, State} | {shutdown, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>TransportName = tcp | ssl | atom()</li> -<li>ProtocolName = http | atom()</li> -<li>Req = cowboy_req:req()</li> -<li>Opts = any()</li> -<li>State = any()</li> -</ul> - -<p>Initialize the state for this request.</p> - -<p>The <code>shutdown</code> return value can be used to skip the <code>handle/2</code> call entirely.</p> - -<h3 id="handle">handle(Req, State) -> {ok, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -</ul> - -<p>Handle the request.</p> - -<p>This callback is where the request is handled and a response should be sent. If a response is not sent, Cowboy will send a <code>204 No Content</code> response automatically.</p> - -<h3 id="terminate">terminate(Reason, Req, State) -> ok</h3> - -<p>Types:</p> - -<ul> -<li>Reason = {normal, shutdown} | {error, atom()}</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -</ul> - -<p>Perform any necessary cleanup of the state.</p> - -<p>This callback should release any resource currently in use, clear any active timer and reset the process to its original state, as it might be reused for future requests sent on the same connection. Typical plain HTTP handlers rarely need to use it.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_loop_handler/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_loop_handler/index.html deleted file mode 100644 index 88b1c4ff..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_loop_handler/index.html +++ /dev/null @@ -1,245 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_loop_handler</span></h1> - -<p>The <code>cowboy_loop_handler</code> behaviour defines the interface used by HTTP handlers that do not send a response directly, instead requiring a receive loop to process Erlang messages.</p> - -<p>This interface is best fit for long-polling types of requests.</p> - -<p>The <code>init/3</code> callback will always be called, followed by zero or more calls to <code>info/3</code>. The <code>terminate/3</code> callback will always be called last.</p> - -<h2 id="types">Types</h2> - -<p>None.</p> - -<h2 id="callbacks">Callbacks</h2> - -<h3 id="init">init({TransportName, ProtocolName}, Req, Opts) -> {loop, Req, State} | {loop, Req, State, hibernate} | {loop, Req, State, Timeout} | {loop, Req, State, Timeout, hibernate} | {shutdown, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>TransportName = tcp | ssl | atom()</li> -<li>ProtocolName = http | atom()</li> -<li>Req = cowboy_req:req()</li> -<li>Opts = any()</li> -<li>State = any()</li> -<li>Timeout = timeout()</li> -</ul> - -<p>Initialize the state for this request.</p> - -<p>This callback will typically be used to register this process to an event manager or a message queue in order to receive the messages the handler wants to process.</p> - -<p>The receive loop will run for a duration of up to <code>Timeout</code> milliseconds after it last received data from the socket, at which point it will stop and send a <code>204 No Content</code> reply. By default this value is set to <code>infinity</code>. It is recommended to either set this value or ensure by any other mechanism that the handler will be closed after a certain period of inactivity.</p> - -<p>The <code>hibernate</code> option will hibernate the process until it starts receiving messages.</p> - -<p>The <code>shutdown</code> return value can be used to skip the receive loop entirely.</p> - -<h3 id="info">info(Info, Req, State) -> {ok, Req, State} | {loop, Req, State} | {loop, Req, State, hibernate}</h3> - -<p>Types:</p> - -<ul> -<li>Info = any()</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -</ul> - -<p>Handle the Erlang message received.</p> - -<p>This function will be called every time an Erlang message has been received. The message can be any Erlang term.</p> - -<p>The <code>ok</code> return value can be used to stop the receive loop, typically because a response has been sent.</p> - -<p>The <code>hibernate</code> option will hibernate the process until it receives another message.</p> - -<h3 id="terminate">terminate(Reason, Req, State) -> ok</h3> - -<p>Types:</p> - -<ul> -<li>Reason = {normal, shutdown} | {normal, timeout} | {error, closed} | {error, overflow} | {error, atom()}</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -</ul> - -<p>Perform any necessary cleanup of the state.</p> - -<p>This callback will typically unregister from any event manager or message queue it registered to in <code>init/3</code>.</p> - -<p>This callback should release any resource currently in use, clear any active timer and reset the process to its original state, as it might be reused for future requests sent on the same connection.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_middleware/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_middleware/index.html deleted file mode 100644 index 6e0f87a3..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_middleware/index.html +++ /dev/null @@ -1,213 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_middleware</span></h1> - -<p>The <code>cowboy_middleware</code> behaviour defines the interface used by Cowboy middleware modules.</p> - -<p>Middlewares process the request sequentially in the order they are configured.</p> - -<h2 id="types">Types</h2> - -<h3 id="env">env() = [{atom(), any()}]</h3> - -<p>The environment variable.</p> - -<p>One is created for every request. It is passed to each middleware module executed and subsequently returned, optionally with its contents modified.</p> - -<h2 id="callbacks">Callbacks</h2> - -<h3 id="execute">execute(Req, Env) -> {ok, Req, Env} | {suspend, Module, Function, Args} | {halt, Req} | {error, StatusCode, Req}</h3> - -<p>Types:</p> - -<ul> -<li>Req = cowboy_req:req()</li> -<li>Env = env()</li> -<li>Module = module()</li> -<li>Function = atom()</li> -<li>Args = [any()]</li> -<li>StatusCode = cowboy:http_status()</li> -</ul> - -<p>Execute the middleware.</p> - -<p>The <code>ok</code> return value indicates that everything went well and that Cowboy should continue processing the request. A response may or may not have been sent.</p> - -<p>The <code>suspend</code> return value will hibernate the process until an Erlang message is received. Note that when resuming, any previous stacktrace information will be gone.</p> - -<p>The <code>halt</code> return value stops Cowboy from doing any further processing of the request, even if there are middlewares that haven't been executed yet. The connection may be left open to receive more requests from the client.</p> - -<p>The <code>error</code> return value sends an error response identified by the <code>StatusCode</code> and then proceeds to terminate the connection. Middlewares that haven't been executed yet will not be called.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_protocol/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_protocol/index.html deleted file mode 100644 index 83622ba3..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_protocol/index.html +++ /dev/null @@ -1,244 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_protocol</span></h1> - -<p>The <code>cowboy_protocol</code> module implements HTTP/1.1 and HTTP/1.0 as a Ranch protocol.</p> - -<h2 id="types">Types</h2> - -<h3 id="opts">opts() = [{compress, boolean()} | {env, cowboy_middleware:env()} | {max_empty_lines, non_neg_integer()} | {max_header_name_length, non_neg_integer()} | {max_header_value_length, non_neg_integer()} | {max_headers, non_neg_integer()} | {max_keepalive, non_neg_integer()} | {max_request_line_length, non_neg_integer()} | {middlewares, [module()]} | {onrequest, cowboy:onrequest_fun()} | {onresponse, cowboy:onresponse_fun()} | {timeout, timeout()}]</h3> - -<p>Configuration for the HTTP protocol handler.</p> - -<p>This configuration is passed to Cowboy when starting listeners using <code>cowboy:start_http/4</code> or <code>cowboy:start_https/4</code> functions.</p> - -<p>It can be updated without restarting listeners using the Ranch functions <code>ranch:get_protocol_options/1</code> and <code>ranch:set_protocol_options/2</code>.</p> - -<h2 id="option_descriptions">Option descriptions</h2> - -<p>The default value is given next to the option name.</p> - -<h3 id="compress ">compress (false)</h3> - -<p>When enabled, Cowboy will attempt to compress the response body.</p> - -<h3 id="env ">env ([{listener, Ref}])</h3> - -<p>Initial middleware environment.</p> - -<h3 id="max_empty_lines ">max_empty_lines (5)</h3> - -<p>Maximum number of empty lines before a request.</p> - -<h3 id="max_header_name_length ">max_header_name_length (64)</h3> - -<p>Maximum length of header names.</p> - -<h3 id="max_header_value_length ">max_header_value_length (4096)</h3> - -<p>Maximum length of header values.</p> - -<h3 id="max_headers ">max_headers (100)</h3> - -<p>Maximum number of headers allowed per request.</p> - -<h3 id="max_keepalive ">max_keepalive (100)</h3> - -<p>Maximum number of requests allowed per connection.</p> - -<h3 id="max_request_line_length ">max_request_line_length (4096)</h3> - -<p>Maximum length of the request line.</p> - -<h3 id="middlewares ">middlewares ([cowboy_router, cowboy_handler])</h3> - -<p>List of middlewares to execute for every requests.</p> - -<h3 id="onrequest ">onrequest (undefined)</h3> - -<p>Fun called every time a request is received.</p> - -<h3 id="onresponse ">onresponse (undefined)</h3> - -<p>Fun called every time a response is sent.</p> - -<h3 id="timeout ">timeout (5000)</h3> - -<p>Time in ms with no requests before Cowboy closes the connection.</p> - -<h2 id="exports">Exports</h2> - -<p>None.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_req/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_req/index.html deleted file mode 100644 index a7cb0708..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_req/index.html +++ /dev/null @@ -1,854 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_req</span></h1> - -<p>The <code>cowboy_req</code> module provides functions to access, manipulate and respond to requests.</p> - -<p>The functions in this module follow patterns for their return types, based on the kind of function.</p> - -<ul> -<li>access: <code>{Value, Req}</code></li> -<li>action: <code>{Result, Req} | {Result, Value, Req} | {error, atom()}</code></li> -<li>modification: <code>Req</code></li> -<li>question: <code>boolean()</code></li> -</ul> - -<p>The only exception is the <code>chunk/2</code> function which may return <code>ok</code>.</p> - -<p>Whenever <code>Req</code> is returned, you must use this returned value and ignore any previous you may have had. This value contains various state informations which are necessary for Cowboy to do some lazy evaluation or cache results where appropriate.</p> - -<p>All functions which perform an action should only be called once. This includes reading the request body or replying. Cowboy will generally throw an error on the second call.</p> - -<p>It is highly discouraged to pass the Req object to another process. Doing so and calling <code>cowboy_req</code> functions from it leads to undefined behavior.</p> - -<h2 id="types">Types</h2> - -<h3 id="body_opts">body_opts() = [{continue, boolean()} | {length, non_neg_integer()} | {read_length, non_neg_integer()} | {read_timeout, timeout()} | {transfer_decode, transfer_decode_fun(), any()} | {content_decode, content_decode_fun()}]</h3> - -<p>Request body reading options.</p> - -<h3 id="cookie_opts">cookie_opts() = [{max_age, non_neg_integer()} | {domain, binary()} | {path, binary()} | {secure, boolean()} | {http_only, boolean()}]</h3> - -<p>Cookie options.</p> - -<h3 id="req">req() - opaque to the user</h3> - -<p>The Req object.</p> - -<p>All functions in this module receive a <code>Req</code> as argument, and most of them return a new object labelled <code>Req2</code> in the function descriptions below.</p> - -<h2 id="request_related_exports">Request related exports</h2> - -<h3 id="binding">binding(Name, Req) -> binding(Name, Req, undefined)</h3> - -<h3 id="binding">binding(Name, Req, Default) -> {Value, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = atom()</li> -<li>Default = any()</li> -<li>Value = any() | Default</li> -</ul> - -<p>Return the value for the given binding.</p> - -<p>By default the value is a binary, however constraints may change the type of this value (for example automatically converting numbers to integer).</p> - -<h3 id="bindings">bindings(Req) -> {[{Name, Value}], Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = atom()</li> -<li>Value = any()</li> -</ul> - -<p>Return all bindings.</p> - -<p>By default the value is a binary, however constraints may change the type of this value (for example automatically converting numbers to integer).</p> - -<h3 id="cookie">cookie(Name, Req) -> cookie(Name, Req, undefined)</h3> - -<h3 id="cookie">cookie(Name, Req, Default) -> {Value, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Default = any()</li> -<li>Value = binary() | Default</li> -</ul> - -<p>Return the value for the given cookie.</p> - -<p>Cookie names are case sensitive.</p> - -<h3 id="cookies">cookies(Req) -> {[{Name, Value}], Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Value = binary()</li> -</ul> - -<p>Return all cookies.</p> - -<h3 id="header">header(Name, Req) -> header(Name, Req, undefined)</h3> - -<h3 id="header">header(Name, Req, Default) -> {Value, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Default = any()</li> -<li>Value = binary() | Default</li> -</ul> - -<p>Return the value for the given header.</p> - -<p>While header names are case insensitive, this function expects the name to be a lowercase binary.</p> - -<h3 id="headers">headers(Req) -> {Headers, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Headers = cowboy:http_headers()</li> -</ul> - -<p>Return all headers.</p> - -<h3 id="host">host(Req) -> {Host, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Host = binary()</li> -</ul> - -<p>Return the requested host.</p> - -<h3 id="host_info">host_info(Req) -> {HostInfo, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>HostInfo = cowboy_router:tokens() | undefined</li> -</ul> - -<p>Return the extra tokens from matching against <code>...</code> during routing.</p> - -<h3 id="host_url">host_url(Req) -> {HostURL, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>HostURL = binary() | undefined</li> -</ul> - -<p>Return the requested URL excluding the path component.</p> - -<p>This function will always return <code>undefined</code> until the <code>cowboy_router</code> middleware has been executed. This includes the <code>onrequest</code> hook.</p> - -<h3 id="meta">meta(Name, Req) -> meta(Name, Req, undefined)</h3> - -<h3 id="meta">meta(Name, Req, Default) -> {Value, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = atom()</li> -<li>Default = any()</li> -<li>Value = any()</li> -</ul> - -<p>Return metadata about the request.</p> - -<h3 id="method">method(Req) -> {Method, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Method = binary()</li> -</ul> - -<p>Return the method.</p> - -<p>Methods are case sensitive. Standard methods are always uppercase.</p> - -<h3 id="parse_header">parse_header(Name, Req) -></h3> - -<h3 id="parse_header">parse_header(Name, Req, Default) -> {ok, ParsedValue, Req2} | {undefined, Value, Req2} | {error, badarg}</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Default = any()</li> -<li>ParsedValue - see below</li> -<li>Value = any()</li> -</ul> - -<p>Parse the given header.</p> - -<p>While header names are case insensitive, this function expects the name to be a lowercase binary.</p> - -<p>The <code>parse_header/2</code> function will call <code>parser_header/3</code> with a different default value depending on the header being parsed. The following table summarizes the default values used.</p> - -<table class="table-bordered table-condensed table-striped"> -<thead> -<tr><th>Header name</th><th>Default value</th></tr> -</thead> -<tbody> -<tr><td>transfer-encoding</td><td><code>[<<"identity">>]</code></td></tr> -<tr><td>Any other header</td><td><code>undefined</code></td></tr> -</tbody> -</table> - -<p>The parsed value differs depending on the header being parsed. The following table summarizes the different types returned.</p> - -<table class="table-bordered table-condensed table-striped"> -<thead> -<tr><th>Header name</th><th>Type</th></tr> -</thead> -<tbody> -<tr><td>accept</td><td><code>[{{Type, SubType, Params}, Quality, AcceptExt}]</code></td></tr> -<tr><td>accept-charset</td><td><code>[{Charset, Quality}]</code></td></tr> -<tr><td>accept-encoding</td><td><code>[{Encoding, Quality}]</code></td></tr> -<tr><td>accept-language</td><td><code>[{LanguageTag, Quality}]</code></td></tr> -<tr><td>authorization</td><td><code>{AuthType, Credentials}</code></td></tr> -<tr><td>content-length</td><td><code>non_neg_integer()</code></td></tr> -<tr><td>content-type</td><td><code>{Type, SubType, ContentTypeParams}</code></td></tr> -<tr><td>cookie</td><td><code>[{binary(), binary()}]</code></td></tr> -<tr><td>expect</td><td><code>[Expect | {Expect, ExpectValue, Params}]</code></td></tr> -<tr><td>if-match</td><td><code>'*' | [{weak | strong, OpaqueTag}]</code></td></tr> -<tr><td>if-modified-since</td><td><code>calendar:datetime()</code></td></tr> -<tr><td>if-none-match</td><td><code>'*' | [{weak | strong, OpaqueTag}]</code></td></tr> -<tr><td>if-unmodified-since</td><td><code>calendar:datetime()</code></td></tr> -<tr><td>range</td><td><code>{Unit, [Range]}</code></td></tr> -<tr><td>sec-websocket-protocol</td><td><code>[binary()]</code></td></tr> -<tr><td>transfer-encoding</td><td><code>[binary()]</code></td></tr> -<tr><td>upgrade</td><td><code>[binary()]</code></td></tr> -<tr><td>x-forwarded-for</td><td><code>[binary()]</code></td></tr> -</tbody> -</table> - -<p>Types for the above table:</p> - -<ul> -<li>Type = SubType = Charset = Encoding = LanguageTag = binary()</li> -<li>AuthType = Expect = OpaqueTag = Unit = binary()</li> -<li>Params = ContentTypeParams = [{binary(), binary()}]</li> -<li>Quality = 0..1000</li> -<li>AcceptExt = [{binary(), binary()} | binary()]</li> -<li>Credentials - see below</li> -<li>Range = {non_neg_integer(), non_neg_integer() | infinity} | neg_integer()</li> -</ul> - -<p>The cookie names and values, the values of the sec-websocket-protocol and x-forwarded-for headers, the values in <code>AcceptExt</code> and <code>Params</code>, the authorization <code>Credentials</code>, the <code>ExpectValue</code> and <code>OpaqueTag</code> are case sensitive. All values in <code>ContentTypeParams</code> are case sensitive except the value of the charset parameter, which is case insensitive. All other values are case insensitive and will be returned as lowercase.</p> - -<p>The headers accept, accept-encoding and cookie headers can return an empty list. Others will return <code>{error, badarg}</code> if the header value is empty.</p> - -<p>The authorization header parsing code currently only supports basic HTTP authentication. The <code>Credentials</code> type is thus <code>{Username, Password}</code> with <code>Username</code> and <code>Password</code> being <code>binary()</code>.</p> - -<p>The range header value <code>Range</code> can take three forms:</p> - -<ul> -<li><code>{From, To}</code>: from <code>From</code> to <code>To</code> units</li> -<li><code>{From, infinity}</code>: everything after <code>From</code> units</li> -<li><code>-Final</code>: the final <code>Final</code> units</li> -</ul> - -<p>An <code>undefined</code> tuple will be returned if Cowboy doesn't know how to parse the requested header.</p> - -<h3 id="path">path(Req) -> {Path, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Path = binary()</li> -</ul> - -<p>Return the requested path.</p> - -<h3 id="path_info">path_info(Req) -> {PathInfo, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>PathInfo = cowboy_router:tokens() | undefined</li> -</ul> - -<p>Return the extra tokens from matching against <code>...</code> during routing.</p> - -<h3 id="peer">peer(Req) -> {Peer, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Peer = {inet:ip_address(), inet:port_number()}</li> -</ul> - -<p>Return the client's IP address and port number.</p> - -<h3 id="port">port(Req) -> {Port, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Port = inet:port_number()</li> -</ul> - -<p>Return the request's port.</p> - -<p>The port returned by this function is obtained by parsing the host header. It may be different than the actual port the client used to connect to the Cowboy server.</p> - -<h3 id="qs">qs(Req) -> {QueryString, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>QueryString = binary()</li> -</ul> - -<p>Return the request's query string.</p> - -<h3 id="qs_val">qs_val(Name, Req) -> qs_val(Name, Req, undefined)</h3> - -<h3 id="qs_val">qs_val(Name, Req, Default) -> {Value, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Default = any()</li> -<li>Value = binary() | true</li> -</ul> - -<p>Return a value from the request's query string.</p> - -<p>The value <code>true</code> will be returned when the name was found in the query string without an associated value.</p> - -<h3 id="qs_vals">qs_vals(Req) -> {[{Name, Value}], Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Value = binary() | true</li> -</ul> - -<p>Return the request's query string as a list of tuples.</p> - -<p>The value <code>true</code> will be returned when a name was found in the query string without an associated value.</p> - -<h3 id="set_meta">set_meta(Name, Value, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Name = atom()</li> -<li>Value = any()</li> -</ul> - -<p>Set metadata about the request.</p> - -<p>An existing value will be overwritten.</p> - -<h3 id="url">url(Req) -> {URL, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>URL = binary() | undefined</li> -</ul> - -<p>Return the requested URL.</p> - -<p>This function will always return <code>undefined</code> until the <code>cowboy_router</code> middleware has been executed. This includes the <code>onrequest</code> hook.</p> - -<h3 id="version">version(Req) -> {Version, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Version = cowboy:http_version()</li> -</ul> - -<p>Return the HTTP version used for this request.</p> - -<h2 id="request_body_related_exports">Request body related exports</h2> - -<h3 id="body">body(Req) -> body(Req, [])</h3> - -<h3 id="body">body(Req, Opts) -> {ok, Data, Req2} | {more, Data, Req2} | {error, Reason}</h3> - -<p>Types:</p> - -<ul> -<li>Opts = [body_opt()]</li> -<li>Data = binary()</li> -<li>Reason = atom()</li> -</ul> - -<p>Read the request body.</p> - -<p>This function will read a chunk of the request body. If there is more data to be read after this function call, then a <code>more</code> tuple is returned. Otherwise an <code>ok</code> tuple is returned.</p> - -<p>Cowboy will automatically send a <code>100 Continue</code> reply if required. If this behavior is not desirable, it can be disabled by setting the <code>continue</code> option to <code>false</code>.</p> - -<p>Cowboy will by default attempt to read up to 8MB of the body, but in chunks of 1MB. It will use a timeout of 15s per chunk. All these values can be changed using the <code>length</code>, <code>read_length</code> and <code>read_timeout</code> options respectively. Note that the size of the data may not be the same as requested as the decoding functions may grow or shrink it, and Cowboy makes not attempt at returning an exact amount.</p> - -<p>Cowboy will properly handle chunked transfer-encoding by default. If any other transfer-encoding or content-encoding has been used for the request, custom decoding functions can be used. The <code>content_decode</code> and <code>transfer_decode</code> options allow setting the decode functions manually.</p> - -<p>After the body has been streamed fully, Cowboy will remove the transfer-encoding header from the Req object, and add the content-length header if it wasn't already there.</p> - -<p>This function can only be called once. Cowboy will not cache the result of this call.</p> - -<h3 id="body_length">body_length(Req) -> {Length, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Length = non_neg_integer() | undefined</li> -</ul> - -<p>Return the length of the request body.</p> - -<p>The length will only be returned if the request does not use any transfer-encoding and if the content-length header is present.</p> - -<h3 id="body_qs">body_qs(Req) -> body_qs(Req, [{length, 64000}, {read_length, 64000}, {read_timeout, 5000}])</h3> - -<h3 id="body_qs">body_qs(Req, Opts) -> {ok, [{Name, Value}], Req2} | {badlength, Req2} | {error, Reason}</h3> - -<p>Types:</p> - -<ul> -<li>Opts = [body_opt()]</li> -<li>Name = binary()</li> -<li>Value = binary() | true</li> -<li>Reason = chunked | badlength | atom()</li> -</ul> - -<p>Return the request body as a list of tuples.</p> - -<p>This function will parse the body assuming the content-type application/x-www-form-urlencoded, commonly used for the query string.</p> - -<p>This function calls <code>body/2</code> for reading the body, with the same options it received. By default it will attempt to read a body of 64KB in one chunk, with a timeout of 5s. If the body is larger then a <code>badlength</code> tuple is returned.</p> - -<p>This function can only be called once. Cowboy will not cache the result of this call.</p> - -<h3 id="has_body">has_body(Req) -> boolean()</h3> - -<p>Return whether the request has a body.</p> - -<h3 id="part">part(Req) -> part(Req, [{length, 64000}, {read_length, 64000}, {read_timeout, 5000}])</h3> - -<h3 id="part">part(Req, Opts) -> {ok, Headers, Req2} | {done, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Opts = [body_opt()]</li> -<li>Headers = cow_multipart:headers()</li> -</ul> - -<p>Read the headers for the next part of the multipart message.</p> - -<p>Cowboy will skip any data remaining until the beginning of the next part. This includes the preamble to the multipart message but also the body of a previous part if it hasn't been read. Both are skipped automatically when calling this function.</p> - -<p>The headers returned are MIME headers, NOT HTTP headers. They can be parsed using the functions from the <code>cow_multipart</code> module. In addition, the <code>cow_multipart:form_data/1</code> function can be used to quickly figure out <code>multipart/form-data</code> messages. It takes the list of headers and returns whether this part is a simple form field or a file being uploaded.</p> - -<p>Note that once a part has been read, or skipped, it cannot be read again.</p> - -<p>This function calls <code>body/2</code> for reading the body, with the same options it received. By default it will only read chunks of 64KB with a timeout of 5s. This is tailored for reading part headers, not for skipping the previous part's body. You might want to consider skipping large parts manually.</p> - -<h3 id="part_body">part_body(Req) -> part_body(Req, [])</h3> - -<h3 id="part_body">part_body(Req, Opts) -> {ok, Data, Req2} | {more, Data, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>Opts = [body_opt()]</li> -<li>Data = binary()</li> -</ul> - -<p>Read the body of the current part of the multipart message.</p> - -<p>This function calls <code>body/2</code> for reading the body, with the same options it received. It uses the same defaults.</p> - -<p>If there are more data to be read from the socket for this part, the function will return what it could read inside a <code>more</code> tuple. Otherwise, it will return an <code>ok</code> tuple.</p> - -<p>Calling this function again after receiving a <code>more</code> tuple will return another chunk of body. The last chunk will be returned inside an <code>ok</code> tuple.</p> - -<p>Note that once the body has been read, fully or partially, it cannot be read again.</p> - -<h2 id="response_related_exports">Response related exports</h2> - -<h3 id="chunk">chunk(Data, Req) -> ok | {error, Reason}</h3> - -<p>Types:</p> - -<ul> -<li>Data = iodata()</li> -<li>Reason = atom()</li> -</ul> - -<p>Send a chunk of data.</p> - -<p>This function should be called as many times as needed to send data chunks after calling <code>chunked_reply/{2,3}</code>.</p> - -<p>When the method is HEAD, no data will actually be sent.</p> - -<p>If the request uses HTTP/1.0, the data is sent directly without wrapping it in an HTTP/1.1 chunk, providing compatibility with older clients.</p> - -<h3 id="chunked_reply">chunked_reply(StatusCode, Req) -> chunked_reply(StatusCode, [], Req)</h3> - -<h3 id="chunked_reply">chunked_reply(StatusCode, Headers, Req) -> {ok, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>StatusCode = cowboy:http_status()</li> -<li>Headers = cowboy:http_headers()</li> -</ul> - -<p>Send a response using chunked transfer-encoding.</p> - -<p>This function effectively sends the response status line and headers to the client.</p> - -<p>This function will not send any body set previously. After this call the handler must use the <code>chunk/2</code> function repeatedly to send the body in as many chunks as needed.</p> - -<p>If the request uses HTTP/1.0, the data is sent directly without wrapping it in an HTTP/1.1 chunk, providing compatibility with older clients.</p> - -<p>This function can only be called once, with the exception of overriding the response in the <code>onresponse</code> hook.</p> - -<h3 id="continue">continue(Req) -> ok | {error, Reason}</h3> - -<p>Types:</p> - -<ul> -<li>Reason = atom()</li> -</ul> - -<p>Send a 100 Continue intermediate reply.</p> - -<p>This reply is required before the client starts sending the body when the request contains the <code>expect</code> header with the <code>100-continue</code> value.</p> - -<p>Cowboy will send this automatically when required. However you may want to do it manually by disabling this behavior with the <code>continue</code> body option and then calling this function.</p> - -<h3 id="delete_resp_header">delete_resp_header(Name, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -</ul> - -<p>Delete the given response header.</p> - -<p>While header names are case insensitive, this function expects the name to be a lowercase binary.</p> - -<h3 id="has_resp_body">has_resp_body(Req) -> boolean()</h3> - -<p>Return whether a response body has been set.</p> - -<p>This function will return false if a response body has been set with a length of 0.</p> - -<h3 id="has_resp_header">has_resp_header(Name, Req) -> boolean()</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -</ul> - -<p>Return whether the given response header has been set.</p> - -<p>While header names are case insensitive, this function expects the name to be a lowercase binary.</p> - -<h3 id="reply">reply(StatusCode, Req) -> reply(StatusCode, [], Req)</h3> - -<h3 id="reply">reply(StatusCode, Headers, Req) - see below</h3> - -<h3 id="reply">reply(StatusCode, Headers, Body, Req) -> {ok, Req2}</h3> - -<p>Types:</p> - -<ul> -<li>StatusCode = cowboy:http_status()</li> -<li>Headers = cowboy:http_headers()</li> -<li>Body = iodata()</li> -</ul> - -<p>Send a response.</p> - -<p>This function effectively sends the response status line, headers and body to the client, in a single send function call.</p> - -<p>The <code>reply/2</code> and <code>reply/3</code> functions will send the body set previously, if any. The <code>reply/4</code> function overrides any body set previously and sends <code>Body</code> instead.</p> - -<p>If a body function was set, and <code>reply/2</code> or <code>reply/3</code> was used, it will be called before returning.</p> - -<p>No more data can be sent to the client after this function returns.</p> - -<p>This function can only be called once, with the exception of overriding the response in the <code>onresponse</code> hook.</p> - -<h3 id="set_resp_body">set_resp_body(Body, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Body = iodata()</li> -</ul> - -<p>Set a response body.</p> - -<p>This body will not be sent if <code>chunked_reply/{2,3}</code> or <code>reply/4</code> is used, as they override it.</p> - -<h3 id="set_resp_body_fun">set_resp_body_fun(Fun, Req) -> Req2</h3> - -<h3 id="set_resp_body_fun">set_resp_body_fun(Length, Fun, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Fun = fun((Socket, Transport) -> ok)</li> -<li>Socket = inet:socket()</li> -<li>Transport = module()</li> -<li>Length = non_neg_integer()</li> -</ul> - -<p>Set a fun for sending the response body.</p> - -<p>If a <code>Length</code> is provided, it will be sent in the content-length header in the response. It is recommended to set the length if it can be known in advance. Otherwise, the transfer-encoding header will be set to identity.</p> - -<p>This function will only be called if the response is sent using the <code>reply/2</code> or <code>reply/3</code> function.</p> - -<p>The fun will receive the Ranch <code>Socket</code> and <code>Transport</code> as arguments. Only send and sendfile operations are supported.</p> - -<h3 id="set_resp_body_fun">set_resp_body_fun(chunked, Fun, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Fun = fun((ChunkFun) -> ok)</li> -<li>ChunkFun = fun((iodata()) -> ok | {error, atom()})</li> -</ul> - -<p>Set a fun for sending the response body using chunked transfer-encoding.</p> - -<p>This function will only be called if the response is sent using the <code>reply/2</code> or <code>reply/3</code> function.</p> - -<p>The fun will receive another fun as argument. This fun is to be used to send chunks in a similar way to the <code>chunk/2</code> function, except the fun only takes one argument, the data to be sent in the chunk.</p> - -<h3 id="set_resp_cookie">set_resp_cookie(Name, Value, Opts, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Name = iodata()</li> -<li>Value = iodata()</li> -<li>Opts = cookie_opts()</li> -</ul> - -<p>Set a cookie in the response.</p> - -<p>Cookie names are case sensitive.</p> - -<h3 id="set_resp_header">set_resp_header(Name, Value, Req) -> Req2</h3> - -<p>Types:</p> - -<ul> -<li>Name = binary()</li> -<li>Value = iodata()</li> -</ul> - -<p>Set a response header.</p> - -<p>You should use <code>set_resp_cookie/4</code> instead of this function to set cookies.</p> - -<h2 id="misc._exports">Misc. exports</h2> - -<h3 id="compact">compact(Req) -> Req2</h3> - -<p>Remove any non-essential data from the Req object.</p> - -<p>Long-lived connections usually only need to manipulate the Req object at initialization. Compacting allows saving up memory by discarding extraneous information.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_rest/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_rest/index.html deleted file mode 100644 index f2a275b3..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_rest/index.html +++ /dev/null @@ -1,698 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_rest</span></h1> - -<p>The <code>cowboy_rest</code> module implements REST semantics on top of the HTTP protocol.</p> - -<p>This module cannot be described as a behaviour due to most of the callbacks it defines being optional. It has the same semantics as a behaviour otherwise.</p> - -<p>The only mandatory callback is <code>init/3</code>, needed to perform the protocol upgrade.</p> - -<h2 id="types">Types</h2> - -<p>None.</p> - -<h2 id="meta_values">Meta values</h2> - -<h3 id="charset">charset</h3> - -<p>Type: binary()</p> - -<p>Negotiated charset.</p> - -<p>This value may not be defined if no charset was negotiated.</p> - -<h3 id="language">language</h3> - -<p>Type: binary()</p> - -<p>Negotiated language.</p> - -<p>This value may not be defined if no language was negotiated.</p> - -<h3 id="media_type">media_type</h3> - -<p>Type: {binary(), binary(), '*' | [{binary(), binary()}]}</p> - -<p>Negotiated media-type.</p> - -<p>The media-type is the content-type, excluding the charset.</p> - -<p>This value is always defined after the call to <code>content_types_provided/2</code>.</p> - -<h2 id="callbacks">Callbacks</h2> - -<h3 id="init">init({TransportName, ProtocolName}, Req, Opts) -> {upgrade, protocol, cowboy_rest} | {upgrade, protocol, cowboy_rest, Req, Opts}</h3> - -<p>Types:</p> - -<ul> -<li>TransportName = tcp | ssl | atom()</li> -<li>ProtocolName = http | atom()</li> -<li>Req = cowboy_req:req()</li> -<li>Opts = any()</li> -</ul> - -<p>Upgrade the protocol to <code>cowboy_rest</code>.</p> - -<p>This is the only mandatory callback.</p> - -<h3 id="rest_init">rest_init(Req, Opts) -> {ok, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>Req = cowboy_req:req()</li> -<li>Opts = any()</li> -<li>State = any()</li> -</ul> - -<p>Initialize the state for this request.</p> - -<h3 id="rest_terminate">rest_terminate(Req, State) -> ok</h3> - -<p>Types:</p> - -<ul> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -</ul> - -<p>Perform any necessary cleanup of the state.</p> - -<p>This callback should release any resource currently in use, clear any active timer and reset the process to its original state, as it might be reused for future requests sent on the same connection.</p> - -<h3 id="callback">Callback(Req, State) -> {Value, Req, State} | {halt, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>Callback - one of the REST callbacks described below</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -<li>Value - see the REST callbacks description below</li> -</ul> - -<p>Please see the REST callbacks description below for details on the <code>Value</code> type, the default value if the callback is not defined, and more general information on when the callback is called and what its intended use is.</p> - -<p>The <code>halt</code> tuple can be returned to stop REST processing. It is up to the resource code to send a reply before that, otherwise a <code>204 No Content</code> will be sent.</p> - -<h2 id="rest_callbacks_description">REST callbacks description</h2> - -<h3 id="allowed_methods">allowed_methods</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: [binary()]</li> -<li>Default value: [<<"GET">>, <<"HEAD">>, <<"OPTIONS">>]</li> -</ul> - -<p>Return the list of allowed methods.</p> - -<p>Methods are case sensitive. Standard methods are always uppercase.</p> - -<h3 id="allow_missing_post">allow_missing_post</h3> - -<ul> -<li>Methods: POST</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether POST is allowed when the resource doesn't exist.</p> - -<p>Returning <code>true</code> here means that a new resource will be created. The URL to the created resource should also be returned from the <code>AcceptResource</code> callback.</p> - -<h3 id="charsets_provided">charsets_provided</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: [binary()]</li> -<li>Skip to the next step if undefined</li> -</ul> - -<p>Return the list of charsets the resource provides.</p> - -<p>The list must be ordered in order of preference.</p> - -<p>If the accept-charset header was not sent, the first charset in the list will be selected. Otherwise Cowboy will select the most appropriate charset from the list.</p> - -<p>The chosen charset will be set in the <code>Req</code> object as the meta value <code>charset</code>.</p> - -<p>While charsets are case insensitive, this callback is expected to return them as lowercase binary.</p> - -<h3 id="content_types_accepted">content_types_accepted</h3> - -<ul> -<li>Methods: POST, PUT, PATCH</li> -<li>No default</li> -</ul> - -<p>Types:</p> - -<ul> -<li>Value = [{binary() | {Type, SubType, Params}, AcceptResource}]</li> -<li>Type = SubType = binary()</li> -<li>Params = '*' | [{binary(), binary()}]</li> -<li>AcceptResource = atom()</li> -</ul> - -<p>Return the list of content-types the resource accepts.</p> - -<p>The list must be ordered in order of preference.</p> - -<p>Each content-type can be given either as a binary string or as a tuple containing the type, subtype and parameters.</p> - -<p>Cowboy will select the most appropriate content-type from the list. If any parameter is acceptable, then the tuple form should be used with parameters set to <code>'*'</code>. If the parameters value is set to <code>[]</code> only content-type values with no parameters will be accepted. All parameter values are treated in a case sensitive manner except the <code>charset</code> parameter, if present, which is case insensitive.</p> - -<p>This function will be called for POST, PUT and PATCH requests. It is entirely possible to define different callbacks for different methods if the handling of the request differs. Simply verify what the method is with <code>cowboy_req:method/1</code> and return a different list for each methods.</p> - -<p>The <code>AcceptResource</code> value is the name of the callback that will be called if the content-type matches. It is defined as follow.</p> - -<ul> -<li>Value type: true | {true, URL} | false</li> -<li>No default</li> -</ul> - -<p>Process the request body.</p> - -<p>This function should create or update the resource with the information contained in the request body. This information may be full or partial depending on the request method.</p> - -<p>If the request body was processed successfully, <code>true</code> must be returned. If the request method is POST, <code>{true, URL}</code> may be returned instead, and Cowboy will redirect the client to the location of the newly created resource.</p> - -<p>If a response body must be sent, the appropriate media-type, charset and language can be retrieved using the <code>cowboy_req:meta/{2,3}</code> functions. The respective keys are <code>media_type</code>, <code>charset</code> and <code>language</code>. The body can be set using <code>cowboy_req:set_resp_body/2</code>.</p> - -<h3 id="content_types_provided">content_types_provided</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Default value: [{{<<"text">>, <<"html">>, '*'}, to_html}]</li> -</ul> - -<p>Types:</p> - -<ul> -<li>Value = [{binary() | {Type, SubType, Params}, ProvideResource}]</li> -<li>Type = SubType = binary()</li> -<li>Params = '*' | [{binary(), binary()}]</li> -<li>ProvideResource = atom()</li> -</ul> - -<p>Return the list of content-types the resource provides.</p> - -<p>The list must be ordered in order of preference.</p> - -<p>Each content-type can be given either as a binary string or as a tuple containing the type, subtype and parameters.</p> - -<p>Cowboy will select the most appropriate content-type from the list. If any parameter is acceptable, then the tuple form should be used with parameters set to <code>'*'</code>. If the parameters value is set to <code>[]</code> only content-type values with no parameters will be accepted. All parameter values are treated in a case sensitive manner except the <code>charset</code> parameter, if present, which is case insensitive.</p> - -<p>The <code>ProvideResource</code> value is the name of the callback that will be called if the content-type matches. It will only be called when a representation of the resource needs to be returned. It is defined as follow.</p> - -<ul> -<li>Methods: GET, HEAD</li> -<li>Value type: iodata() | {stream, Fun} | {stream, Len, Fun} | {chunked, ChunkedFun}</li> -<li>No default</li> -</ul> - -<p>Return the response body.</p> - -<p>The response body may be provided directly or through a fun. If a fun tuple is returned, the appropriate <code>set_resp_body_fun</code> function will be called. Please refer to the documentation for these functions for more information about the types.</p> - -<p>The call to this callback happens a good time after the call to <code>content_types_provided/2</code>, when it is time to start rendering the response body.</p> - -<h3 id="delete_completed">delete_completed</h3> - -<ul> -<li>Methods: DELETE</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the delete action has been completed.</p> - -<p>This function should return <code>false</code> if there is no guarantee that the resource gets deleted immediately from the system, including from any internal cache.</p> - -<p>When this function returns <code>false</code>, a <code>202 Accepted</code> response will be sent instead of a <code>200 OK</code> or <code>204 No Content</code>.</p> - -<h3 id="delete_resource">delete_resource</h3> - -<ul> -<li>Methods: DELETE</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Delete the resource.</p> - -<p>The value returned indicates if the action was successful, regardless of whether the resource is immediately deleted from the system.</p> - -<h3 id="expires">expires</h3> - -<ul> -<li>Methods: GET, HEAD</li> -<li>Value type: calendar:datetime() | binary() | undefined</li> -<li>Default value: undefined</li> -</ul> - -<p>Return the date of expiration of the resource.</p> - -<p>This date will be sent as the value of the expires header.</p> - -<h3 id="forbidden">forbidden</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Return whether access to the resource is forbidden.</p> - -<p>A <code>403 Forbidden</code> response will be sent if this function returns <code>true</code>. This status code means that access is forbidden regardless of authentication, and that the request shouldn't be repeated.</p> - -<h3 id="generate_etag">generate_etag</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: binary() | {weak | strong, binary()}</li> -<li>Default value: undefined</li> -</ul> - -<p>Return the entity tag of the resource.</p> - -<p>This value will be sent as the value of the etag header.</p> - -<p>If a binary is returned, then the value will be parsed to the tuple form automatically. The value must be in the same format as the etag header, including quotes.</p> - -<h3 id="is_authorized">is_authorized</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: true | {false, AuthHeader}</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the user is authorized to perform the action.</p> - -<p>This function should be used to perform any necessary authentication of the user before attempting to perform any action on the resource.</p> - -<p>If the authentication fails, the value returned will be sent as the value for the www-authenticate header in the <code>401 Unauthorized</code> response.</p> - -<h3 id="is_conflict">is_conflict</h3> - -<ul> -<li>Methods: PUT</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Return whether the put action results in a conflict.</p> - -<p>A <code>409 Conflict</code> response will be sent if this function returns <code>true</code>.</p> - -<h3 id="known_content_type">known_content_type</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the content-type is known.</p> - -<p>This function determines if the server understands the content-type, regardless of its use by the resource.</p> - -<h3 id="known_methods">known_methods</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: [binary()]</li> -<li>Default value: [<<"GET">>, <<"HEAD">>, <<"POST">>, <<"PUT">>, <<"PATCH">>, <<"DELETE">>, <<"OPTIONS">>]</li> -</ul> - -<p>Return the list of known methods.</p> - -<p>The full list of methods known by the server should be returned, regardless of their use in the resource.</p> - -<p>The default value lists the methods Cowboy knows and implement in <code>cowboy_rest</code>.</p> - -<p>Methods are case sensitive. Standard methods are always uppercase.</p> - -<h3 id="languages_provided">languages_provided</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: [binary()]</li> -<li>Skip to the next step if undefined</li> -</ul> - -<p>Return the list of languages the resource provides.</p> - -<p>The list must be ordered in order of preference.</p> - -<p>If the accept-language header was not sent, the first language in the list will be selected. Otherwise Cowboy will select the most appropriate language from the list.</p> - -<p>The chosen language will be set in the <code>Req</code> object as the meta value <code>language</code>.</p> - -<p>While languages are case insensitive, this callback is expected to return them as lowercase binary.</p> - -<h3 id="last_modified">last_modified</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: calendar:datetime()</li> -<li>Default value: undefined</li> -</ul> - -<p>Return the date of last modification of the resource.</p> - -<p>This date will be used to test against the if-modified-since and if-unmodified-since headers, and sent as the last-modified header in the response of GET and HEAD requests.</p> - -<h3 id="malformed_request">malformed_request</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Return whether the request is malformed.</p> - -<p>Cowboy has already performed all the necessary checks by the time this function is called, so few resources are expected to implement it.</p> - -<p>The check is to be done on the request itself, not on the request body, which is processed later.</p> - -<h3 id="moved_permanently">moved_permanently</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: {true, URL} | false</li> -<li>Default value: false</li> -</ul> - -<p>Return whether the resource was permanently moved.</p> - -<p>If it was, its new URL is also returned and sent in the location header in the response.</p> - -<h3 id="moved_temporarily">moved_temporarily</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PATCH, DELETE</li> -<li>Value type: {true, URL} | false</li> -<li>Default value: false</li> -</ul> - -<p>Return whether the resource was temporarily moved.</p> - -<p>If it was, its new URL is also returned and sent in the location header in the response.</p> - -<h3 id="multiple_choices">multiple_choices</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Return whether there are multiple representations of the resource.</p> - -<p>This function should be used to inform the client if there are different representations of the resource, for example different content-type. If this function returns <code>true</code>, the response body should include information about these different representations using <code>cowboy_req:set_resp_body/2</code>. The content-type of the response should be the one previously negociated and that can be obtained by calling <code>cowboy_req:meta(media_type, Req)</code>.</p> - -<h3 id="options">options</h3> - -<ul> -<li>Methods: OPTIONS</li> -<li>Value type: ok</li> -<li>Default value: ok</li> -</ul> - -<p>Handle a request for information.</p> - -<p>The response should inform the client the communication options available for this resource.</p> - -<p>By default, Cowboy will send a <code>200 OK</code> response with the allow header set.</p> - -<h3 id="previously_existed">previously_existed</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PATCH, DELETE</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Return whether the resource existed previously.</p> - -<h3 id="resource_exists">resource_exists</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the resource exists.</p> - -<p>If it exists, conditional headers will be tested before attempting to perform the action. Otherwise, Cowboy will check if the resource previously existed first.</p> - -<h3 id="service_available">service_available</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the service is available.</p> - -<p>This function can be used to test that all relevant backend systems are up and able to handle requests.</p> - -<p>A <code>503 Service Unavailable</code> response will be sent if this function returns <code>false</code>.</p> - -<h3 id="uri_too_long">uri_too_long</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: false</li> -</ul> - -<p>Return whether the requested URI is too long.</p> - -<p>Cowboy has already performed all the necessary checks by the time this function is called, so few resources are expected to implement it.</p> - -<p>A <code>414 Request-URI Too Long</code> response will be sent if this function returns <code>true</code>.</p> - -<h3 id="valid_content_headers">valid_content_headers</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the content-* headers are valid.</p> - -<p>This also applies to the transfer-encoding header. This function must return <code>false</code> for any unknown content-* headers, or if the headers can't be understood. The function <code>cowboy_req:parse_header/2</code> can be used to quickly check the headers can be parsed.</p> - -<p>A <code>501 Not Implemented</code> response will be sent if this function returns <code>false</code>.</p> - -<h3 id="valid_entity_length">valid_entity_length</h3> - -<ul> -<li>Methods: all</li> -<li>Value type: boolean()</li> -<li>Default value: true</li> -</ul> - -<p>Return whether the request body length is within acceptable boundaries.</p> - -<p>A <code>413 Request Entity Too Large</code> response will be sent if this function returns <code>false</code>.</p> - -<h3 id="variances">variances</h3> - -<ul> -<li>Methods: GET, HEAD, POST, PUT, PATCH, DELETE</li> -<li>Value type: [binary()]</li> -<li>Default value: []</li> -</ul> - -<p>Return the list of headers that affect the representation of the resource.</p> - -<p>These request headers return the same resource but with different parameters, like another language or a different content-type.</p> - -<p>Cowboy will automatically add the accept, accept-language and accept-charset headers to the list if the respective functions were defined in the resource.</p> - -<p>This operation is performed right before the <code>resource_exists/2</code> callback. All responses past that point will contain the vary header which holds this list.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_router/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_router/index.html deleted file mode 100644 index 23223ea9..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_router/index.html +++ /dev/null @@ -1,247 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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</span></h1> - -<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> - -<p>Environment input:</p> - -<ul> -<li>dispatch = dispatch_rules()</li> -</ul> - -<p>Environment output:</p> - -<ul> -<li>handler = module()</li> -<li>handler_opts = any()</li> -</ul> - -<h2 id="types">Types</h2> - -<h3 id="bindings">bindings() = [{atom(), binary()}]</h3> - -<p>List of bindings found during routing.</p> - -<h3 id="constraints">constraints() = [IntConstraint | FunConstraint]</h3> - -<p>Types:</p> - -<ul> -<li>IntConstraint = {atom(), int}</li> -<li>FunConstraint = {atom(), function, Fun}</li> -<li>Fun = fun((binary()) -> true | {true, any()} | false)</li> -</ul> - -<p>List of constraints to apply to the bindings.</p> - -<p>The int constraint will convert the binding to an integer. The fun constraint allows writing custom code for checking the bindings. Returning a new value from that fun allows replacing the current binding with a new value.</p> - -<h3 id="dispatch_rules">dispatch_rules() - opaque to the user</h3> - -<p>Rules for dispatching request used by Cowboy.</p> - -<h3 id="routes">routes() = [{Host, Paths} | {Host, constraints(), Paths}]</h3> - -<p>Types:</p> - -<ul> -<li>Host = Path = '_' | iodata()</li> -<li>Paths = [{Path, Handler, Opts} | {Path, constraints(), Handler, Opts}]</li> -<li>Handler = module()</li> -<li>Opts = any()</li> -</ul> - -<p>Human readable list of routes mapping hosts and paths to handlers.</p> - -<p>The syntax for routes is defined in the user guide.</p> - -<h3 id="tokens">tokens() = [binary()]</h3> - -<p>List of host_info and path_info tokens found during routing.</p> - -<h2 id="exports">Exports</h2> - -<h3 id="compile">compile(Routes) -> Dispatch</h3> - -<p>Types:</p> - -<ul> -<li>Routes = routes()</li> -<li>Dispatch = dispatch_rules()</li> -</ul> - -<p>Compile the routes for use by Cowboy.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_spdy/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_spdy/index.html deleted file mode 100644 index eb4460be..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_spdy/index.html +++ /dev/null @@ -1,212 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_spdy</span></h1> - -<p>The <code>cowboy_spdy</code> module implements SPDY/3 as a Ranch protocol.</p> - -<h2 id="types">Types</h2> - -<h3 id="opts">opts() = [{env, cowboy_middleware:env()} | {middlewares, [module()]} | {onrequest, cowboy:onrequest_fun()} | {onresponse, cowboy:onresponse_fun()}]</h3> - -<p>Configuration for the SPDY protocol handler.</p> - -<p>This configuration is passed to Cowboy when starting listeners using the <code>cowboy:start_spdy/4</code> function.</p> - -<p>It can be updated without restarting listeners using the Ranch functions <code>ranch:get_protocol_options/1</code> and <code>ranch:set_protocol_options/2</code>.</p> - -<h2 id="option_descriptions">Option descriptions</h2> - -<p>The default value is given next to the option name.</p> - -<h3 id="env ">env ([{listener, Ref}])</h3> - -<p>Initial middleware environment.</p> - -<h3 id="middlewares ">middlewares ([cowboy_router, cowboy_handler])</h3> - -<p>List of middlewares to execute for every requests.</p> - -<h3 id="onrequest ">onrequest (undefined)</h3> - -<p>Fun called every time a request is received.</p> - -<h3 id="onresponse ">onresponse (undefined)</h3> - -<p>Fun called every time a response is sent.</p> - -<h2 id="exports">Exports</h2> - -<p>None.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_static/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_static/index.html deleted file mode 100644 index 6611a607..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_static/index.html +++ /dev/null @@ -1,194 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_static</span></h1> - -<p>The <code>cowboy_static</code> module implements file serving capabilities by using the REST semantics provided by <code>cowboy_rest</code>.</p> - -<h2 id="types">Types</h2> - -<h3 id="opts">opts() = {priv_file, atom(), string() | binary()} | {priv_file, atom(), string() | binary(), extra()} | {file, string() | binary()} | {file, string() | binary(), extra()} | {priv_dir, atom(), string() | binary()} | {priv_dir, atom(), string() | binary(), extra()} | {dir, string() | binary()} | {dir, string() | binary(), extra()}</h3> - -<p>Configuration for the static handler.</p> - -<p>The handler can be configured for sending either one file or a directory (including its subdirectories).</p> - -<p>Extra options allow you to define how the etag should be calculated and how the mimetype of files should be detected. They are defined as follow, but do note that these types are not exported, only the <code>opts/0</code> type is public.</p> - -<h3 id="extra">extra() = [extra_etag() | extra_mimetypes()]</h3> - -<h3 id="extra_etag">extra_etag() = {etag, module(), function()} | {etag, false}</h3> - -<h3 id="extra_mimetypes">extra_mimetypes() = {mimetypes, module(), function()} | {mimetypes, binary() | {binary(), binary(), [{binary(), binary()}]}}</h3> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_sub_protocol/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_sub_protocol/index.html deleted file mode 100644 index 9fce2fb3..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_sub_protocol/index.html +++ /dev/null @@ -1,203 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_sub_protocol</span></h1> - -<p>The <code>cowboy_sub_protocol</code> behaviour defines the interface used by modules that implement a protocol on top of HTTP.</p> - -<h2 id="types">Types</h2> - -<p>None.</p> - -<h2 id="callbacks">Callbacks</h2> - -<h3 id="upgrade">upgrade(Req, Env, Handler, Opts) -> {ok, Req, Env} | {suspend, Module, Function, Args} | {halt, Req} | {error, StatusCode, Req}</h3> - -<p>Types:</p> - -<ul> -<li>Req = cowboy_req:req()</li> -<li>Env = env()</li> -<li>Handler = module()</li> -<li>Opts = any()</li> -<li>Module = module()</li> -<li>Function = atom()</li> -<li>Args = [any()]</li> -<li>StatusCode = cowboy:http_status()</li> -</ul> - -<p>Upgrade the protocol.</p> - -<p>Please refer to the <code>cowboy_middleware</code> manual for a description of the return values.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_websocket/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_websocket/index.html deleted file mode 100644 index bca70230..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_websocket/index.html +++ /dev/null @@ -1,208 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_websocket</span></h1> - -<p>The <code>cowboy_websocket</code> module implements the Websocket protocol.</p> - -<p>The callbacks for websocket handlers are defined in the manual for the <code>cowboy_websocket_handler</code> behaviour.</p> - -<h2 id="types">Types</h2> - -<h3 id="close_code">close_code() = 1000..4999</h3> - -<p>Reason for closing the connection.</p> - -<h3 id="frame">frame() = close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, close_code(), iodata()}</h3> - -<p>Frames that can be sent to the client.</p> - -<h2 id="meta_values">Meta values</h2> - -<h3 id="websocket_compress">websocket_compress</h3> - -<p>Type: true | false</p> - -<p>Whether a websocket compression extension in in use.</p> - -<h3 id="websocket_version">websocket_version</h3> - -<p>Type: 7 | 8 | 13</p> - -<p>The version of the Websocket protocol being used.</p> - -<h2 id="exports">Exports</h2> - -<p>None.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/cowboy_websocket_handler/index.html b/_build/static/docs/en/cowboy/1.0/manual/cowboy_websocket_handler/index.html deleted file mode 100644 index 71ab1e36..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/cowboy_websocket_handler/index.html +++ /dev/null @@ -1,273 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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_websocket_handler</span></h1> - -<p>The <code>cowboy_websocket_handler</code> behaviour defines the interface used by Websocket handlers.</p> - -<p>The <code>init/3</code> and <code>websocket_init/3</code> callbacks will always be called, followed by zero or more calls to <code>websocket_handle/3</code> and <code>websocket_info/3</code>. The <code>websocket_terminate/3</code> will always be called last.</p> - -<h2 id="types">Types</h2> - -<p>None.</p> - -<h2 id="callbacks">Callbacks</h2> - -<h3 id="init">init({TransportName, ProtocolName}, Req, Opts) -> {upgrade, protocol, cowboy_websocket} | {upgrade, protocol, cowboy_websocket, Req, Opts}</h3> - -<p>Types:</p> - -<ul> -<li>TransportName = tcp | ssl | atom()</li> -<li>ProtocolName = http | atom()</li> -<li>Req = cowboy_req:req()</li> -<li>Opts = any()</li> -</ul> - -<p>Upgrade the protocol to <code>cowboy_websocket</code>.</p> - -<h3 id="websocket_init">websocket_init(TransportName, Req, Opts) -> {ok, Req, State} | {ok, Req, State, hibernate} | {ok, Req, State, Timeout} | {ok, Req, State, Timeout, hibernate} | {shutdown, Req}</h3> - -<p>Types:</p> - -<ul> -<li>TransportName = tcp | ssl | atom()</li> -<li>Req = cowboy_req:req()</li> -<li>Opts = any()</li> -<li>State = any()</li> -<li>Timeout = timeout()</li> -</ul> - -<p>Initialize the state for this session.</p> - -<p>This function is called before the upgrade to Websocket occurs. It can be used to negotiate Websocket protocol extensions with the client. It will typically be used to register this process to an event manager or a message queue in order to receive the messages the handler wants to process.</p> - -<p>The connection will stay up for a duration of up to <code>Timeout</code> milliseconds after it last received data from the socket, at which point it will stop and close the connection. By default this value is set to <code>infinity</code>. It is recommended to either set this value or ensure by any other mechanism that the handler will be closed after a certain period of inactivity.</p> - -<p>The <code>hibernate</code> option will hibernate the process until it starts receiving either data from the Websocket connection or Erlang messages.</p> - -<p>The <code>shutdown</code> return value can be used to close the connection before upgrading to Websocket.</p> - -<h3 id="websocket_handle">websocket_handle(InFrame, Req, State) -> {ok, Req, State} | {ok, Req, State, hibernate} | {reply, OutFrame | [OutFrame], Req, State} | {reply, OutFrame | [OutFrame], Req, State, hibernate} | {shutdown, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>InFrame = {text | binary | ping | pong, binary()}</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -<li>OutFrame = cowboy_websocket:frame()</li> -</ul> - -<p>Handle the data received from the Websocket connection.</p> - -<p>This function will be called every time data is received from the Websocket connection.</p> - -<p>The <code>shutdown</code> return value can be used to close the connection. A close reply will also result in the connection being closed.</p> - -<p>The <code>hibernate</code> option will hibernate the process until it receives new data from the Websocket connection or an Erlang message.</p> - -<h3 id="websocket_info">websocket_info(Info, Req, State) -> {ok, Req, State} | {ok, Req, State, hibernate} | {reply, OutFrame | [OutFrame], Req, State} | {reply, OutFrame | [OutFrame], Req, State, hibernate} | {shutdown, Req, State}</h3> - -<p>Types:</p> - -<ul> -<li>Info = any()</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -<li>OutFrame = cowboy_websocket:frame()</li> -</ul> - -<p>Handle the Erlang message received.</p> - -<p>This function will be called every time an Erlang message has been received. The message can be any Erlang term.</p> - -<p>The <code>shutdown</code> return value can be used to close the connection. A close reply will also result in the connection being closed.</p> - -<p>The <code>hibernate</code> option will hibernate the process until it receives another message or new data from the Websocket connection.</p> - -<h3 id="websocket_terminate">websocket_terminate(Reason, Req, State) -> ok</h3> - -<p>Types:</p> - -<ul> -<li>Reason = {normal, shutdown | timeout} | {remote, closed} | {remote, cowboy_websocket:close_code(), binary()} | {error, badencoding | badframe | closed | atom()}</li> -<li>Req = cowboy_req:req()</li> -<li>State = any()</li> -</ul> - -<p>Perform any necessary cleanup of the state.</p> - -<p>The connection will be closed and the process stopped right after this call.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/http_status_codes/index.html b/_build/static/docs/en/cowboy/1.0/manual/http_status_codes/index.html deleted file mode 100644 index d7dbf7b7..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/http_status_codes/index.html +++ /dev/null @@ -1,305 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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>HTTP status codes</span></h1> - -<p>This chapter aims to list all HTTP status codes that Cowboy may return, with details on the reasons why. The list given here only includes the replies that Cowboy sends, not user replies.</p> - -<h3 id="100 continue">100 Continue</h3> - -<p>When the client sends an <code>expect: 100-continue</code> header, Cowboy automatically sends a this status code before trying to read the request body. This behavior can be disabled using the appropriate body option.</p> - -<h3 id="101 switching protocols">101 Switching Protocols</h3> - -<p>This is the status code sent when switching to the Websocket protocol.</p> - -<h3 id="200 ok">200 OK</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="201 created">201 Created</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="202 accepted">202 Accepted</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="204 no content">204 No Content</h3> - -<p>This status code is sent when the processing of a request ends without any reply having been sent. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> - -<h3 id="300 multiple choices">300 Multiple Choices</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="301 moved permanently">301 Moved Permanently</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="303 see other">303 See Other</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="304 not modified">304 Not Modified</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="307 temporary redirect">307 Temporary Redirect</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="400 bad request">400 Bad Request</h3> - -<p>Cowboy will send this status code for any of the following reasons:</p> - -<ul> -<li>Too many empty lines were sent before the request.</li> -<li>The request-line could not be parsed.</li> -<li>Too many headers were sent.</li> -<li>A header name was too long.</li> -<li>A header value was too long.</li> -<li>The host header was missing from an HTTP/1.1 request.</li> -<li>The host header could not be parsed.</li> -<li>The requested host was not found.</li> -<li>The requested path could not be parsed.</li> -<li>The accept header could not be parsed when using REST.</li> -<li>REST under normal conditions.</li> -<li>A Websocket upgrade failed.</li> -</ul> - -<h3 id="401 unauthorized">401 Unauthorized</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="403 forbidden">403 Forbidden</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="404 not found">404 Not Found</h3> - -<p>This status code is sent when the router successfully resolved the host but didn't find a matching path for the request. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> - -<h3 id="405 method not allowed">405 Method Not Allowed</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="406 not acceptable">406 Not Acceptable</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="408 request timeout">408 Request Timeout</h3> - -<p>Cowboy will send this status code to the client if the client started to send a request, indicated by the request-line being received fully, but failed to send all headers in a reasonable time.</p> - -<h3 id="409 conflict">409 Conflict</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="410 gone">410 Gone</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="412 precondition failed">412 Precondition Failed</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="413 request entity too large">413 Request Entity Too Large</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="414 request-uri too long">414 Request-URI Too Long</h3> - -<p>Cowboy will send this status code to the client if the request-line is too long. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> - -<h3 id="415 unsupported media type">415 Unsupported Media Type</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="500 internal server error">500 Internal Server Error</h3> - -<p>This status code is sent when a crash occurs in HTTP, loop or REST handlers, or when an invalid return value is returned. It may also be sent by <code>cowboy_rest</code> under normal conditions.</p> - -<h3 id="501 not implemented">501 Not Implemented</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="503 service unavailable">503 Service Unavailable</h3> - -<p>This status code is sent by <code>cowboy_rest</code>.</p> - -<h3 id="505 http version not supported">505 HTTP Version Not Supported</h3> - -<p>Cowboy only supports the versions 1.0 and 1.1 of HTTP. In all other cases this status code is sent back to the client and the connection is closed.</p> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> diff --git a/_build/static/docs/en/cowboy/1.0/manual/index.html b/_build/static/docs/en/cowboy/1.0/manual/index.html deleted file mode 100644 index feaaa5b0..00000000 --- a/_build/static/docs/en/cowboy/1.0/manual/index.html +++ /dev/null @@ -1,197 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <title>Nine Nines Support: Cowboy Function Reference</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <!-- Change them or set them up as you like --> - <meta name="description" content=""> - <meta name="author" content="(Soft10) Pol Cámara"> - - <!-- Stylesheets --> - <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 href="js/google-code-prettify/prettify.css" rel="stylesheet"> --> - <link href="/css/sh99s.css" rel="stylesheet"/> - - <!-- Enables html5 support on older browsers, other js is placed at the end of the page to speed up loading --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - - <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"> - <link rel="alternate" href="/feeds/atom.xml" type="application/atom+xml" title="Nine Nines Atom Feed"> - </head> - - <body class="big_text docs"> - <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"> - <!-- Top navigation and social icons--> - <div id="side-header"> - <nav> - <ul> - <li><a title="Erlang training" href="/training">Training</a></li> - <li><a title="Technical publications" href="/articles">Articles</a></li> - <li><a title="Our talks" href="/talks">Talks</a></li> - <li class="active"><a title="Our services" href="/support">Pricing & Sponsoring</a></li> - <li><a title="Community support" href="https://ninenines.eu/archives/extend/">Mailing Lists</a></li> - <li><a title="Contact us" href="mailto:[email protected]">Contact</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check our Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li class="dropdown" id="twitter-links"> - <a href="#twitter-links" class="dropdown-toggle" data-toggle="dropdown" title="Follow us on Twitter"> - <img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png" alt="Twitter"> - </a> - <ul class="dropdown-menu"> - <li><a title="Visit Loïc Hoguin's Twitter Account" href="http://twitter.com/lhoguin">@lhoguin</a></li> - <!-- <li class="divider"></li> - <li><a title="Visit our official Twitter account" href="#">@99s</a></li> --> - </ul> - </li> - <!-- <li> - <a href="/css/" title="Add us on Linkedin"><img src="/img/ico_linkedin.png" data-hover="img/ico_linkedin_alt.png" alt="Linkedin"></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 Function Reference</span></h1> - -<p>The function reference documents the public interface of Cowboy.</p> - -<ul> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_app">The Cowboy Application</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy">cowboy</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_handler">cowboy_handler</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_http_handler">cowboy_http_handler</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_loop_handler">cowboy_loop_handler</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_middleware">cowboy_middleware</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_protocol">cowboy_protocol</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_req">cowboy_req</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_rest">cowboy_rest</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_router">cowboy_router</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_spdy">cowboy_spdy</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_static">cowboy_static</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_sub_protocol">cowboy_sub_protocol</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_websocket">cowboy_websocket</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/cowboy_websocket_handler">cowboy_websocket_handler</a></li> -<li><a href="/docs/en/cowboy/1.0/manual/http_status_codes">HTTP status codes</a></li> -</ul> - - -<!-- a.code --> -</div> - -<div class="span3 sidecol"> -<div class="input-append"> -<form id="form-search" class="form-search" action="#"> - <input id="input-search" type="text" placeholder="Function search" autocomplete="off" autofocus class="input-medium search-query span2"> - <button type="submit" class="btn btn-success">Go</button> -</form> -</div> - -<h3 id="docs-nav">Navigation</h3> - -<h3>See also</h3><ul><li><a href="/docs/en/cowboy/1.0/guide/">User Guide</a></li><li><a href="/docs/en/cowboy/1.0/index.html">README</a></li></ul> - -<h3>Version select</h3> -<ul> - - <li><a href="/docs/en/cowboy/1.0/manual/"><strong>1.0</strong></a></li> - - <li><a href="/docs/en/cowboy/HEAD/manual/"><strong>HEAD</strong></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 © Nine Nines 2012-2014</p> - </div> - </div> - </div> - </footer> - - <!-- Javascript --> - <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> - - -<script type="text/javascript" src="/js/shCore.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushBash.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushErlang.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushJScript.js"></script> -<script type="text/javascript" src="/js/shlang/shBrushPlain.js"></script> -<script type="text/javascript">SyntaxHighlighter.all();</script> - -<script type="text/javascript" src="/js/fuse.min.js"></script> -<script type="text/javascript"> -$(document).ready(function(){ - var f; - - $.getJSON("/docs/db.json", function(data){ - f = new Fuse(data, {keys: ["n"], threshold: 0.3}); - $("<ul id=\"search-results\">").insertAfter("#form-search"); - }); - - $("#input-search").keyup(function(e){if(f){if (e.which != 13 ){ - var results = f.search($(this).val()); - if (results.length == 0){ - $("#form-search").attr("action", "#"); - }else{ - $("#form-search").attr("action", results[0].l); - } - - $("#search-results").empty(); - for (var i = 0; i < 10 && i < results.length; i++){ - $("<li><a href=\"" + results[i].l + "\">" + results[i].n + "</a></li>") - .appendTo("#search-results"); - } - }}}); -}); -</script> - - </body> -</html> |