diff options
author | Loïc Hoguin <[email protected]> | 2014-07-06 13:10:35 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2014-07-06 13:10:35 +0200 |
commit | 078d686a0ac0aed212db97d73bd1e4a9387a4956 (patch) | |
tree | 6bbc6111fdbdfedd3bb351bf3b01c63fac0d7143 /doc/src/manual/cowboy_websocket.ezdoc | |
parent | 1a71a733c37df70c15ebfd28157b10915cd738d1 (diff) | |
download | cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.tar.gz cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.tar.bz2 cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.zip |
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/.
Diffstat (limited to 'doc/src/manual/cowboy_websocket.ezdoc')
-rw-r--r-- | doc/src/manual/cowboy_websocket.ezdoc | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_websocket.ezdoc b/doc/src/manual/cowboy_websocket.ezdoc new file mode 100644 index 0000000..59a6248 --- /dev/null +++ b/doc/src/manual/cowboy_websocket.ezdoc @@ -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. |