diff options
author | Loïc Hoguin <[email protected]> | 2013-05-17 13:13:27 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2013-05-17 13:13:27 +0200 |
commit | 666c59bc422172562673916ed3a8a796c4f9fbf4 (patch) | |
tree | f561151846de077513fa767edc10165a469d09ef /manual/cowboy_websocket.md | |
parent | 0e0ec7b1203a8490ee9a876f9274fe0c64e708f8 (diff) | |
download | cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.tar.gz cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.tar.bz2 cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.zip |
Add the Cowboy Function Reference
The manual details every stable public functions of Cowboy.
Diffstat (limited to 'manual/cowboy_websocket.md')
-rw-r--r-- | manual/cowboy_websocket.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/manual/cowboy_websocket.md b/manual/cowboy_websocket.md new file mode 100644 index 0000000..ae3ca1b --- /dev/null +++ b/manual/cowboy_websocket.md @@ -0,0 +1,34 @@ +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 +----------- + +### websocket_version + +> Type: 7 | 8 | 13 +> +> The version of the Websocket protocol being used. + +Exports +------- + +None. |