Behaviours: cowboy_sub_protocol.
This module defines the cowboy_websocket behaviour.
Required callback functions: init/2, websocket_handle/3, websocket_info/3.
close_code() = 1000..4999
frag_state() = undefined | {nofin, opcode(), binary()} | {fin, opcode(), binary()}
frame() = close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, close_code(), iodata()}
opcode() = 0 | 1 | 2 | 8 | 9 | 10
handler_loop/4 | |
upgrade/6 |
handler_loop(State::#state{env = undefined | cowboy_middleware:env(), socket = inet:socket(), transport = module(), handler = undefined | module(), key = undefined | binary(), timeout = timeout(), timeout_ref = undefined | reference(), messages = undefined | {atom(), atom(), atom()}, hibernate = boolean(), frag_state = frag_state(), utf8_state = binary(), deflate_frame = boolean(), inflate_state = undefined | port(), deflate_state = undefined | port()}, Req, HandlerState::any(), SoFar::binary()) -> {ok, Req, cowboy_middleware:env()} | {suspend, module(), atom(), [any()]}
upgrade(Req, Env, Handler::module(), HandlerState::any(), Timeout::timeout(), Hibernate::run | hibernate) -> {ok, Req, Env} | {suspend, module(), atom(), [any()]}
Generated by EDoc, Aug 2 2016, 23:19:00.