umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 12:40:25 +00:00
Code Issues Wiki Activity

Update the cowboy_websocket_handler specs

Browse source 
We can send many payloads at once.
This commit is contained in:
Loïc Hoguin 2012-11-28 19:37:15 +01:00
parent 45dd67741f
commit 7142016955
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/cowboy_websocket_handler.erl
View file

@ -50,6 +50,7 @@
-type opts() :: any().
-type state() :: any().
-type payload() :: {text | binary | ping | pong, binary()}.
-type terminate_reason() :: {normal, closed}
| {normal, timeout}
| {error, closed}
@ -66,15 +67,15 @@
-callback websocket_handle({text | binary | ping | pong, binary()}, Req, State)
-> {ok, Req, State}
| {ok, Req, State, hibernate}
| {reply, {text | binary | ping | pong, binary()}, Req, State}
| {reply, {text | binary | ping | pong, binary()}, Req, State, hibernate}
| {reply, payload() | [payload()], Req, State}
| {reply, payload() | [payload()], 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, {text | binary | ping | pong, binary()}, Req, State}
| {reply, {text | binary | ping | pong, binary()}, Req, State, hibernate}
| {reply, payload() | [payload()], Req, State}
| {reply, payload() | [payload()], Req, State, hibernate}
| {shutdown, Req, State}
when Req::cowboy_req:req(), State::state().
-callback websocket_terminate(terminate_reason(), cowboy_req:req(), state())