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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
<!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: Sending a response</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="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>Sending a response</span></h1>
<p>The response must be sent using the Req object.</p>
<p>Cowboy provides two different ways of sending responses: either directly or by streaming the body. Response headers and body may be set in advance. The response is sent as soon as one of the reply or stream reply function is called.</p>
<p>Cowboy also provides a simplified interface for sending files. It can also send only specific parts of a file.</p>
<p>While only one response is allowed for every request, HTTP/2 introduced a mechanism that allows the server to push additional resources related to the response. This chapter also describes how this feature works in Cowboy.</p>
<h2 id="_reply">Reply</h2>
<p>Cowboy provides three functions for sending the entire reply, depending on whether you need to set headers and body. In all cases, Cowboy will add any headers required by the protocol (for example the date header will always be sent).</p>
<p>When you need to set only the status code, use <code>cowboy_req:reply/2</code>:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>When you need to set response headers at the same time, use <code>cowboy_req:reply/3</code>:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">303</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"location"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"https://ninenines.eu"</font><font color="#990000">>></font>
}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>Note that the header name must always be a lowercase binary.</p>
<p>When you also need to set the response body, use <code>cowboy_req:reply/4</code>:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>
}, <font color="#FF0000">"Hello world!"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>You should always set the content-type header when the response has a body. There is however no need to set the content-length header; Cowboy does it automatically.</p>
<p>The response body and the header values must be either a binary or an iolist. An iolist is a list containing binaries, characters, strings or other iolists. This allows you to build a response from different parts without having to do any concatenation:</p>
<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><font color="#009900">Title</font> <font color="#990000">=</font> <font color="#FF0000">"Hello world!"</font>,
<font color="#009900">Body</font> <font color="#990000">=</font> <font color="#990000"><<</font><font color="#FF0000">"Hats off!"</font><font color="#990000">>></font>,
<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>
}, [<font color="#FF0000">"<html><head><title>"</font>, <font color="#009900">Title</font>, <font color="#FF0000">"</title></head>"</font>,
<font color="#FF0000">"<body><p>"</font>, <font color="#009900">Body</font>, <font color="#FF0000">"</p></body></html>"</font>], <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>This method of building responses is more efficient than concatenating. Behind the scenes, each element of the list is simply a pointer, and those pointers are used directly when writing to the socket.</p>
<h2 id="_stream_reply">Stream reply</h2>
<p>Cowboy provides two functions for initiating a response, and an additional function for streaming the response body. Cowboy will add any required headers to the response.</p>
<!-- @todo For HTTP/1.1 Cowboy should probably not use chunked transfer-encoding if the content-length is set.-->
<p>When you need to set only the status code, use <code>cowboy_req:stream_reply/2</code>:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, <font color="#009900">Req0</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"Hello..."</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"chunked..."</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"world!!"</font>, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>The second argument to <code>cowboy_req:stream_body/3</code> indicates whether this data terminates the body. Use <code>fin</code> for the final flag, and <code>nofin</code> otherwise.</p>
<p>This snippet does not set a content-type header. This is not recommended. All responses with a body should have a content-type. The header can be set beforehand, or using the <code>cowboy_req:stream_reply/3</code>:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>
}, <font color="#009900">Req0</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<html><head>Hello world!</head>"</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<body><p>Hats off!</p></body></html>"</font>, <font color="#FF6600">fin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>HTTP provides a few different ways to stream response bodies. Cowboy will select the most appropriate one based on the HTTP version and the request and response headers.</p>
<p>While not required by any means, it is recommended that you set the content-length header in the response if you know it in advance. This will ensure that the best response method is selected and help clients understand when the response is fully received.</p>
<p>Cowboy also provides a function to send response trailers. Response trailers are semantically equivalent to the headers you send in the response, only they are sent at the end. This is especially useful to attach information to the response that could not be generated until the response body was fully generated.</p>
<p>Trailer fields must be listed in the trailer header. Any field not listed might be dropped by the client or an intermediary.</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>,
<font color="#990000"><<</font><font color="#FF0000">"trailer"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"expires, content-md5"</font><font color="#990000">>></font>
}, <font color="#009900">Req0</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<html><head>Hello world!</head>"</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>),
<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#FF0000">"<body><p>Hats off!</p></body></html>"</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>),
<b><font color="#000000">cowboy_req:stream_trailers</font></b>(#{
<font color="#990000"><<</font><font color="#FF0000">"expires"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"Sun, 10 Dec 2017 19:13:47 GMT"</font><font color="#990000">>></font>,
<font color="#990000"><<</font><font color="#FF0000">"content-md5"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"c6081d20ff41a42ce17048ed1c0345e2"</font><font color="#990000">>></font>
}, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>The stream ends with trailers. It is no longer possible to send data after sending trailers. You cannot send trailers after setting the <code>fin</code> flag when streaming the body.</p>
<h2 id="_preset_response_headers">Preset response headers</h2>
<p>Cowboy provides functions to set response headers without immediately sending them. They are stored in the Req object and sent as part of the response when a reply function is called.</p>
<p>To set response headers:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#FF0000">"GET"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>Header names must be a lowercase binary.</p>
<p>Do not use this function for setting cookies. Refer to the <a href="../cookies">Cookies</a> chapter for more information.</p>
<p>To check if a response header has already been set:</p>
<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><b><font color="#000000">cowboy_req:has_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>It returns <code>true</code> if the header was set, <code>false</code> otherwise.</p>
<p>To delete a response header that was set previously:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:delete_resp_header</font></b>(<font color="#990000"><<</font><font color="#FF0000">"allow"</font><font color="#990000">>></font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<h2 id="_overriding_headers">Overriding headers</h2>
<p>As Cowboy provides different ways of setting response headers and body, clashes may occur, so it's important to understand what happens when a header is set twice.</p>
<p>Headers come from five different origins:</p>
<ul><li>Protocol-specific headers (for example HTTP/1.1's connection header)
</li>
<li>Other required headers (for example the date header)
</li>
<li>Preset headers
</li>
<li>Headers given to the reply function
</li>
<li>Set-cookie headers
</li>
</ul>
<p>Cowboy does not allow overriding protocol-specific headers.</p>
<p>Set-cookie headers will always be appended at the end of the list of headers before sending the response.</p>
<p>Headers given to the reply function will always override preset headers and required headers. If a header is found in two or three of these, then the one in the reply function is picked and the others are dropped.</p>
<p>Similarly, preset headers will always override required headers.</p>
<p>To illustrate, look at the following snippet. Cowboy by default sends the server header with the value "Cowboy". We can override it:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"server"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"yaws"</font><font color="#990000">>></font>
}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<h2 id="_preset_response_body">Preset response body</h2>
<p>Cowboy provides functions to set the response body without immediately sending it. It is stored in the Req object and sent when the reply function is called.</p>
<p>To set the response body:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:set_resp_body</font></b>(<font color="#FF0000">"Hello world!"</font>, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<!-- @todo Yeah we probably should add that function that-->
<!-- also sets the content-type at the same time...-->
<p>To check if a response body has already been set:</p>
<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><b><font color="#000000">cowboy_req:has_resp_body</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>It returns <code>true</code> if the body was set and is non-empty, <code>false</code> otherwise.</p>
<!-- @todo We probably should also have a function that-->
<!-- properly removes the response body, including any-->
<!-- content-* headers.-->
<p>The preset response body is only sent if the reply function used is <code>cowboy_req:reply/2</code> or <code>cowboy_req:reply/3</code>.</p>
<h2 id="_sending_files">Sending files</h2>
<p>Cowboy provides a shortcut for sending files. When using <code>cowboy_req:reply/4</code>, or when presetting the response header, you can give a <code>sendfile</code> tuple to Cowboy:</p>
<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>{<font color="#FF6600">sendfile</font>, <font color="#009900">Offset</font>, <font color="#009900">Length</font>, <font color="#009900">Filename</font>}</tt></pre>
</div></div>
<p>Depending on the values for <code>Offset</code> or <code>Length</code>, the entire file may be sent, or just a part of it.</p>
<p>The length is required even for sending the entire file. Cowboy sends it in the content-length header.</p>
<p>To send a file while replying:</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#FF0000">"image/png"</font>
}, {<font color="#FF6600">sendfile</font>, <font color="#993399">0</font>, <font color="#993399">12345</font>, <font color="#FF0000">"path/to/logo.png"</font>}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<!-- @todo An example of presetting a file would be useful,-->
<!-- but let's wait for the function that can set the-->
<!-- content-type at the same time.-->
<!-- @todo What about streaming many files? For example-->
<!-- it should be possible to build a tar file on the fly-->
<!-- while still using sendfile. Another example could be-->
<!-- proper support for multipart byte ranges. Yet another-->
<!-- example would be automatic concatenation of CSS or JS-->
<!-- files.-->
<h2 id="_informational_responses">Informational responses</h2>
<p>Cowboy allows you to send informational responses.</p>
<p>Informational responses are responses that have a status code between 100 and 199. Any number can be sent before the proper response. Sending an informational response does not change the behavior of the proper response, and clients are expected to ignore any informational response they do not understand.</p>
<p>The following snippet sends a 103 informational response with some headers that are expected to be in the final response.</p>
<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><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:inform</font></b>(<font color="#993399">103</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"link"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"</style.css>; rel=preload; as=style, </script.js>; rel=preload; as=script"</font><font color="#990000">>></font>
}, <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<h2 id="_push">Push</h2>
<p>The HTTP/2 protocol introduced the ability to push resources related to the one sent in the response. Cowboy provides two functions for that purpose: <code>cowboy_req:push/3,4</code>.</p>
<p>Push is only available for HTTP/2. Cowboy will automatically ignore push requests if the protocol doesn't support it.</p>
<p>The push function must be called before any of the reply functions. Doing otherwise will result in a crash.</p>
<p>To push a resource, you need to provide the same information as a client performing a request would. This includes the HTTP method, the URI and any necessary request headers.</p>
<p>Cowboy by default only requires you to give the path to the resource and the request headers. The rest of the URI is taken from the current request (excluding the query string, set to empty) and the method is GET by default.</p>
<p>The following snippet pushes a CSS file that is linked to in the response:</p>
<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><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/css"</font><font color="#990000">>></font>
}, <font color="#009900">Req0</font>),
<font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:reply</font></b>(<font color="#993399">200</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/html"</font><font color="#990000">>></font>
}, [<font color="#FF0000">"<html><head><title>My web page</title>"</font>,
<font color="#FF0000">"<link rel='stylesheet' type='text/css' href='/static/style.css'>"</font>,
<font color="#FF0000">"<body><p>Welcome to Erlang!</p></body></html>"</font>], <font color="#009900">Req0</font>)<font color="#990000">.</font></tt></pre>
</div></div>
<p>To override the method, scheme, host, port or query string, simply pass in a fourth argument. The following snippet uses a different host name:</p>
<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><b><font color="#000000">cowboy_req:push</font></b>(<font color="#FF0000">"/static/style.css"</font>, #{
<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/css"</font><font color="#990000">>></font>
}, #{<font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"cdn.example.org"</font><font color="#990000">>></font>}, <font color="#009900">Req</font>),</tt></pre>
</div></div>
<p>Pushed resources don't have to be files. As long as the push request is cacheable, safe and does not include a body, the resource can be pushed.</p>
<p>Under the hood, Cowboy handles pushed requests the same as normal requests: a different process is created which will ultimately send a response to the client.</p>
<nav style="margin:1em 0">
<a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.3/guide/req_body/">
Reading the request body
</a>
<a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.3/guide/cookies/">
Using cookies
</a>
</nav>
</div>
<div class="span3 sidecol">
<h3>
Cowboy
2.3
User Guide
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.3/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.3/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li>
<li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li>
<li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li>
<li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li>
<li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li>
<li><a href="/docs/en/cowboy/1.0/guide">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-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
