From d7b7580b3913c17b404319cc4c153748d5e59194 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Fri, 9 Nov 2018 17:42:37 +0100
Subject: Add sendfile support to cowboy_req:stream_body

It is now possible to stream one or more sendfile tuples.
A simple example of what can now be done would be for
example to build a tar file on the fly using the sendfile
syscall for sending the files, or to support Range requests
with more than one range with the sendfile syscall.

When using cowboy_compress_h unfortunately we have to read
the file in order to send it. More options will be added
at a later time to make sure users don't read too much
into memory. This is a new feature however so existing
code is not affected.

Also rework cowboy_http's data sending to be flatter.
---
 doc/src/manual/cowboy_req.stream_body.asciidoc | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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

diff --git a/doc/src/manual/cowboy_req.stream_body.asciidoc b/doc/src/manual/cowboy_req.stream_body.asciidoc
index 24f5d97..03e6e70 100644
--- a/doc/src/manual/cowboy_req.stream_body.asciidoc
+++ b/doc/src/manual/cowboy_req.stream_body.asciidoc
@@ -10,7 +10,7 @@ cowboy_req:stream_body - Stream the response body
 ----
 stream_body(Data, IsFin, Req :: cowboy_req:req()) -> ok
 
-Data  :: iodata()
+Data  :: cowboy_req:resp_body()
 IsFin :: fin | nofin
 ----
 
@@ -58,6 +58,7 @@ The atom `ok` is always returned. It can be safely ignored.
 
 == Changelog
 
+* *2.6*: The `Data` argument can now be a sendfile tuple.
 * *2.0*: Function introduced. Replaces `chunk/2`.
 
 == Examples
-- 
cgit v1.2.3

