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 /manual/cowboy_sub_protocol.md | |
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 'manual/cowboy_sub_protocol.md')
-rw-r--r-- | manual/cowboy_sub_protocol.md | 34 |
1 files changed, 0 insertions, 34 deletions
diff --git a/manual/cowboy_sub_protocol.md b/manual/cowboy_sub_protocol.md deleted file mode 100644 index a8ecae1..0000000 --- a/manual/cowboy_sub_protocol.md +++ /dev/null @@ -1,34 +0,0 @@ -cowboy_sub_protocol -=================== - -The `cowboy_sub_protocol` behaviour defines the interface used -by modules that implement a protocol on top of HTTP. - -Types ------ - -None. - -Callbacks ---------- - -### upgrade(Req, Env, Handler, Opts) - -> {ok, Req, Env} - | {suspend, Module, Function, Args} - | {halt, Req} - | {error, StatusCode, Req} - -> Types: -> * Req = cowboy_req:req() -> * Env = env() -> * Handler = module() -> * Opts = any() -> * Module = module() -> * Function = atom() -> * Args = [any()] -> * StatusCode = cowboy:http_status() -> -> Upgrade the protocol. -> -> Please refer to the `cowboy_middleware` manual for a -> description of the return values. |