0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00

Add the {active, boolean()} Websocket command

This command is currently not documented. It allows disabling
the reading of incoming data from the socket, and can be used
as a poor man's flow control.
This commit is contained in:
Loïc Hoguin 2018-09-21 14:04:20 +02:00
parent 6e784f1a45
commit f810d8dd64
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
4 changed files with 52 additions and 1 deletions

View file

@ -26,6 +26,7 @@
all() ->
[{group, ws}, {group, ws_hibernate}].
%% @todo Test against HTTP/2 too.
groups() ->
AllTests = ct_helper:all(?MODULE),
[{ws, [parallel], AllTests}, {ws_hibernate, [parallel], AllTests}].
@ -48,7 +49,8 @@ init_dispatch(Name) ->
cowboy_router:compile([{'_', [
{"/init", ws_init_commands_h, RunOrHibernate},
{"/handle", ws_handle_commands_h, RunOrHibernate},
{"/info", ws_info_commands_h, RunOrHibernate}
{"/info", ws_info_commands_h, RunOrHibernate},
{"/active", ws_active_commands_h, RunOrHibernate}
]}]).
%% Support functions for testing using Gun.
@ -205,3 +207,13 @@ do_many_frames_then_close_frame(Config, Path) ->
{ok, {binary, <<"Two frames!">>}} = receive_ws(ConnPid, StreamRef),
{ok, close} = receive_ws(ConnPid, StreamRef),
gun_down(ConnPid).
websocket_active_false(Config) ->
doc("The {active, false} command stops receiving data from the socket. "
"The {active, true} command reenables it."),
{ok, ConnPid, StreamRef} = gun_open_ws(Config, "/active", []),
gun:ws_send(ConnPid, {text, <<"Not received until the handler enables active again.">>}),
{error, timeout} = receive_ws(ConnPid, StreamRef),
{ok, {text, <<"Not received until the handler enables active again.">>}}
= receive_ws(ConnPid, StreamRef),
ok.