diff options
author | Johan Lövdahl <[email protected]> | 2016-11-13 15:39:40 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2017-01-04 13:37:50 +0100 |
commit | 3f4e79d42f7a81fa3f8e790630f71570287c2be0 (patch) | |
tree | f3024f163a6a085e0fa35fa50c53cdff0a69a7e8 /doc/src/manual/cowboy_req.resp_headers.asciidoc | |
parent | 42c95b1584c245d73e6ddc052a922c8e7c68dee2 (diff) | |
download | cowboy-3f4e79d42f7a81fa3f8e790630f71570287c2be0.tar.gz cowboy-3f4e79d42f7a81fa3f8e790630f71570287c2be0.tar.bz2 cowboy-3f4e79d42f7a81fa3f8e790630f71570287c2be0.zip |
Add functions for getting and setting response headers
Diffstat (limited to 'doc/src/manual/cowboy_req.resp_headers.asciidoc')
-rw-r--r-- | doc/src/manual/cowboy_req.resp_headers.asciidoc | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.resp_headers.asciidoc b/doc/src/manual/cowboy_req.resp_headers.asciidoc new file mode 100644 index 0000000..804c0d0 --- /dev/null +++ b/doc/src/manual/cowboy_req.resp_headers.asciidoc @@ -0,0 +1,45 @@ += cowboy_req:resp_headers(3) + +== Name + +cowboy_req:resp_headers - Access HTTP headers set for the response + +== Description + +[source,erlang] +---- +resp_headers(Req) -> cowboy:http_headers() + +Req :: cowboy_req:req() +---- + +Return all HTTP response headers. + +== Arguments + +Req:: + +The Req object. + +== Return value + +Headers are returned as a map with keys being lowercase +binary strings, and values as binary strings. +If no response headers have been added the empty map is returned. + +== Changelog + +* *2.0*: Function introduced. + +== Examples + +.Get all response headers +[source,erlang] +---- +Headers = cowboy_req:resp_headers(Req). +---- + +== See also + +link:man:cowboy_req(3)[cowboy_req(3)], +link:man:cowboy_req:set_resp_headers(3)[cowboy_req:set_resp_headers(3)]
\ No newline at end of file |