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

Add the set_options Websocket command

It allows overriding the idle_timeout option only for now.
This commit is contained in:
Loïc Hoguin 2018-11-16 13:48:15 +01:00
parent 75045637fc
commit f5015cb14b
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
3 changed files with 59 additions and 1 deletions

View file

@ -34,6 +34,7 @@
-type commands() :: [cow_ws:frame() -type commands() :: [cow_ws:frame()
| {active, boolean()} | {active, boolean()}
| {deflate, boolean()} | {deflate, boolean()}
| {set_options, map()}
]. ].
-export_type([commands/0]). -export_type([commands/0]).
@ -527,6 +528,14 @@ commands([{active, Active}|Tail], State, Data) when is_boolean(Active) ->
commands(Tail, State#state{active=Active}, Data); commands(Tail, State#state{active=Active}, Data);
commands([{deflate, Deflate}|Tail], State, Data) when is_boolean(Deflate) -> commands([{deflate, Deflate}|Tail], State, Data) when is_boolean(Deflate) ->
commands(Tail, State#state{deflate=Deflate}, Data); commands(Tail, State#state{deflate=Deflate}, Data);
commands([{set_options, SetOpts}|Tail], State0=#state{opts=Opts}, Data) ->
State = case SetOpts of
#{idle_timeout := IdleTimeout} ->
loop_timeout(State0#state{opts=Opts#{idle_timeout => IdleTimeout}});
_ ->
State0
end,
commands(Tail, State, Data);
commands([Frame|Tail], State, Data0) -> commands([Frame|Tail], State, Data0) ->
Data = [frame(Frame, State)|Data0], Data = [frame(Frame, State)|Data0],
case is_close_frame(Frame) of case is_close_frame(Frame) of

View file

@ -0,0 +1,20 @@
%% This module sets options based on the frame received.
-module(ws_set_options_commands_h).
-behavior(cowboy_websocket).
-export([init/2]).
-export([websocket_handle/2]).
-export([websocket_info/2]).
init(Req, RunOrHibernate) ->
{cowboy_websocket, Req, RunOrHibernate,
#{idle_timeout => infinity}}.
websocket_handle(Frame={text, <<"idle_timeout_short">>}, State=run) ->
{[{set_options, #{idle_timeout => 500}}, Frame], State};
websocket_handle(Frame={text, <<"idle_timeout_short">>}, State=hibernate) ->
{[{set_options, #{idle_timeout => 500}}, Frame], State, hibernate}.
websocket_info(_Info, State) ->
{[], State}.

View file

@ -51,7 +51,8 @@ init_dispatch(Name) ->
{"/handle", ws_handle_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}, {"/active", ws_active_commands_h, RunOrHibernate},
{"/deflate", ws_deflate_commands_h, RunOrHibernate} {"/deflate", ws_deflate_commands_h, RunOrHibernate},
{"/set_options", ws_set_options_commands_h, RunOrHibernate}
]}]). ]}]).
%% Support functions for testing using Gun. %% Support functions for testing using Gun.
@ -257,3 +258,31 @@ websocket_deflate_ignore_if_not_negotiated(Config) ->
{ok, {text, <<"Hello.">>}} = receive_ws(ConnPid, StreamRef) {ok, {text, <<"Hello.">>}} = receive_ws(ConnPid, StreamRef)
end || _ <- lists:seq(1, 10)], end || _ <- lists:seq(1, 10)],
ok. ok.
websocket_set_options_idle_timeout(Config) ->
doc("The idle_timeout option can be modified using the "
"command {set_options, Opts} at runtime."),
ConnPid = gun_open(Config),
StreamRef = gun:ws_upgrade(ConnPid, "/set_options"),
receive
{gun_upgrade, ConnPid, StreamRef, [<<"websocket">>], _} ->
ok;
{gun_response, ConnPid, _, _, Status, Headers} ->
exit({ws_upgrade_failed, Status, Headers});
{gun_error, ConnPid, StreamRef, Reason} ->
exit({ws_upgrade_failed, Reason})
after 1000 ->
error(timeout)
end,
%% We don't send anything for a short while and confirm
%% that idle_timeout does not trigger.
{error, timeout} = gun:await(ConnPid, StreamRef, 2000),
%% Trigger the change in idle_timeout and confirm that
%% the connection gets closed soon after.
gun:ws_send(ConnPid, {text, <<"idle_timeout_short">>}),
receive
{gun_down, ConnPid, _, _, _, _} ->
ok
after 2000 ->
error(timeout)
end.