elli_ws_protocol.md

Module elli_ws_protocol

• Description
• Data Types
• Function Index
• Function Details

Websocket protocol implementation.

Data Types

close_code()

close_code() = 1000..4999

frame()

frame() = close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, close_code(), iodata()}

Function Index

upgrade/4

Upgrade an HTTP request to the Websocket protocol.

Function Details

upgrade/4

upgrade(Req, Env, Handler::module(), HandlerOpts::any()) -> {ok, Req, Env} | {error, 400, Req} | {suspend, module(), atom(), [any()]}

• Req = elli_ws_request_adapter:req()
• Env = list()

Upgrade an HTTP request to the Websocket protocol.

You do not need to call this function manually. To upgrade to the Websocket protocol, you simply need to return {upgrade, protocol, elli_ws_protocol} in your cowboy_http_handler:init/3 handler function.

To do
* Remove when we support only R16B+.