diff options
author | Loïc Hoguin <[email protected]> | 2017-07-20 18:28:06 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2017-07-20 18:28:06 +0200 |
commit | 3099fc1d9f33e791cc1edfd585bbfb2d4be30a92 (patch) | |
tree | 0dd222225a65452d0c4f5df166c25e25956a4242 /doc/src/manual/cowboy_sub_protocol.asciidoc | |
parent | e4cab480dc2562378d9d046069bce2e5ab90dabd (diff) | |
download | cowboy-3099fc1d9f33e791cc1edfd585bbfb2d4be30a92.tar.gz cowboy-3099fc1d9f33e791cc1edfd585bbfb2d4be30a92.tar.bz2 cowboy-3099fc1d9f33e791cc1edfd585bbfb2d4be30a92.zip |
Remove cowboy_sub_protocol from the documentation
This will be reintroduced in a future release once the
interface stabilizes. For the time being it will be an
internal module only.
Diffstat (limited to 'doc/src/manual/cowboy_sub_protocol.asciidoc')
-rw-r--r-- | doc/src/manual/cowboy_sub_protocol.asciidoc | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/doc/src/manual/cowboy_sub_protocol.asciidoc b/doc/src/manual/cowboy_sub_protocol.asciidoc deleted file mode 100644 index 8146a44..0000000 --- a/doc/src/manual/cowboy_sub_protocol.asciidoc +++ /dev/null @@ -1,27 +0,0 @@ -= cowboy_sub_protocol(3) - -== Name - -cowboy_sub_protocol - sub protocol - -== Description - -The `cowboy_sub_protocol` behaviour defines the interface used -by modules that implement a protocol on top of HTTP. - -== Callbacks - -=== upgrade(Req, Env, Handler, HandlerOpts) -> {ok, Req, Env} | {suspend, Module, Function, Args} | {stop, Req} - -Req = cowboy_req:req():: The Req object. -Env = env():: The request environment. -Handler = module():: Handler module. -Opts = any():: Handler options. -Module = module():: MFA to call when resuming the process. -Function = atom():: MFA to call when resuming the process. -Args = [any()]:: MFA to call when resuming the process. - -Upgrade the protocol. - -Please refer to the `cowboy_middleware` manual for a -description of the return values. |