blob: 7efcd20bae27ef67f5ad168c9830e85772d2c6d4 (
plain) (
tree)
|
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<meta name="generator" content="Hugo 0.16" />
<title>Nine Nines: cowboy_protocol(3)</title>
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/99s.css" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>cowboy_protocol(3)</span></h1>
<div class="sect1">
<h2 id="_name">Name</h2>
<div class="sectionbody">
<div class="paragraph"><p>cowboy_protocol - HTTP protocol</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <code>cowboy_protocol</code> module implements HTTP/1.1 and HTTP/1.0
as a Ranch protocol.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_types">Types</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_opts_option">opts() = [Option]</h3>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="color: #009900">Option</span> <span style="color: #990000">=</span> {<span style="color: #FF6600">compress</span>, <span style="font-weight: bold"><span style="color: #000000">boolean</span></span>()}
| {<span style="color: #FF6600">env</span>, <span style="font-weight: bold"><span style="color: #000000">cowboy_middleware:env</span></span>()}
| {<span style="color: #FF6600">max_empty_lines</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
| {<span style="color: #FF6600">max_header_name_length</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
| {<span style="color: #FF6600">max_header_value_length</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
| {<span style="color: #FF6600">max_headers</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
| {<span style="color: #FF6600">max_keepalive</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
| {<span style="color: #FF6600">max_request_line_length</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>()}
| {<span style="color: #FF6600">middlewares</span>, [<span style="font-weight: bold"><span style="color: #000000">module</span></span>()]}
| {<span style="color: #FF6600">onresponse</span>, <span style="font-weight: bold"><span style="color: #000000">cowboy:onresponse_fun</span></span>()}
| {<span style="color: #FF6600">timeout</span>, <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>()}</tt></pre></div></div>
<div class="paragraph"><p>Configuration for the HTTP protocol handler.</p></div>
<div class="paragraph"><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></div>
<div class="paragraph"><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></div>
</div>
<div class="sect2">
<h3 id="_option_descriptions">Option descriptions</h3>
<div class="paragraph"><p>The default value is given next to the option name.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
compress (false)
</dt>
<dd>
<p>
When enabled, Cowboy will attempt to compress the response body.
</p>
</dd>
<dt class="hdlist1">
env ([{listener, Ref}])
</dt>
<dd>
<p>
Initial middleware environment.
</p>
</dd>
<dt class="hdlist1">
max_empty_lines (5)
</dt>
<dd>
<p>
Maximum number of empty lines before a request.
</p>
</dd>
<dt class="hdlist1">
max_header_name_length (64)
</dt>
<dd>
<p>
Maximum length of header names.
</p>
</dd>
<dt class="hdlist1">
max_header_value_length (4096)
</dt>
<dd>
<p>
Maximum length of header values.
</p>
</dd>
<dt class="hdlist1">
max_headers (100)
</dt>
<dd>
<p>
Maximum number of headers allowed per request.
</p>
</dd>
<dt class="hdlist1">
max_keepalive (100)
</dt>
<dd>
<p>
Maximum number of requests allowed per connection.
</p>
</dd>
<dt class="hdlist1">
max_request_line_length (4096)
</dt>
<dd>
<p>
Maximum length of the request line.
</p>
</dd>
<dt class="hdlist1">
middlewares ([cowboy_router, cowboy_handler])
</dt>
<dd>
<p>
List of middlewares to execute for every requests.
</p>
</dd>
<dt class="hdlist1">
onresponse (undefined)
</dt>
<dd>
<p>
Fun called every time a response is sent.
</p>
</dd>
<dt class="hdlist1">
timeout (5000)
</dt>
<dd>
<p>
Time in ms with no requests before Cowboy closes the connection.
</p>
</dd>
</dl></div>
</div>
</div>
</div>
</div>
<div class="span3 sidecol">
<h3>
Cowboy
2.0
Function Reference
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.0/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.0/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li>
<li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2016</p>
</div>
</div>
</div>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script src="/js/bootstrap-carousel.js"></script>
<script src="/js/bootstrap-dropdown.js"></script>
<script src="/js/custom.js"></script>
</body>
</html>
|
