umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 05:00:24 +00:00
Code Issues Wiki Activity

Explain how to write custom protocol upgrades in the guide

Browse source
This commit is contained in:
Loïc Hoguin 2013-01-18 00:15:00 +01:00
parent 1f1969ba71
commit acd89f6116
2 changed files with 20 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

22
guide/handlers.md
View file

@ -33,7 +33,23 @@ init(_Any, _Req, _Opts) ->
{upgrade, protocol, my_protocol}.
```
The `my_protocol` module will be used for further processing of the
request. It requires only one callback, `upgrade/4`.
Cowboy comes with two protocol upgrades: `cowboy_rest` and
`cowboy_websocket`. Use these values in place of `my_protocol`
to use them.
@todo Describe `upgrade/4` when the middleware code gets pushed.
Custom protocol upgrades
------------------------
The `my_protocol` module above will be used for further processing
of the request. It requires only one callback, `upgrade/4`.
It receives the request object, the middleware environment, and
the handler this request has been routed to along with its options.
``` erlang
upgrade(Req, Env, Handler, HandlerOpts) ->
%% ...
```
This callback is expected to behave like any middleware. Please
see the corresponding chapter for more information.

1
guide/toc.md
View file

@ -15,6 +15,7 @@ Cowboy User Guide
* [Handlers](handlers.md)
* Purpose
* Protocol upgrades
* Custom protocol upgrades
* [HTTP handlers](http_handlers.md)
* Purpose
* Callbacks