From 3f4e79d42f7a81fa3f8e790630f71570287c2be0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20L=C3=B6vdahl?= Date: Sun, 13 Nov 2016 15:39:40 +0100 Subject: Add functions for getting and setting response headers --- doc/src/manual/cowboy_req.resp_headers.asciidoc | 45 +++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/src/manual/cowboy_req.resp_headers.asciidoc (limited to 'doc/src/manual/cowboy_req.resp_headers.asciidoc') 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 -- cgit v1.2.3