mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-14 12:20:24 +00:00
5ce4c2bfb4
This set of changes is the first step to simplify the
writing of handlers, by removing some extraneous
callbacks and making others optional.
init/3 is now init/2, its first argument being removed.
rest_init/2 and rest_terminate/2 have been removed.
websocket_init/3 and websocket_terminate/3 have been removed.
terminate/3 is now optional. It is called regardless of
the type of handler, including rest and websocket.
The return value of init/2 changed. It now returns
{Mod, Req, Opts} with Mod being either one of the four
handler type or a custom module. It can also return extra
timeout and hibernate options.
The signature for sub protocols has changed, they now
receive these extra timeout and hibernate options.
Loop handlers are now implemented in cowboy_long_polling,
and will be renamed throughout the project in a future commit.
36 lines
1.6 KiB
Erlang
36 lines
1.6 KiB
Erlang
%% Copyright (c) 2011-2014, Loïc Hoguin <essen@ninenines.eu>
|
|
%%
|
|
%% 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_http_handler).
|
|
|
|
-type opts() :: any().
|
|
-type state() :: any().
|
|
%% @todo see terminate
|
|
%-type terminate_reason() :: {normal, shutdown}
|
|
% | {normal, timeout} %% Only occurs in loop handlers.
|
|
% | {error, closed} %% Only occurs in loop handlers.
|
|
% | {error, overflow} %% Only occurs in loop handlers.
|
|
% | {error, atom()}.
|
|
|
|
-callback init(Req, opts())
|
|
-> {http, Req, state()}
|
|
| {long_polling | rest | ws | module(), Req, state()}
|
|
| {long_polling | rest | ws | module(), Req, state(), hibernate}
|
|
| {long_polling | rest | ws | module(), Req, state(), timeout()}
|
|
| {long_polling | rest | ws | module(), Req, state(), timeout(), hibernate}
|
|
| {shutdown, Req, state()}
|
|
when Req::cowboy_req:req().
|
|
-callback handle(Req, State) -> {ok, Req, State}
|
|
when Req::cowboy_req:req(), State::state().
|
|
%% @todo optional -callback terminate(terminate_reason(), cowboy_req:req(), state()) -> ok.
|