umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Code Issues Wiki Activity

Add support for loops in standard HTTP handlers

Browse source 
Now init/3 can return one of the following values to enable loops:
 - {loop, Req, State}
 - {loop, Req, State, hibernate}
 - {loop, Req, State, Timeout}
 - {loop, Req, State, Timeout, hibernate}

Returning one of these tuples will activate looping in the HTTP handler.
When looping, handle/2 is never called. Instead, Cowboy will listen
for Erlang messages and forward them to the info/3 function of the
handler. If a timeout is defined, Cowboy will also close the connection
when no message has been received for Timeout milliseconds.

The info/3 function is defined as info(Msg, Req, State). It can return
either of the following tuples:
 - {ok, Req, State}
 - {loop, Req, State}
 - {loop, Req, State, hibernate}

The first one ends the connection, calling terminate/2 before closing.
The others continue the loop.

Loops are useful when writing long-polling handlers that need to wait
and don't expect to receive anything. Therefore it is recommended to
set a timeout to close the connection if nothing arrives after a while
and to enable hibernate everywhere.

Normal HTTP handlers shouldn't need to use this and as such info/3
was made optional.
This commit is contained in:
Loïc Hoguin 2011-10-10 17:27:52 +02:00
parent 25ae2028d6
commit 5e006be01f
3 changed files with 100 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
test/http_SUITE.erl
View file

@ -97,6 +97,7 @@ init_http_dispatch() ->
{[<<"ws_timeout_hibernate">>], ws_timeout_hibernate_handler, []},
{[<<"ws_init_shutdown">>], websocket_handler_init_shutdown, []},
{[<<"init_shutdown">>], http_handler_init_shutdown, []},
{[<<"long_polling">>], http_handler_long_polling, []},
{[<<"headers">>, <<"dupe">>], http_handler,
[{headers, [{<<"Connection">>, <<"close">>}]}]},
{[], http_handler, []}
@ -227,7 +228,8 @@ raw(Config) ->
{"GET / HTTP/1.1\r\nHost: localhost\r\n\r", 408},
{"GET http://localhost/ HTTP/1.1\r\n\r\n", 501},
{"GET / HTTP/1.2\r\nHost: localhost\r\n\r\n", 505},
{"GET /init_shutdown HTTP/1.1\r\nHost: localhost\r\n\r\n", 666}
{"GET /init_shutdown HTTP/1.1\r\nHost: localhost\r\n\r\n", 666},
{"GET /long_polling HTTP/1.1\r\nHost: localhost\r\n\r\n", 102}
],
[{Packet, StatusCode} = raw_req(Packet, Config)
|| {Packet, StatusCode} <- Tests].

22
test/http_handler_long_polling.erl Normal file
View file

@ -0,0 +1,22 @@
%% Feel free to use, reuse and abuse the code in this file.
-module(http_handler_long_polling).
-behaviour(cowboy_http_handler).
-export([init/3, handle/2, info/3, terminate/2]).
init({_Transport, http}, Req, _Opts) ->
erlang:send_after(500, self(), timeout),
{loop, Req, 9, 5000, hibernate}.
handle(_Req, _State) ->
exit(badarg).
info(timeout, Req, 0) ->
{ok, Req2} = cowboy_http_req:reply(102, [], [], Req),
{ok, Req2, 0};
info(timeout, Req, State) ->
erlang:send_after(500, self(), timeout),
{loop, Req, State - 1, hibernate}.
terminate(_Req, _State) ->
ok.