From d2a3f2cedd7c00d0933222aed9c06b3149aa4db4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 4 Apr 2018 13:13:37 +0200 Subject: Cowboy 2.3.0 --- .../manual/cowboy_req.stream_trailers/index.html | 246 +++++++++++++++++++++ 1 file changed, 246 insertions(+) create mode 100644 docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html (limited to 'docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html') diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html new file mode 100644 index 00000000..eb092277 --- /dev/null +++ b/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/index.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + Nine Nines: cowboy_req:stream_trailers(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

cowboy_req:stream_trailers(3)

+ +
+

Name

+
+

cowboy_req:stream_trailers - Send the response trailers

+
+
+
+

Description

+
+
+
+
stream_trailers(Trailers, Req :: cowboy_req:req()) -> ok
+
+Trailers :: cowboy:http_headers()
+

Send the response trailers and terminate the stream.

+

This function can only be called once, after initiating +a response using +cowboy_req:stream_reply(3) +and sending zero or more body chunks using +cowboy_req:stream_body(3) +with the nofin argument set. The function stream_trailers/2 +implies fin and automatically terminate the response.

+

You must list all field names sent in trailers in the +trailer header, otherwise they might be dropped by intermediaries +or clients.

+
+
+
+

Arguments

+
+
+
+Trailers +
+
+

+Trailer field values to be sent. +

+
+
+Req +
+
+

+The Req object. +

+
+
+
+
+
+

Return value

+
+

The atom ok is always returned. It can be safely ignored.

+
+
+
+

Changelog

+
+
    +
  • +

    +2.2: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Stream a response body with trailers
+
+
Req = cowboy_req:stream_reply(200, #{
+    <<"content-type">> => <<"text/plain">>,
+    <<"trailer">> => <<"expires, content-md5">>
+}, Req0),
+cowboy_req:stream_body(<<"Hello\n">>, nofin, Req),
+timer:sleep(1000),
+cowboy_req:stream_body(<<"World!\n">>, nofin, Req).
+cowboy_req:stream_trailers(#{
+    <<"expires">> => <<"Sun, 10 Dec 2017 19:13:47 GMT">>,
+    <<"content-md5">> => <<"fbf68a8e34b2ded53bba54e68794b4fe">>
+}, Req).
+
+
+
+

See also

+
+

cowboy_req(3), +cowboy_req:stream_reply(3), +cowboy_req:stream_body(3)

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

+ Cowboy + 2.3 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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