From 0dc063ab7d94edb37c61f821b5d8e4c2da7f8ff1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 30 Sep 2014 20:12:13 +0300 Subject: Improve handler interface and documentation This change simplifies a little more the sub protocols mechanism. Aliases have been removed. The renaming of loop handlers as long polling handlers has been reverted. Plain HTTP handlers now simply do their work in the init/2 callback. There is no specific code for them. Loop handlers now follow the same return value as Websocket, they use ok to continue and shutdown to stop. Terminate reasons for all handler types have been documented. The terminate callback is now appropriately called in all cases (or should be). Behaviors for all handler types have been moved in the module that implement them. This means that cowboy_handler replaces the cowboy_http_handler behavior, and similarly cowboy_loop replaces cowboy_loop_handler, cowboy_websocket replaces cowboy_websocket_handler. Finally cowboy_rest now has the start of a behavior in it and will have the full list of optional callbacks defined once Erlang 18.0 gets released. The guide has been reorganized and should be easier to follow. --- src/cowboy_http_handler.erl | 36 ------------------------------------ 1 file changed, 36 deletions(-) delete mode 100644 src/cowboy_http_handler.erl (limited to 'src/cowboy_http_handler.erl') diff --git a/src/cowboy_http_handler.erl b/src/cowboy_http_handler.erl deleted file mode 100644 index 75b41d2..0000000 --- a/src/cowboy_http_handler.erl +++ /dev/null @@ -1,36 +0,0 @@ -%% Copyright (c) 2011-2014, Loïc Hoguin -%% -%% 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. -- cgit v1.2.3