path: root/test/ws_SUITE_data
diff options
authorLoïc Hoguin <[email protected]>2017-02-18 18:26:20 +0100
committerLoïc Hoguin <[email protected]>2017-02-18 18:26:20 +0100
commita45813c60f0f983a24ea29d491b37f0590fdd087 (patch)
treec7e741ac4a684b365e70f7ff73d0c4b6e34232a7 /test/ws_SUITE_data
parent80f8cda7ff8fe6a575b4c2eaedd8451acf4fcef3 (diff)
Allow passing options to sub protocols
Before this commit we had an issue where configuring a Websocket connection was simply not possible without doing magic, adding callbacks or extra return values. The init/2 function only allowed setting hibernate and timeout options. After this commit, when switching to a different type of handler you can either return {module, Req, State} or {module, Req, State, Opts} where Opts is any value (as far as the sub protocol interface is concerned) and is ultimately checked by the custom handlers. A large protocol like Websocket would accept only a map there, with many different options, while a small interface like loop handlers would allow passing hibernate and nothing else. For Websocket, hibernate must be set from the websocket_init/1 callback, because init/2 executes in a separate process. Sub protocols now have two callbacks: one with the Opts value, one without. The loop handler code was largely reworked and simplified. It does not need to manage a timeout or read from the socket anymore, it's the job of the protocol code. A lot of unnecessary stuff was therefore removed. Websocket compression must now be enabled from the handler options instead of per listener. This means that a project can have two separate Websocket handlers with different options. Compression is still disabled by default, and the idle_timeout value was changed from inifnity to 60000 (60 seconds), as that's safer and is also a good value for mobile devices.
Diffstat (limited to 'test/ws_SUITE_data')
4 files changed, 16 insertions, 4 deletions
diff --git a/test/ws_SUITE_data/ws_echo.erl b/test/ws_SUITE_data/ws_echo.erl
index 4b832df..a94b4c0 100644
--- a/test/ws_SUITE_data/ws_echo.erl
+++ b/test/ws_SUITE_data/ws_echo.erl
@@ -7,7 +7,9 @@
init(Req, _) ->
- {cowboy_websocket, Req, undefined}.
+ {cowboy_websocket, Req, undefined, #{
+ compress => true
+ }}.
websocket_handle({text, Data}, State) ->
{reply, {text, Data}, State};
diff --git a/test/ws_SUITE_data/ws_subprotocol.erl b/test/ws_SUITE_data/ws_subprotocol.erl
index 3079bc6..1c9aefc 100644
--- a/test/ws_SUITE_data/ws_subprotocol.erl
+++ b/test/ws_SUITE_data/ws_subprotocol.erl
@@ -9,7 +9,9 @@
init(Req, Opts) ->
[Protocol | _] = cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req),
Req2 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, Protocol, Req),
- {cowboy_websocket, Req2, Opts, 1000}.
+ {cowboy_websocket, Req2, Opts, #{
+ idle_timeout => 1000
+ }}.
websocket_handle(_Frame, State) ->
{ok, State}.
diff --git a/test/ws_SUITE_data/ws_timeout_cancel.erl b/test/ws_SUITE_data/ws_timeout_cancel.erl
index 8883d2f..587f2c5 100644
--- a/test/ws_SUITE_data/ws_timeout_cancel.erl
+++ b/test/ws_SUITE_data/ws_timeout_cancel.erl
@@ -8,7 +8,9 @@
init(Req, _) ->
erlang:start_timer(500, self(), should_not_cancel_timer),
- {cowboy_websocket, Req, undefined, 1000}.
+ {cowboy_websocket, Req, undefined, #{
+ idle_timeout => 1000
+ }}.
websocket_handle({text, Data}, State) ->
{reply, {text, Data}, State};
diff --git a/test/ws_SUITE_data/ws_timeout_hibernate.erl b/test/ws_SUITE_data/ws_timeout_hibernate.erl
index b9646ac..77f8348 100644
--- a/test/ws_SUITE_data/ws_timeout_hibernate.erl
+++ b/test/ws_SUITE_data/ws_timeout_hibernate.erl
@@ -3,11 +3,17 @@
init(Req, _) ->
- {cowboy_websocket, Req, undefined, 1000, hibernate}.
+ {cowboy_websocket, Req, undefined, #{
+ idle_timeout => 1000
+ }}.
+websocket_init(State) ->
+ {ok, State, hibernate}.
websocket_handle(_Frame, State) ->
{ok, State, hibernate}.