summaryrefslogblamecommitdiffstats
path: root/docs/en/cowboy/2.6/manual/index.html
blob: f0ddd6873e8abf202e90ae66fe7e14217dd29add (plain) (tree) 
3edee0ac












53a79df4

3edee0ac





















































































































8459bebc

3edee0ac












































8459bebc


3edee0ac










3edee0ac


f40886df












519eb0a3

f40886df



3edee0ac






























1
2
3
4
5
6
7
8
9
10
11
12

13

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

131

132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

176
177

178
179
180
181
182
183
184
185
186
187

188
189

190
191
192
193
194
195
196
197
198
199
200
201

202

203
204
205

206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235












                                                                                                                      
                                                   




















































































































                                                                                                                                                                                     
                                                                                         











































                                                                                                                                                                                                                                                          

                                                                     









                                                                     

     











                                                                                                                                                                   
                                                                                                                                                                                                                                  


 





























                                                                                                                                                                                                                           
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="">
    <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">

    <title>Nine Nines: Cowboy 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=7" rel="stylesheet">

    <link rel="shortcut icon" href="/img/ico/favicon.ico">
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
    <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">

    
</head>


<body class="">
  <header id="page-head">
    <div id="topbar" class="container">
        <div class="row">
          <div class="span2">
            <h1 id="logo"><a href="/" title="99s">99s</a></h1>
          </div>
          <div class="span10">
            
            <div id="side-header">
              <nav>
                <ul>
                  <li><a title="Hear my thoughts" href="/articles">Articles</a></li>
  				  <li><a title="Watch my talks" href="/talks">Talks</a></li>
  				  <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
  				  <li><a title="Request my services" href="/services">Consulting & Training</a></li>
                </ul>
              </nav> 
              <ul id="social">
                <li>
                  <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
                </li>
                    <li>
						<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
					</li>
              </ul>
            </div>
          </div>
        </div>
    </div>


</header>

<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">

<h1 class="lined-header"><span>Cowboy Function Reference</span></h1>

<h2 id="_name">Name</h2>
<p>cowboy - Small, fast, modern HTTP server for Erlang/OTP</p>
<h2 id="_description">Description</h2>
<p>Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p>
<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>
<h2 id="_modules">Modules</h2>
<p>Functions:</p>
<ul><li><a href="cowboy">cowboy(3)</a> - Listener management
</li>
<li><a href="cowboy_req">cowboy_req(3)</a> - Request and response
</li>
<li><a href="cowboy_router">cowboy_router(3)</a> - Router
</li>
<li><a href="cowboy_constraints">cowboy_constraints(3)</a> - Constraints
</li>
</ul>
<p>Protocols:</p>
<ul><li><a href="cowboy_http">cowboy_http(3)</a> - HTTP/1.1
</li>
<li><a href="cowboy_http2">cowboy_http2(3)</a> - HTTP/2
</li>
<li><a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket
</li>
</ul>
<p>Handlers:</p>
<ul><li><a href="cowboy_static">cowboy_static(3)</a> - Static file handler
</li>
</ul>
<p>Stream handlers:</p>
<ul><li><a href="cowboy_stream_h">cowboy_stream_h(3)</a> - Default stream handler
</li>
<li><a href="cowboy_compress_h">cowboy_compress_h(3)</a> - Compress stream handler
</li>
</ul>
<p>Behaviors:</p>
<ul><li><a href="cowboy_handler">cowboy_handler(3)</a> - Plain HTTP handlers
</li>
<li><a href="cowboy_loop">cowboy_loop(3)</a> - Loop handlers
</li>
<li><a href="cowboy_middleware">cowboy_middleware(3)</a> - Middlewares
</li>
<li><a href="cowboy_rest">cowboy_rest(3)</a> - REST handlers
</li>
<li><a href="cowboy_stream">cowboy_stream(3)</a> - Stream handlers
</li>
<li><a href="cowboy_websocket">cowboy_websocket(3)</a> - Websocket handlers
</li>
</ul>
<p>Middlewares:</p>
<ul><li><a href="cowboy_router">cowboy_router(3)</a> - Router middleware
</li>
<li><a href="cowboy_handler">cowboy_handler(3)</a> - Handler middleware
</li>
</ul>
<!-- @todo http_status_codes is not linked to; what to do with it?-->
<h2 id="_dependencies">Dependencies</h2>
<ul><li><a href="ranch_app">ranch(7)</a> - Socket acceptor pool for TCP protocols
</li>
<li><a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols
</li>
<li>ssl - Secure communication over sockets
</li>
<li>crypto - Crypto functions
</li>
</ul>
<p>All these applications must be started before the <code>cowboy</code> application. To start Cowboy and all dependencies at once:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">cowboy</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<h2 id="_environment">Environment</h2>
<p>The <code>cowboy</code> application does not define any application environment configuration parameters.</p>
<h2 id="_see_also">See also</h2>
<p><a href="ranch_app">ranch(7)</a>, <a href="cowlib_app">cowlib(7)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Cowboy
	2.6
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/cowboy/2.6/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/cowboy/2.6/manual">Function Reference</a></li>
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li>
	
		<li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li>
	
		<li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li>
	
		<li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li>
	
		<li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li>
	
		<li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li>
	
</ul>

<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>



</div>
</div>
</div>
</div>

      <footer>
        <div class="container">
          <div class="row">
            <div class="span6">
              <p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
              <nav>
                <ul>
                  <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
                </ul>
              </nav>
            </div>
            <div class="span6 credits">
               <p><img src="/img/footer_logo.png"></p>
               <p>Copyright &copy; Loïc Hoguin 2012-2018</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-18 22:25:12 +0000