From 1b863c350ba1f9b8ad1cb458df514ab0fe6bb127 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 11 Dec 2017 11:27:17 +0100 Subject: Add documentation for Cowboy 2.2 --- .../manual/cowboy_req.set_resp_header/index.html | 258 +++++++++++++++++++++ 1 file changed, 258 insertions(+) create mode 100644 docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html (limited to 'docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html') diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html new file mode 100644 index 00000000..a44e3735 --- /dev/null +++ b/docs/en/cowboy/2.2/manual/cowboy_req.set_resp_header/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + Nine Nines: cowboy_req:set_resp_header(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cowboy_req:set_resp_header(3)

+ +
+

Name

+
+

cowboy_req:set_resp_header - Set a response header

+
+
+
+

Description

+
+
+
+
set_resp_header(Name, Value, Req :: cowboy_req:req())
+        -> Req
+
+Name  :: binary()  %% lowercase; case insensitive
+Value :: iodata()  %% case depends on header
+

Set a header 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.

+

Use cowboy_req:set_resp_cookie(3) +instead of this function to set cookies.

+
+
+
+

Arguments

+
+
+
+Name +
+
+

+Header name as a lowercase binary string. +

+
+
+Value +
+
+

+Header value. +

+
+
+Req +
+
+

+The Req object. +

+
+
+
+
+
+

Return value

+
+

A new Req object is returned.

+

The returned Req object must be used from that point onward, +otherwise the header will not be sent in the response.

+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Set a header in the response
+
+
Req = cowboy_req:set_resp_header(<<"allow">>, "GET", Req0).
+
+
Construct a header using iolists
+
+
Req = cowboy_req:set_resp_header(<<"allow">>,
+    [allowed_methods(), ", OPTIONS"], Req0).
+
+
+
+

See also

+
+

cowboy_req(3), +cowboy_req:set_resp_cookie(3), +cowboy_req:set_resp_headers(3), +cowboy_req:has_resp_header(3), +cowboy_req:resp_header(3), +cowboy_req:resp_headers(3), +cowboy_req:delete_resp_header(3), +cowboy_req:reply(3), +cowboy_req:stream_reply(3)

+
+
+ + + + + +
+ +
+ + +

+ Cowboy + 2.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3