diff options
Diffstat (limited to 'docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html')
-rw-r--r-- | docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html | 118 |
1 files changed, 33 insertions, 85 deletions
diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html index 42961412..600fc5c4 100644 --- a/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html +++ b/docs/en/cowboy/2.2/manual/cowboy_req.stream_trailers/index.html @@ -62,107 +62,55 @@ <h1 class="lined-header"><span>cowboy_req:stream_trailers(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>cowboy_req:stream_trailers - Send the response trailers</p></div> -</div> -</div> -<div class="sect1"> +<p>cowboy_req:stream_trailers - Send the response trailers</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="font-weight: bold"><span style="color: #000000">stream_trailers</span></span>(<span style="color: #009900">Trailers</span>, <span style="color: #009900">Req</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">cowboy_req:req</span></span>()) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> - -<span style="color: #009900">Trailers</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">cowboy:http_headers</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Send the response trailers and terminate the stream.</p></div> -<div class="paragraph"><p>This function can only be called once, after initiating -a response using -<a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a> -and sending zero or more body chunks using -<a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a> -with the <code>nofin</code> argument set. The function <code>stream_trailers/2</code> -implies <code>fin</code> and automatically terminate the response.</p></div> -<div class="paragraph"><p>You must list all field names sent in trailers in the -trailer header, otherwise they might be dropped by intermediaries -or clients.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">stream_trailers</font></b>(<font color="#009900">Trailers</font>, <font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">Trailers</font> <font color="#990000">::</font> <b><font color="#000000">cowboy:http_headers</font></b>()</tt></pre> +</div></div> +<p>Send the response trailers and terminate the stream.</p> +<p>This function can only be called once, after initiating a response using <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a> and sending zero or more body chunks using <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a> with the <code>nofin</code> argument set. The function <code>stream_trailers/2</code> implies <code>fin</code> and automatically terminate the response.</p> +<p>You must list all field names sent in trailers in the trailer header, otherwise they might be dropped by intermediaries or clients.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -Trailers -</dt> -<dd> -<p> -Trailer field values to be sent. -</p> +<dl><dt>Trailers</dt> +<dd><p>Trailer field values to be sent.</p> </dd> -<dt class="hdlist1"> -Req -</dt> -<dd> -<p> -The Req object. -</p> +<dt>Req</dt> +<dd><p>The Req object.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is always returned. It can be safely ignored.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is always returned. It can be safely ignored.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>2.2</strong>: Function introduced. -</p> +<ul><li><strong>2.2</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Stream a response body with trailers</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Stream a response body with trailers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="color: #009900">Req</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">cowboy_req:stream_reply</span></span>(<span style="color: #993399">200</span>, #{ - <span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span> <span style="color: #990000">=></span> <span style="color: #990000"><<</span><span style="color: #FF0000">"text/plain"</span><span style="color: #990000">>></span>, - <span style="color: #990000"><<</span><span style="color: #FF0000">"trailer"</span><span style="color: #990000">>></span> <span style="color: #990000">=></span> <span style="color: #990000"><<</span><span style="color: #FF0000">"expires, content-md5"</span><span style="color: #990000">>></span> -}, <span style="color: #009900">Req0</span>), -<span style="font-weight: bold"><span style="color: #000000">cowboy_req:stream_body</span></span>(<span style="color: #990000"><<</span><span style="color: #FF0000">"Hello\n"</span><span style="color: #990000">>></span>, <span style="color: #FF6600">nofin</span>, <span style="color: #009900">Req</span>), -<span style="font-weight: bold"><span style="color: #000000">timer:sleep</span></span>(<span style="color: #993399">1000</span>), -<span style="font-weight: bold"><span style="color: #000000">cowboy_req:stream_body</span></span>(<span style="color: #990000"><<</span><span style="color: #FF0000">"World!\n"</span><span style="color: #990000">>></span>, <span style="color: #FF6600">nofin</span>, <span style="color: #009900">Req</span>)<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #000000">cowboy_req:stream_trailers</span></span>(#{ - <span style="color: #990000"><<</span><span style="color: #FF0000">"expires"</span><span style="color: #990000">>></span> <span style="color: #990000">=></span> <span style="color: #990000"><<</span><span style="color: #FF0000">"Sun, 10 Dec 2017 19:13:47 GMT"</span><span style="color: #990000">>></span>, - <span style="color: #990000"><<</span><span style="color: #FF0000">"content-md5"</span><span style="color: #990000">>></span> <span style="color: #990000">=></span> <span style="color: #990000"><<</span><span style="color: #FF0000">"fbf68a8e34b2ded53bba54e68794b4fe"</span><span style="color: #990000">>></span> -}, <span style="color: #009900">Req</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:stream_reply</font></b>(<font color="#993399">200</font>, #{ + <font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"trailer"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"expires, content-md5"</font><font color="#990000">>></font> +}, <font color="#009900">Req0</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"Hello\n"</font><font color="#990000">>></font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>), +<b><font color="#000000">timer:sleep</font></b>(<font color="#993399">1000</font>), +<b><font color="#000000">cowboy_req:stream_body</font></b>(<font color="#990000"><<</font><font color="#FF0000">"World!\n"</font><font color="#990000">>></font>, <font color="#FF6600">nofin</font>, <font color="#009900">Req</font>)<font color="#990000">.</font> +<b><font color="#000000">cowboy_req:stream_trailers</font></b>(#{ + <font color="#990000"><<</font><font color="#FF0000">"expires"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"Sun, 10 Dec 2017 19:13:47 GMT"</font><font color="#990000">>></font>, + <font color="#990000"><<</font><font color="#FF0000">"content-md5"</font><font color="#990000">>></font> <font color="#990000">=></font> <font color="#990000"><<</font><font color="#FF0000">"fbf68a8e34b2ded53bba54e68794b4fe"</font><font color="#990000">>></font> +}, <font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../cowboy_req">cowboy_req(3)</a>, -<a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, -<a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a></p></div> -</div> -</div> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.stream_reply">cowboy_req:stream_reply(3)</a>, <a href="../cowboy_req.stream_body">cowboy_req:stream_body(3)</a></p> + |