mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-16 05:00:24 +00:00
Allow HTTP protocol upgrades to use keepalive
REST needed this to be allowed to chain requests on the same connection.
This commit is contained in:
Loïc Hoguin
parent
7f46e53436
commit
8d2102fe11
4 changed files with 79 additions and 48 deletions
|
|
@ -64,7 +64,7 @@
|
|||
%% You do not need to call this function manually. To upgrade to the WebSocket
|
||||
%% protocol, you simply need to return <em>{upgrade, protocol, {@module}}</em>
|
||||
%% in your <em>cowboy_http_handler:init/3</em> handler function.
|
||||
-spec upgrade(pid(), module(), any(), #http_req{}) -> ok | none().
|
||||
-spec upgrade(pid(), module(), any(), #http_req{}) -> closed | none().
|
||||
upgrade(ListenerPid, Handler, Opts, Req) ->
|
||||
cowboy_listener:move_connection(ListenerPid, websocket, self()),
|
||||
case catch websocket_upgrade(#state{handler=Handler, opts=Opts}, Req) of
|
||||
|
|
@ -113,7 +113,7 @@ websocket_upgrade(Version, State, Req)
|
|||
IntVersion = list_to_integer(binary_to_list(Version)),
|
||||
{ok, State#state{version=IntVersion, challenge=Challenge}, Req2}.
|
||||
|
||||
-spec handler_init(#state{}, #http_req{}) -> ok | none().
|
||||
-spec handler_init(#state{}, #http_req{}) -> closed | none().
|
||||
handler_init(State=#state{handler=Handler, opts=Opts},
|
||||
Req=#http_req{transport=Transport}) ->
|
||||
try Handler:websocket_init(Transport:name(), Req, Opts) of
|
||||
|
|
@ -139,31 +139,27 @@ handler_init(State=#state{handler=Handler, opts=Opts},
|
|||
[Handler, Class, Reason, Opts, Req, erlang:get_stacktrace()])
|
||||
end.
|
||||
|
||||
-spec upgrade_error(#http_req{}) -> ok.
|
||||
-spec upgrade_error(#http_req{}) -> closed.
|
||||
upgrade_error(Req) ->
|
||||
{ok, Req2} = cowboy_http_req:reply(400, [], [],
|
||||
{ok, _Req2} = cowboy_http_req:reply(400, [], [],
|
||||
Req#http_req{resp_state=waiting}),
|
||||
upgrade_terminate(Req2).
|
||||
closed.
|
||||
|
||||
%% @see cowboy_http_protocol:ensure_response/1
|
||||
-spec upgrade_denied(#http_req{}) -> ok.
|
||||
upgrade_denied(Req=#http_req{resp_state=done}) ->
|
||||
upgrade_terminate(Req);
|
||||
-spec upgrade_denied(#http_req{}) -> closed.
|
||||
upgrade_denied(#http_req{resp_state=done}) ->
|
||||
closed;
|
||||
upgrade_denied(Req=#http_req{resp_state=waiting}) ->
|
||||
{ok, Req2} = cowboy_http_req:reply(400, [], [], Req),
|
||||
upgrade_terminate(Req2);
|
||||
upgrade_denied(Req=#http_req{method='HEAD', resp_state=chunks}) ->
|
||||
upgrade_terminate(Req);
|
||||
upgrade_denied(Req=#http_req{socket=Socket, transport=Transport,
|
||||
{ok, _Req2} = cowboy_http_req:reply(400, [], [], Req),
|
||||
closed;
|
||||
upgrade_denied(#http_req{method='HEAD', resp_state=chunks}) ->
|
||||
closed;
|
||||
upgrade_denied(#http_req{socket=Socket, transport=Transport,
|
||||
resp_state=chunks}) ->
|
||||
Transport:send(Socket, <<"0\r\n\r\n">>),
|
||||
upgrade_terminate(Req).
|
||||
closed.
|
||||
|
||||
-spec upgrade_terminate(#http_req{}) -> ok.
|
||||
upgrade_terminate(#http_req{socket=Socket, transport=Transport}) ->
|
||||
Transport:close(Socket).
|
||||
|
||||
-spec websocket_handshake(#state{}, #http_req{}, any()) -> ok | none().
|
||||
-spec websocket_handshake(#state{}, #http_req{}, any()) -> closed | none().
|
||||
websocket_handshake(State=#state{version=0, origin=Origin,
|
||||
challenge={Key1, Key2}}, Req=#http_req{socket=Socket,
|
||||
transport=Transport, raw_host=Host, port=Port,
|
||||
|
|
@ -185,7 +181,7 @@ websocket_handshake(State=#state{version=0, origin=Origin,
|
|||
handler_before_loop(State#state{messages=Transport:messages()},
|
||||
Req3, HandlerState, <<>>);
|
||||
_Any ->
|
||||
ok %% If an error happened reading the body, stop there.
|
||||
closed %% If an error happened reading the body, stop there.
|
||||
end;
|
||||
websocket_handshake(State=#state{challenge=Challenge},
|
||||
Req=#http_req{transport=Transport}, HandlerState) ->
|
||||
|
|
@ -197,7 +193,7 @@ websocket_handshake(State=#state{challenge=Challenge},
|
|||
handler_before_loop(State#state{messages=Transport:messages()},
|
||||
Req2, HandlerState, <<>>).
|
||||
|
||||
-spec handler_before_loop(#state{}, #http_req{}, any(), binary()) -> ok | none().
|
||||
-spec handler_before_loop(#state{}, #http_req{}, any(), binary()) -> closed | none().
|
||||
handler_before_loop(State=#state{hibernate=true},
|
||||
Req=#http_req{socket=Socket, transport=Transport},
|
||||
HandlerState, SoFar) ->
|
||||
|
|
@ -222,7 +218,7 @@ handler_loop_timeout(State=#state{timeout=Timeout, timeout_ref=PrevRef}) ->
|
|||
State#state{timeout_ref=TRef}.
|
||||
|
||||
%% @private
|
||||
-spec handler_loop(#state{}, #http_req{}, any(), binary()) -> ok | none().
|
||||
-spec handler_loop(#state{}, #http_req{}, any(), binary()) -> closed | none().
|
||||
handler_loop(State=#state{messages={OK, Closed, Error}, timeout_ref=TRef},
|
||||
Req=#http_req{socket=Socket}, HandlerState, SoFar) ->
|
||||
receive
|
||||
|
|
@ -242,7 +238,7 @@ handler_loop(State=#state{messages={OK, Closed, Error}, timeout_ref=TRef},
|
|||
SoFar, websocket_info, Message, fun handler_before_loop/4)
|
||||
end.
|
||||
|
||||
-spec websocket_data(#state{}, #http_req{}, any(), binary()) -> ok | none().
|
||||
-spec websocket_data(#state{}, #http_req{}, any(), binary()) -> closed | none().
|
||||
%% No more data.
|
||||
websocket_data(State, Req, HandlerState, <<>>) ->
|
||||
handler_before_loop(State, Req, HandlerState, <<>>);
|
||||
|
|
@ -296,14 +292,14 @@ websocket_data(State, Req, HandlerState, _Bad) ->
|
|||
|
||||
%% hybi unmasking.
|
||||
-spec websocket_unmask(#state{}, #http_req{}, any(), binary(),
|
||||
opcode(), binary(), mask_key()) -> ok | none().
|
||||
opcode(), binary(), mask_key()) -> closed | none().
|
||||
websocket_unmask(State, Req, HandlerState, RemainingData,
|
||||
Opcode, Payload, MaskKey) ->
|
||||
websocket_unmask(State, Req, HandlerState, RemainingData,
|
||||
Opcode, Payload, MaskKey, <<>>).
|
||||
|
||||
-spec websocket_unmask(#state{}, #http_req{}, any(), binary(),
|
||||
opcode(), binary(), mask_key(), binary()) -> ok | none().
|
||||
opcode(), binary(), mask_key(), binary()) -> closed | none().
|
||||
websocket_unmask(State, Req, HandlerState, RemainingData,
|
||||
Opcode, << O:32, Rest/bits >>, MaskKey, Acc) ->
|
||||
T = O bxor MaskKey,
|
||||
|
|
@ -334,7 +330,7 @@ websocket_unmask(State, Req, HandlerState, RemainingData,
|
|||
|
||||
%% hybi dispatching.
|
||||
-spec websocket_dispatch(#state{}, #http_req{}, any(), binary(),
|
||||
opcode(), binary()) -> ok | none().
|
||||
opcode(), binary()) -> closed | none().
|
||||
%% @todo Fragmentation.
|
||||
%~ websocket_dispatch(State, Req, HandlerState, RemainingData, 0, Payload) ->
|
||||
%% Text frame.
|
||||
|
|
@ -362,7 +358,7 @@ websocket_dispatch(State, Req, HandlerState, RemainingData, 10, Payload) ->
|
|||
websocket_handle, {pong, Payload}, fun websocket_data/4).
|
||||
|
||||
-spec handler_call(#state{}, #http_req{}, any(), binary(),
|
||||
atom(), any(), fun()) -> ok | none().
|
||||
atom(), any(), fun()) -> closed | none().
|
||||
handler_call(State=#state{handler=Handler, opts=Opts}, Req, HandlerState,
|
||||
RemainingData, Callback, Message, NextState) ->
|
||||
try Handler:Callback(Message, Req, HandlerState) of
|
||||
|
|
@ -391,7 +387,7 @@ handler_call(State=#state{handler=Handler, opts=Opts}, Req, HandlerState,
|
|||
websocket_close(State, Req, HandlerState, {error, handler})
|
||||
end.
|
||||
|
||||
-spec websocket_send(binary(), #state{}, #http_req{}) -> ok | ignore.
|
||||
-spec websocket_send(binary(), #state{}, #http_req{}) -> closed | ignore.
|
||||
%% hixie-76 text frame.
|
||||
websocket_send({text, Payload}, #state{version=0},
|
||||
#http_req{socket=Socket, transport=Transport}) ->
|
||||
|
|
@ -411,21 +407,19 @@ websocket_send({Type, Payload}, _State,
|
|||
Transport:send(Socket, [<< 1:1, 0:3, Opcode:4, 0:1, Len/bits >>,
|
||||
Payload]).
|
||||
|
||||
-spec websocket_close(#state{}, #http_req{}, any(), {atom(), atom()}) -> ok.
|
||||
-spec websocket_close(#state{}, #http_req{}, any(), {atom(), atom()}) -> closed.
|
||||
websocket_close(State=#state{version=0}, Req=#http_req{socket=Socket,
|
||||
transport=Transport}, HandlerState, Reason) ->
|
||||
Transport:send(Socket, << 255, 0 >>),
|
||||
Transport:close(Socket),
|
||||
handler_terminate(State, Req, HandlerState, Reason);
|
||||
%% @todo Send a Payload? Using Reason is usually good but we're quite careless.
|
||||
websocket_close(State, Req=#http_req{socket=Socket,
|
||||
transport=Transport}, HandlerState, Reason) ->
|
||||
Transport:send(Socket, << 1:1, 0:3, 8:4, 0:8 >>),
|
||||
Transport:close(Socket),
|
||||
handler_terminate(State, Req, HandlerState, Reason).
|
||||
|
||||
-spec handler_terminate(#state{}, #http_req{},
|
||||
any(), atom() | {atom(), atom()}) -> ok.
|
||||
any(), atom() | {atom(), atom()}) -> closed.
|
||||
handler_terminate(#state{handler=Handler, opts=Opts},
|
||||
Req, HandlerState, TerminateReason) ->
|
||||
try
|
||||
|
|
@ -438,7 +432,8 @@ handler_terminate(#state{handler=Handler, opts=Opts},
|
|||
"** Request was ~p~n** Stacktrace: ~p~n~n",
|
||||
[Handler, Class, Reason, TerminateReason, Opts,
|
||||
HandlerState, Req, erlang:get_stacktrace()])
|
||||
end.
|
||||
end,
|
||||
closed.
|
||||
|
||||
%% hixie-76 specific.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue