diff options
author | Loïc Hoguin <[email protected]> | 2017-02-18 18:26:20 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2017-02-18 18:26:20 +0100 |
commit | a45813c60f0f983a24ea29d491b37f0590fdd087 (patch) | |
tree | c7e741ac4a684b365e70f7ff73d0c4b6e34232a7 /src/cowboy_loop.erl | |
parent | 80f8cda7ff8fe6a575b4c2eaedd8451acf4fcef3 (diff) | |
download | cowboy-a45813c60f0f983a24ea29d491b37f0590fdd087.tar.gz cowboy-a45813c60f0f983a24ea29d491b37f0590fdd087.tar.bz2 cowboy-a45813c60f0f983a24ea29d491b37f0590fdd087.zip |
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 'src/cowboy_loop.erl')
-rw-r--r-- | src/cowboy_loop.erl | 126 |
1 files changed, 32 insertions, 94 deletions
diff --git a/src/cowboy_loop.erl b/src/cowboy_loop.erl index 117446a..7492350 100644 --- a/src/cowboy_loop.erl +++ b/src/cowboy_loop.erl @@ -12,27 +12,18 @@ %% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF %% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -%% When using loop handlers, we are receiving data from the socket because we -%% want to know when the socket gets closed. This is generally not an issue -%% because these kinds of requests are generally not pipelined, and don't have -%% a body. If they do have a body, this body is often read in the -%% <em>init/2</em> callback and this is no problem. Otherwise, this data -%% accumulates in a buffer until we reach a certain threshold of 5000 bytes -%% by default. This can be configured through the <em>loop_max_buffer</em> -%% environment value. The request will be terminated with an -%% <em>{error, overflow}</em> reason if this threshold is reached. -module(cowboy_loop). -behaviour(cowboy_sub_protocol). --export([upgrade/6]). +-export([upgrade/4]). +-export([upgrade/5]). -export([loop/4]). -callback init(Req, any()) -> {ok | module(), Req, any()} - | {module(), Req, any(), hibernate} - | {module(), Req, any(), timeout()} - | {module(), Req, any(), timeout(), hibernate} + | {module(), Req, any(), any()} when Req::cowboy_req:req(). + -callback info(any(), Req, State) -> {ok, Req, State} | {ok, Req, State, hibernate} @@ -42,97 +33,44 @@ -callback terminate(any(), cowboy_req:req(), any()) -> ok. -optional_callbacks([terminate/3]). --record(state, { - env :: cowboy_middleware:env(), - hibernate = false :: boolean(), - buffer_size = 0 :: non_neg_integer(), - max_buffer = 5000 :: non_neg_integer() | infinity, - timeout = infinity :: timeout(), - timeout_ref = undefined :: undefined | reference() -}). - --spec upgrade(Req, Env, module(), any(), timeout(), run | hibernate) - -> {ok, Req, Env} | {suspend, module(), atom(), [any()]} +-spec upgrade(Req, Env, module(), any()) + -> {ok, Req, Env} | {suspend, ?MODULE, loop, [any()]} when Req::cowboy_req:req(), Env::cowboy_middleware:env(). -upgrade(Req, Env, Handler, HandlerState, Timeout, Hibernate) -> - State = #state{env=Env, max_buffer=get_max_buffer(Env), timeout=Timeout, - hibernate=Hibernate =:= hibernate}, - State2 = timeout(State), - before_loop(Req, State2, Handler, HandlerState). - -get_max_buffer(#{loop_max_buffer := MaxBuffer}) -> MaxBuffer; -get_max_buffer(_) -> 5000. - -before_loop(Req, State=#state{hibernate=true}, Handler, HandlerState) -> - - %% @todo Yeah we can't get the socket anymore. - %% Everything changes since we are a separate process now. - %% Proper flow control at the connection level should be implemented - %% instead of what we have here. - -% [Socket, Transport] = cowboy_req:get([socket, transport], Req), -% Transport:setopts(Socket, [{active, once}]), - {suspend, ?MODULE, loop, [Req, State#state{hibernate=false}, Handler, HandlerState]}; -before_loop(Req, State, Handler, HandlerState) -> - - %% Same here. - -% [Socket, Transport] = cowboy_req:get([socket, transport], Req), -% Transport:setopts(Socket, [{active, once}]), - loop(Req, State, Handler, HandlerState). +upgrade(Req, Env, Handler, HandlerState) -> + loop(Req, Env, Handler, HandlerState). -%% Almost the same code can be found in cowboy_websocket. -timeout(State=#state{timeout=infinity}) -> - State#state{timeout_ref=undefined}; -timeout(State=#state{timeout=Timeout, - timeout_ref=PrevRef}) -> - _ = case PrevRef of - undefined -> ignore%; -% @todo PrevRef -> erlang:cancel_timer(PrevRef) - end, - TRef = erlang:start_timer(Timeout, self(), ?MODULE), - State#state{timeout_ref=TRef}. +-spec upgrade(Req, Env, module(), any(), hibernate) + -> {suspend, ?MODULE, loop, [any()]} + when Req::cowboy_req:req(), Env::cowboy_middleware:env(). +upgrade(Req, Env, Handler, HandlerState, hibernate) -> + suspend(Req, Env, Handler, HandlerState). --spec loop(Req, #state{}, module(), any()) - -> {ok, Req, cowboy_middleware:env()} | {suspend, module(), atom(), [any()]} - when Req::cowboy_req:req(). -loop(Req, State=#state{timeout_ref=TRef}, Handler, HandlerState) -> +-spec loop(Req, Env, module(), any()) + -> {ok, Req, Env} | {suspend, ?MODULE, loop, [any()]} + when Req::cowboy_req:req(), Env::cowboy_middleware:env(). +%% @todo Handle system messages. +loop(Req, Env, Handler, HandlerState) -> receive - {timeout, TRef, ?MODULE} -> - terminate(Req, State, Handler, HandlerState, timeout); - {timeout, OlderTRef, ?MODULE} when is_reference(OlderTRef) -> - loop(Req, State, Handler, HandlerState); Message -> - call(Req, State, Handler, HandlerState, Message) + call(Req, Env, Handler, HandlerState, Message) end. -call(Req, State, Handler, HandlerState, Message) -> - try Handler:info(Message, Req, HandlerState) of - {ok, Req2, HandlerState2} -> - before_loop(Req2, State, Handler, HandlerState2); - {ok, Req2, HandlerState2, hibernate} -> - before_loop(Req2, State#state{hibernate=true}, Handler, HandlerState2); - {stop, Req2, HandlerState2} -> - terminate(Req2, State, Handler, HandlerState2, stop) +call(Req0, Env, Handler, HandlerState0, Message) -> + try Handler:info(Message, Req0, HandlerState0) of + {ok, Req, HandlerState} -> + loop(Req, Env, Handler, HandlerState); + {ok, Req, HandlerState, hibernate} -> + suspend(Req, Env, Handler, HandlerState); + {stop, Req, HandlerState} -> + terminate(Req, Env, Handler, HandlerState, stop) catch Class:Reason -> - cowboy_handler:terminate({crash, Class, Reason}, Req, HandlerState, Handler), + cowboy_handler:terminate({crash, Class, Reason}, Req0, HandlerState0, Handler), erlang:raise(Class, Reason, erlang:get_stacktrace()) end. -terminate(Req, #state{env=Env, timeout_ref=TRef}, - Handler, HandlerState, Reason) -> - _ = case TRef of - undefined -> ignore; - TRef -> erlang:cancel_timer(TRef) - end, - flush_timeouts(), +suspend(Req, Env, Handler, HandlerState) -> + {suspend, ?MODULE, loop, [Req, Env, Handler, HandlerState]}. + +terminate(Req, Env, Handler, HandlerState, Reason) -> Result = cowboy_handler:terminate(Reason, Req, HandlerState, Handler), {ok, Req, Env#{result => Result}}. - -flush_timeouts() -> - receive - {timeout, TRef, ?MODULE} when is_reference(TRef) -> - flush_timeouts() - after 0 -> - ok - end. |