diff options
author | Loïc Hoguin <[email protected]> | 2013-01-01 18:27:41 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2013-01-01 18:27:41 +0100 |
commit | 06e74355c0a993b416b21bb4e9586c37973e8d83 (patch) | |
tree | bb70dc2d6369637d5663c01e031f3da875eb3dc9 /guide/loop_handlers.md | |
parent | 2690d1254caffa2d85965baf95ed005c39fc820a (diff) | |
download | cowboy-06e74355c0a993b416b21bb4e9586c37973e8d83.tar.gz cowboy-06e74355c0a993b416b21bb4e9586c37973e8d83.tar.bz2 cowboy-06e74355c0a993b416b21bb4e9586c37973e8d83.zip |
Add a skeleton of the guide to ease user contributions
Has some stuff that aren't in master yet, and lacks a lot more
that is already in master.
Diffstat (limited to 'guide/loop_handlers.md')
-rw-r--r-- | guide/loop_handlers.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/guide/loop_handlers.md b/guide/loop_handlers.md new file mode 100644 index 0000000..67f8ec9 --- /dev/null +++ b/guide/loop_handlers.md @@ -0,0 +1,23 @@ +Loop handlers +============= + +Purpose +------- + +Loop handlers are a special kind of HTTP handlers used when the +response can not be sent right away. The handler enters instead +a receive loop waiting for the right message before it can send +a response. + +They are most useful when performing long-polling operations or +when using server-sent events. + +Callbacks +--------- + +@todo Describe the callbacks. + +Usage +----- + +@todo Explain how to use them. |