0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 04:30:25 +00:00

Provide installable man pages

make docs: generate Markdown and man pages in doc/
make install-docs: install man pages to be usable directly

Docs are generated from the ezdoc files in doc/src/.
This commit is contained in:
Loïc Hoguin 2014-07-06 13:10:35 +02:00
parent 1a71a733c3
commit 078d686a0a
80 changed files with 2419 additions and 2512 deletions

View file

@ -0,0 +1,36 @@
::: 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_compress
Type: true | false
Whether a websocket compression extension in in use.
: websocket_version
Type: 7 | 8 | 13
The version of the Websocket protocol being used.
:: Exports
None.