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

Remove cowboy_sub_protocol from the documentation

Browse source 
This will be reintroduced in a future release once the
interface stabilizes. For the time being it will be an
internal module only.
This commit is contained in:
Loïc Hoguin 2017-07-20 18:28:06 +02:00
parent e4cab480dc
commit 3099fc1d9f
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
5 changed files with 0 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/src/manual/cowboy_app.asciidoc
View file

@ -43,7 +43,6 @@ Behaviors:
* link:man:cowboy_middleware(3)[cowboy_middleware(3)] - Middlewares
* link:man:cowboy_rest(3)[cowboy_rest(3)] - REST handlers
* link:man:cowboy_stream(3)[cowboy_stream(3)] - Stream handlers
// @todo * link:man:cowboy_sub_protocol(3)[cowboy_sub_protocol(3)] - Sub protocols
* link:man:cowboy_websocket(3)[cowboy_websocket(3)] - Websocket handlers
Middlewares:

27
doc/src/manual/cowboy_sub_protocol.asciidoc
View file

@ -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.