summaryrefslogblamecommitdiffstats
path: root/docs/en/cowboy/2.0/manual/cowboy_app/index.html
blob: d20f61fc27ee18b819765decb8bd97f5eca78ac3 (plain) (tree) 
fe3492a9









28b5bf18

fe3492a9



83f1ad46

642b100b

fe3492a9






















































b5d4cb91





































































































































































fe3492a9



62f5d708


fe3492a9





























1b863c35


28b5bf18


fe3492a9


f6f2a2dc


fe3492a9



























fe3492a9





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
236
237

238
239

240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

269
270

271
272

273
274

275
276

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

304
305
306
307
308









                                                                                           
                                                   


                                        
                                                                                                                      
                                                   





















































                                                                                                                                                                                          




































































































































































                                                                                                                                                                                                                                                                                                                                                


 

 




























                                                                                    

                                                                     

                                                                     

                                                                     

                                                                     


























                                                                                                                                                                                                                           




                                         
<!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(7)</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(7)</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">ranch(7)</a> - Socket acceptor pool for TCP protocols
</p>
</li>
<li>
<p>
<a href="../cowlib">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">ranch(7)</a>,
<a href="../cowlib">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.2/manual">2.2</a></li>
	
		<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 &copy; Loïc Hoguin 2012-2016</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-11-16 06:16:20 +0000