blob: 58588de9316d6df8dc50787c9a13530248fcdbc9 (
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.30.2" />
<title>Nine Nines: Cowboy Function Reference</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=1" 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 Function Reference</span></h1>
<div class="sect1">
<h2 id="_name">Name</h2>
<div class="sectionbody">
<div class="paragraph"><p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>Cowboy is an HTTP server for Erlang/OTP with support for the
HTTP/1.1, HTTP/2 and Websocket protocols.</p></div>
<div class="paragraph"><p>Cowboy aims to provide a complete HTTP stack. This includes
the implementation of the HTTP RFCs but also any directly
related standards, like Websocket or Server-Sent Events.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_modules">Modules</h2>
<div class="sectionbody">
<div class="paragraph"><p>Functions:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="cowboy">cowboy(3)</a> - Listener management
</p>
</li>
<li>
<p>
<a href="cowboy_req">cowboy_req(3)</a> - Request and response
</p>
</li>
<li>
<p>
<a href="cowboy_router">cowboy_router(3)</a> - Router
</p>
</li>
<li>
<p>
<a href="cowboy_constraints">cowboy_constraints(3)</a> - Constraints
</p>
</li>
</ul></div>
<div class="paragraph"><p>Protocols:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1
</p>
</li>
<li>
<p>
<a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2
</p>
</li>
<li>
<p>
<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket
</p>
</li>
</ul></div>
<div class="paragraph"><p>Handlers:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="cowboy_static">cowboy_static(3)</a> - Static file handler
</p>
</li>
</ul></div>
<div class="paragraph"><p>Behaviors:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers
</p>
</li>
<li>
<p>
<a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers
</p>
</li>
<li>
<p>
<a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares
</p>
</li>
<li>
<p>
<a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers
</p>
</li>
<li>
<p>
<a href="cowboy_stream">cowboy_stream(3)</a> - Stream handlers
</p>
</li>
<li>
<p>
<a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers
</p>
</li>
</ul></div>
<div class="paragraph"><p>Middlewares:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="cowboy_router">cowboy_router(3)</a> - Router middleware
</p>
</li>
<li>
<p>
<a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_dependencies">Dependencies</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<a href="ranch_app">ranch(7)</a> - Socket acceptor pool for TCP protocols
</p>
</li>
<li>
<p>
<a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols
</p>
</li>
<li>
<p>
ssl - Secure communication over sockets
</p>
</li>
<li>
<p>
crypto - Crypto functions
</p>
</li>
</ul></div>
<div class="paragraph"><p>All these applications must be started before the <code>cowboy</code>
application. To start Cowboy and all dependencies at once:</p></div>
<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: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">cowboy</span>)<span style="color: #990000">.</span></tt></pre></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_environment">Environment</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <code>cowboy</code> application does not define any application
environment configuration parameters.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">See also</h2>
<div class="sectionbody">
<div class="paragraph"><p><a href="ranch_app">ranch(7)</a>,
<a href="cowlib_app">cowlib(7)</a></p></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/2.1/manual">2.1</a></li>
<li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li>
<li><a href="/docs/en/cowboy/1.0/manual">1.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="/js/custom.js"></script>
</body>
</html>
|
