2024-01-25 11:22:54 +01:00
|
|
|
%% Copyright (c) 2013-2024, Loïc Hoguin <essen@ninenines.eu>
|
2013-02-15 00:53:40 +00:00
|
|
|
%% Copyright (c) 2013, James Fish <james@fishcakez.com>
|
|
|
|
|
%%
|
|
|
|
|
%% Permission to use, copy, modify, and/or distribute this software for any
|
|
|
|
|
%% purpose with or without fee is hereby granted, provided that the above
|
|
|
|
|
%% copyright notice and this permission notice appear in all copies.
|
|
|
|
|
%%
|
|
|
|
|
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
|
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
|
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
|
|
|
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
|
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
|
|
|
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
|
|
|
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
|
|
|
|
|
|
-module(cowboy_sub_protocol).
|
|
|
|
|
|
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.
2017-02-18 18:26:20 +01:00
|
|
|
-callback upgrade(Req, Env, module(), any())
|
|
|
|
|
-> {ok, Req, Env} | {suspend, module(), atom(), [any()]} | {stop, Req}
|
|
|
|
|
when Req::cowboy_req:req(), Env::cowboy_middleware:env().
|
|
|
|
|
|
|
|
|
|
-callback upgrade(Req, Env, module(), any(), any())
|
2014-11-07 20:19:05 +02:00
|
|
|
-> {ok, Req, Env} | {suspend, module(), atom(), [any()]} | {stop, Req}
|
2013-02-15 00:53:40 +00:00
|
|
|
when Req::cowboy_req:req(), Env::cowboy_middleware:env().
|