aboutsummaryrefslogtreecommitdiffstats
path: root/src/cowboy_websocket_handler.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/cowboy_websocket_handler.erl')
-rw-r--r--src/cowboy_websocket_handler.erl51
1 files changed, 0 insertions, 51 deletions
diff --git a/src/cowboy_websocket_handler.erl b/src/cowboy_websocket_handler.erl
deleted file mode 100644
index a6a036b..0000000
--- a/src/cowboy_websocket_handler.erl
+++ /dev/null
@@ -1,51 +0,0 @@
-%% 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_websocket_handler).
-
--type opts() :: any().
--type state() :: any().
-%% @todo see terminate
-%-type terminate_reason() :: {normal, shutdown}
-% | {normal, timeout}
-% | {error, closed}
-% | {remote, closed}
-% | {remote, cowboy_websocket:close_code(), binary()}
-% | {error, badencoding}
-% | {error, badframe}
-% | {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 websocket_handle({text | binary | ping | pong, binary()}, Req, State)
- -> {ok, Req, State}
- | {ok, Req, State, hibernate}
- | {reply, cowboy_websocket:frame() | [cowboy_websocket:frame()], Req, State}
- | {reply, cowboy_websocket:frame() | [cowboy_websocket:frame()], Req, State, hibernate}
- | {shutdown, Req, State}
- when Req::cowboy_req:req(), State::state().
--callback websocket_info(any(), Req, State)
- -> {ok, Req, State}
- | {ok, Req, State, hibernate}
- | {reply, cowboy_websocket:frame() | [cowboy_websocket:frame()], Req, State}
- | {reply, cowboy_websocket:frame() | [cowboy_websocket:frame()], Req, State, hibernate}
- | {shutdown, Req, State}
- when Req::cowboy_req:req(), State::state().
-%% @todo optional -callback terminate(terminate_reason(), cowboy_req:req(), state()) -> ok.