mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-15 04:30:25 +00:00
Add plain HTTP handlers documentation to the guide
This commit is contained in:
parent
6f552005f2
commit
1476b13ca0
2 changed files with 16 additions and 7 deletions
|
@ -6,12 +6,22 @@ Purpose
|
||||||
|
|
||||||
HTTP handlers are the simplest Cowboy module to handle a request.
|
HTTP handlers are the simplest Cowboy module to handle a request.
|
||||||
|
|
||||||
Callbacks
|
|
||||||
---------
|
|
||||||
|
|
||||||
@todo Describe the callbacks.
|
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@todo Explain how to use them.
|
You need to implement three callbacks for HTTP handlers. The first,
|
||||||
|
`init/3`, is common to all handlers. In the context of HTTP handlers
|
||||||
|
this should be used for any initialization needs.
|
||||||
|
|
||||||
|
The second callback, `handle/2`, is where most of your code should
|
||||||
|
be. As the name explains, this is where you handle the request.
|
||||||
|
|
||||||
|
The last callback, `terminate/2`, will be empty most of the time.
|
||||||
|
It's used for any needed cleanup. If you used the process dictionary,
|
||||||
|
timers, monitors then you most likely want to stop them in this
|
||||||
|
callback, as Cowboy might end up reusing this process for subsequent
|
||||||
|
requests. Please see the Internals chapter for more information.
|
||||||
|
|
||||||
|
Of course the general advice is to not use the process dictionary,
|
||||||
|
and that any operation requiring reception of messages should be
|
||||||
|
done in a loop handler, documented in its own chapter.
|
||||||
|
|
|
@ -18,7 +18,6 @@ Cowboy User Guide
|
||||||
* Custom protocol upgrades
|
* Custom protocol upgrades
|
||||||
* [HTTP handlers](http_handlers.md)
|
* [HTTP handlers](http_handlers.md)
|
||||||
* Purpose
|
* Purpose
|
||||||
* Callbacks
|
|
||||||
* Usage
|
* Usage
|
||||||
* [Loop handlers](loop_handlers.md)
|
* [Loop handlers](loop_handlers.md)
|
||||||
* Purpose
|
* Purpose
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue