diff options
| author | Loïc Hoguin <[email protected]> | 2013-01-18 18:04:21 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2013-01-18 18:04:21 +0100 |
| commit | 529de4d51887669349e49ef8f25f79ba5e93fd43 (patch) | |
| tree | a1fa5929b9d8c8a22d82ec4293010fced8257653 | |
| parent | 1476b13ca0e19daf97548c0d47fe648d438985ef (diff) | |
| download | cowboy-529de4d51887669349e49ef8f25f79ba5e93fd43.tar.gz cowboy-529de4d51887669349e49ef8f25f79ba5e93fd43.tar.bz2 cowboy-529de4d51887669349e49ef8f25f79ba5e93fd43.zip | |
Beginning of request object chapter in the guide
| -rw-r--r-- | guide/req.md | 19 | ||||
| -rw-r--r-- | guide/toc.md | 2 |
2 files changed, 17 insertions, 4 deletions
diff --git a/guide/req.md b/guide/req.md index 79c59a9..70873ec 100644 --- a/guide/req.md +++ b/guide/req.md @@ -4,7 +4,20 @@ Request object Purpose ------- -@todo Describe. +The request object is a special variable that can be used +to interact with a request, extracting information from it +or modifying it, and sending a response. + +It's a special variable because it contains both immutable +and mutable state. This means that some operations performed +on the request object will always return the same result, +while others will not. For example, obtaining request headers +can be repeated safely. Obtaining the request body can only +be done once, as it is read directly from the socket. + +All calls to the `cowboy_req` module will return an updated +request object. You MUST use the new request object instead +of the old one for all subsequent operations. Request ------- @@ -16,7 +29,7 @@ Request body @todo Describe. -Reply ------ +Response +-------- @todo Describe. diff --git a/guide/toc.md b/guide/toc.md index 870ce62..b6675e6 100644 --- a/guide/toc.md +++ b/guide/toc.md @@ -38,7 +38,7 @@ Cowboy User Guide * Purpose * Request * Request body - * Reply + * Response * [Hooks](hooks.md) * On request * On response |