From 3f4e79d42f7a81fa3f8e790630f71570287c2be0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johan=20L=C3=B6vdahl?= <johan.lovdahl@uxvibe.com>
Date: Sun, 13 Nov 2016 15:39:40 +0100
Subject: Add functions for getting and setting response headers

---
 doc/src/manual/cowboy_req.resp_header.asciidoc | 61 ++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 doc/src/manual/cowboy_req.resp_header.asciidoc

(limited to 'doc/src/manual/cowboy_req.resp_header.asciidoc')

diff --git a/doc/src/manual/cowboy_req.resp_header.asciidoc b/doc/src/manual/cowboy_req.resp_header.asciidoc
new file mode 100644
index 0000000..84713ef
--- /dev/null
+++ b/doc/src/manual/cowboy_req.resp_header.asciidoc
@@ -0,0 +1,61 @@
+= cowboy_req:resp_header(3)
+
+== Name
+
+cowboy_req:resp_header - Access the named HTTP header set for the response
+
+== Description
+
+[source,erlang]
+----
+resp_header(Name, Req)          -> resp_header(Name, Req, undefined)
+resp_header(Name, Req, Default) -> binary() | Default
+
+Name    :: binary()
+Req     :: cowboy_req:req()
+Default :: any()
+----
+
+Return the currently set response header value for the given HTTP header.
+
+== Arguments
+
+Name::
+
+Desired response HTTP header name as a binary.
+
+Req::
+
+The Req object.
+
+Default::
+
+Default value returned when the header is missing.
+
+== Return value
+
+The binary value for the given HTTP header name.
+
+== Changelog
+
+* *2.0*: Function introduced.
+
+== Examples
+
+.Get the response header with the given name
+[source,erlang]
+----
+HeaderValue = cowboy_req:resp_header(<<"x-test-header">>, Req).
+----
+
+.Get the response header with the given name and a default
+[source,erlang]
+----
+HeaderValue = cowboy_req:resp_header(<<"x-test-header">>, Req, <<"bar">>).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:set_resp_headers(3)[cowboy_req:resp_headers(3)]
+link:man:cowboy_req:set_resp_header(3)[cowboy_req:set_resp_header(3)]
-- 
cgit v1.2.3

