aboutsummaryrefslogblamecommitdiffstats
path: root/src/cowboy_http_handler.erl
blob: 75b41d26f9ee10c06f97400f124aa19ff94d6c5f (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
                                                             












                                                                           
 
                       




                                                            
 




                                                                                   
                                  

                                                   
                                                                                           
%% Copyright (c) 2011-2014, Loïc Hoguin <[email protected]>
%%
%% 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.