James Fish
6d67ad809c
Add sub protocol behaviour
2013-02-16 16:19:53 +00:00
Loïc Hoguin
bce7b860ee
Merge branch 'static_doc' of git://github.com/acammack/cowboy
2013-02-12 14:06:54 +01:00
Adam Cammack
6575ceb0dd
Fix examples in cowboy_static edoc and guide
2013-02-11 09:44:25 -06:00
Loïc Hoguin
c1bf0a2792
Add a few directions in the REST chapter in the guide
...
This is obviously not proper documentation. We will properly document
it when the API stabilizes.
2013-02-11 09:26:13 +01:00
Ivan Lisenkov
60291c6878
Small routing guide fix
...
Make cowboy_router:compile/1 return to be consistent with current
implementation.
2013-01-31 00:41:14 +04:00
Loïc Hoguin
a3c0ff9ccf
Fix small error in the websocket chapter in the guide
...
Reported by Michel Rijnders.
2013-01-30 19:00:47 +01:00
Loïc Hoguin
b2ba4d28f8
Add a section about closing the connection in the guide
2013-01-29 13:33:47 +01:00
Loïc Hoguin
c2c333de8a
Add the 'function' constraint
2013-01-28 23:39:21 +01:00
Loïc Hoguin
a5a69353f1
Add the 'int' constraint
2013-01-28 19:56:42 +01:00
Loïc Hoguin
a357c49d1b
New routing
...
Ultimately few things change, it's mostly just a nicer syntax and
slightly different expectations. The name of the value `dispatch`
did not change, because the previous dispatch values will now fail
if the code is not updated to using `cowboy_router:compile/1`.
No constraints have been implemented in this commit.
2013-01-28 16:53:09 +01:00
Loïc Hoguin
647e95aed1
Replace terminate/2 with terminate/3, adding a Reason
...
This should have been done a *long* time ago, back when I initially
added Websocket support. This is the first part of two in improving
loop handler support with regards to socket closure.
Reason may include: {normal, shutdown} for the most normal shutdown,
{normal, timeout} for a loop handler timeout shutdown, or {error, _}
if an error occured.
2013-01-22 02:34:18 +01:00
Loïc Hoguin
fe462599c2
Merge pull request #369 from rramsden/patch-1
...
Fix typo in the guide introduction
2013-01-21 09:03:14 -08:00
Loïc Hoguin
4b15d8f6e3
First draft done for the request object guide chapter
2013-01-20 15:14:13 +01:00
Loïc Hoguin
42e3468fec
More request object documentation in the guide
2013-01-19 17:58:58 +01:00
Loïc Hoguin
645556a80a
Document the static handler in the guide
2013-01-18 20:33:48 +01:00
Loïc Hoguin
6d98b320ff
Finish up the Internals chapter
2013-01-18 20:22:49 +01:00
Loïc Hoguin
a27296b34d
Document loop handlers in the guide
2013-01-18 19:51:00 +01:00
Loïc Hoguin
529de4d518
Beginning of request object chapter in the guide
2013-01-18 18:04:21 +01:00
Loïc Hoguin
1476b13ca0
Add plain HTTP handlers documentation to the guide
2013-01-18 17:07:46 +01:00
Loïc Hoguin
6f552005f2
Finish the routing chapter of the guide
...
Note that this is the new routing not yet available in master.
The code should follow in a few days.
2013-01-18 16:07:38 +01:00
Loïc Hoguin
efdf3a3433
Fix capitalize_hook example
2013-01-18 13:15:51 +01:00
Richard Ramsden
dbecfcc3db
Fix typo in the guide introduction
2013-01-17 16:14:45 -08:00
Loïc Hoguin
2f0d683622
Add hooks documentation to the guide
2013-01-18 00:54:41 +01:00
Loïc Hoguin
7f2409a4bb
Do not use tabulations in the guide
2013-01-18 00:49:06 +01:00
Loïc Hoguin
acd89f6116
Explain how to write custom protocol upgrades in the guide
2013-01-18 00:15:00 +01:00
Loïc Hoguin
1f1969ba71
Get the basics of Websocket covered in the guide
2013-01-17 23:58:55 +01:00
Loïc Hoguin
1b996794ee
Add cowboy_bstr:capitalize_token/1
...
For optional header name capitalization. See the guide section about it.
2013-01-17 23:37:50 +01:00
Loïc Hoguin
1d45698757
Fix getting started example, missing env
2013-01-11 16:55:11 +01:00
Loïc Hoguin
1b3f510b7e
Add middleware support
...
Middlewares allow customizing the request processing.
All existing Cowboy project are incompatible with this commit.
You need to change `{dispatch, Dispatch}` in the protocol options
to `{env, [{dispatch, Dispatch}]}` to fix your code.
2013-01-03 22:47:51 +01:00
Loïc Hoguin
398d3503c4
Salvage the README and move parts into the guide
2013-01-03 16:01:49 +01:00
Loïc Hoguin
06e74355c0
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.
2013-01-01 18:27:41 +01:00
Loïc Hoguin
f63d3f08cf
Cosmetic changes to various documentation files
2012-11-27 16:24:08 +01:00
Loïc Hoguin
f59ee550ad
Add Introduction chapter to the guide
2012-10-15 14:35:52 +02:00
