umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 05:00:24 +00:00
Code Issues Wiki Activity

Improve the manual for the new resp_header functions

Browse source
This commit is contained in:
Loïc Hoguin 2017-01-04 19:21:23 +01:00
parent 3f4e79d42f
commit f34ef2ceae
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
11 changed files with 79 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

45
doc/src/manual/cowboy_req.set_resp_headers.asciidoc
View file

@ -8,22 +8,32 @@ cowboy_req:set_resp_headers - Set several response headers
[source,erlang]
----
set_resp_headers(Headers, Req) -> cowboy_req:req()
set_resp_headers(Headers, Req :: cowboy_req:req())
-> Req
Headers :: cowboy:http_headers()
Req :: cowboy_req:req()
----
Add all given headers to the response headers.
If a given header key already exists in the currently set
response-header map the given value will overwrite the old.
Set several headers to be sent with the response.
The header name must be given as a lowercase binary string.
While header names are case insensitive, Cowboy requires them
to be given as lowercase to function properly.
Cowboy does not allow duplicate header names. Headers set
by this function may be overwritten by those set from the
reply functions. Likewise, headers set by this function may
overwrite headers that were set previously.
Use link:man:cowboy_req:set_resp_cookie(3)[cowboy_req:set_resp_cookie(3)]
instead of this function to set cookies.
== Arguments
Headers::
A map with keys and values as binary strings.
Key values should be lowercase to function properly.
Headers as a map with keys being lowercase binary strings,
and values as binary strings.
Req::
@ -31,7 +41,10 @@ The Req object.
== Return value
A request object updated with the given response headers.
A new Req object is returned.
The returned Req object must be used from that point onward,
otherwise the headers will not be sent in the response.
== Changelog
@ -39,13 +52,23 @@ A request object updated with the given response headers.
== Examples
.Get all response headers
.Set several response headers
[source,erlang]
----
Req1 = cowboy_req:set_resp_headers(#{<<"x-header-test">> => <<"1">>}, Req0).
Req = cowboy_req:set_resp_headers(#{
<<"content-type">> => <<"text/html">>,
<<"content-encoding">> => <<"gzip">>
}, Req0).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:resp_headers(3)[cowboy_req:resp_headers(3)]
link:man:cowboy_req:set_resp_cookie(3)[cowboy_req:set_resp_cookie(3)],
link:man:cowboy_req:set_resp_header(3)[cowboy_req:set_resp_header(3)],
link:man:cowboy_req:has_resp_header(3)[cowboy_req:has_resp_header(3)],
link:man:cowboy_req:resp_header(3)[cowboy_req:resp_header(3)],
link:man:cowboy_req:resp_headers(3)[cowboy_req:resp_headers(3)],
link:man:cowboy_req:delete_resp_header(3)[cowboy_req:delete_resp_header(3)],
link:man:cowboy_req:reply(3)[cowboy_req:reply(3)],
link:man:cowboy_req:stream_reply(3)[cowboy_req:stream_reply(3)]