umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 05:00:24 +00:00
Code Issues Wiki Activity

Add chunked response body fun

Browse source 
Adds a new type of streaming response fun. It can be set in a similar
way to a streaming body fun with known length:

Req2 = cowboy_req:set_resp_body_fun(chunked, StreamFun, Req)

The fun, StreamFun, should accept a fun as its single argument. This
fun, ChunkFun, is used to send chunks of iodata:

ok = ChunkFun(IoData)

ChunkFun should not be called with an empty binary or iolist as this
will cause HTTP 1.1 clients to believe the stream is over. The final (0
length) chunk will be sent automatically - even if it has already been
sent - assuming no exception is raised.

Also note that the connection will close after the last chunk for HTTP
1.0 clients.
This commit is contained in:
James Fish 2013-02-18 21:20:36 +00:00
parent 46b2ea0aaa
commit c8242ab396
4 changed files with 102 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

47
test/http_SUITE.erl
View file

@ -82,6 +82,8 @@
-export([static_test_file_css/1]).
-export([stream_body_set_resp/1]).
-export([stream_body_set_resp_close/1]).
-export([stream_body_set_resp_chunked/1]).
-export([stream_body_set_resp_chunked10/1]).
-export([te_chunked/1]).
-export([te_chunked_chopped/1]).
-export([te_chunked_delayed/1]).
@ -153,6 +155,8 @@ groups() ->
static_test_file_css,
stream_body_set_resp,
stream_body_set_resp_close,
stream_body_set_resp_chunked,
stream_body_set_resp_chunked10,
te_chunked,
te_chunked_chopped,
te_chunked_delayed,
@ -338,6 +342,10 @@ init_dispatch(Config) ->
http_stream_body, [
{reply, set_resp_close},
{body, <<"stream_body_set_resp_close">>}]},
{"/stream_body/set_resp_chunked",
http_stream_body, [
{reply, set_resp_chunked},
{body, [<<"stream_body">>, <<"_set_resp_chunked">>]}]},
{"/static/[...]", cowboy_static,
[{directory, ?config(static_dir, Config)},
{mimetypes, [{<<".css">>, [<<"text/css">>]}]}]},
@ -1211,6 +1219,45 @@ stream_body_set_resp_close(Config) ->
end,
{error, closed} = Transport:recv(Socket, 0, 1000).
stream_body_set_resp_chunked(Config) ->
Client = ?config(client, Config),
{ok, Client2} = cowboy_client:request(<<"GET">>,
build_url("/stream_body/set_resp_chunked", Config), Client),
{ok, 200, Headers, Client3} = cowboy_client:response(Client2),
{_, <<"chunked">>} = lists:keyfind(<<"transfer-encoding">>, 1, Headers),
{ok, Transport, Socket} = cowboy_client:transport(Client3),
case element(7, Client3) of
<<"B\r\nstream_body\r\n11\r\n_set_resp_chunked\r\n0\r\n\r\n">> ->
ok;
Buffer ->
{ok, Rest} = Transport:recv(Socket, 44 - byte_size(Buffer), 1000),
<<"B\r\nstream_body\r\n11\r\n_set_resp_chunked\r\n0\r\n\r\n">>
= <<Buffer/binary, Rest/binary>>,
ok
end.
stream_body_set_resp_chunked10(Config) ->
Client = ?config(client, Config),
Transport = ?config(transport, Config),
{ok, Client2} = cowboy_client:connect(
Transport, "localhost", ?config(port, Config), Client),
Data = ["GET /stream_body/set_resp_chunked HTTP/1.0\r\n",
"Host: localhost\r\n\r\n"],
{ok, Client3} = cowboy_client:raw_request(Data, Client2),
{ok, 200, Headers, Client4} = cowboy_client:response(Client3),
false = lists:keymember(<<"transfer-encoding">>, 1, Headers),
{ok, Transport, Socket} = cowboy_client:transport(Client4),
case element(7, Client4) of
<<"stream_body_set_resp_chunked">> ->
ok;
Buffer ->
{ok, Rest} = Transport:recv(Socket, 28 - byte_size(Buffer), 1000),
<<"stream_body_set_resp_chunked">>
= <<Buffer/binary, Rest/binary>>,
ok
end,
{error, closed} = Transport:recv(Socket, 0, 1000).
te_chunked(Config) ->
Client = ?config(client, Config),
Body = list_to_binary(io_lib:format("~p", [lists:seq(1, 100)])),

6
test/http_SUITE_data/http_stream_body.erl
View file

@ -19,7 +19,11 @@ handle(Req, State=#state{headers=_Headers, body=Body, reply=Reply}) ->
SLen = iolist_size(Body),
cowboy_req:set_resp_body_fun(SLen, SFun, Req);
set_resp_close ->
cowboy_req:set_resp_body_fun(SFun, Req)
cowboy_req:set_resp_body_fun(SFun, Req);
set_resp_chunked ->
%% Here Body should be a list of chunks, not a binary.
SFun2 = fun(SendFun) -> lists:foreach(SendFun, Body) end,
cowboy_req:set_resp_body_fun(chunked, SFun2, Req)
end,
{ok, Req3} = cowboy_req:reply(200, Req2),
{ok, Req3, State}.