2013-05-17 13:13:27 +02:00
|
|
|
cowboy_websocket
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
The `cowboy_websocket` module implements the Websocket protocol.
|
|
|
|
|
|
|
|
|
|
The callbacks for websocket handlers are defined in the manual
|
|
|
|
|
for the `cowboy_websocket_handler` behaviour.
|
|
|
|
|
|
|
|
|
|
Types
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
### close_code() = 1000..4999
|
|
|
|
|
|
|
|
|
|
> Reason for closing the connection.
|
|
|
|
|
|
|
|
|
|
### frame() = close | ping | pong
|
|
|
|
|
| {text | binary | close | ping | pong, iodata()}
|
|
|
|
|
| {close, close_code(), iodata()}
|
|
|
|
|
|
|
|
|
|
> Frames that can be sent to the client.
|
|
|
|
|
|
|
|
|
|
Meta values
|
|
|
|
|
-----------
|
|
|
|
|
|
2013-08-15 10:41:56 +01:00
|
|
|
### websocket_compress
|
|
|
|
|
|
|
|
|
|
> Type: true | false
|
|
|
|
|
>
|
|
|
|
|
> Whether a websocket compression extension in in use.
|
|
|
|
|
|
2013-08-27 18:14:31 +02:00
|
|
|
### websocket_version
|
|
|
|
|
|
|
|
|
|
> Type: 7 | 8 | 13
|
|
|
|
|
>
|
|
|
|
|
> The version of the Websocket protocol being used.
|
|
|
|
|
|
2013-05-17 13:13:27 +02:00
|
|
|
Exports
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
None.
|
