aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/handlers.ezdoc
diff options
context:
space:
mode:
authorStefan Strigler <[email protected]>2014-10-08 16:49:18 +0200
committerStefan Strigler <[email protected]>2014-10-08 16:49:18 +0200
commit8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429 (patch)
tree8337c1aff021ee40dccdac0c52a741b6bcb17929 /doc/src/guide/handlers.ezdoc
parentb87150c713fe16601b314451b2fe25b62bd820bb (diff)
downloadcowboy-8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429.tar.gz
cowboy-8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429.tar.bz2
cowboy-8fd3ff2d629fa13a52061e7db5c67a3ba6fe4429.zip
change init/2 to return #state{} in documentation
Most examples returned 'Opts' as given by second argument to init. By using '#state{}' the examples make it more clear that this is what is being passed as 'State' to all subsequent callbacks (if any).
Diffstat (limited to 'doc/src/guide/handlers.ezdoc')
-rw-r--r--doc/src/guide/handlers.ezdoc16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/src/guide/handlers.ezdoc b/doc/src/guide/handlers.ezdoc
index c0fb97e..9336488 100644
--- a/doc/src/guide/handlers.ezdoc
+++ b/doc/src/guide/handlers.ezdoc
@@ -14,8 +14,8 @@ defined during the ^"router configuration^routing^.
A handler that does nothing would look like this:
``` erlang
-init(Req, Opts) ->
- {ok, Req, Opts}.
+init(Req, _Opts) ->
+ {ok, Req, #state{}}.
```
Despite sending no reply, a `204 No Content` reply will be
@@ -25,11 +25,11 @@ sent for every request.
We need to use the Req object for sending a reply.
``` erlang
-init(Req, Opts) ->
+init(Req, _Opts) ->
Req2 = cowboy_req:reply(200, [
{<<"content-type">>, <<"text/plain">>}
], <<"Hello World!">>, Req),
- {ok, Req2, Opts}.
+ {ok, Req2, #state{}}.
```
As you can see we return a 3-tuple. `ok` means that the
@@ -60,15 +60,15 @@ return the name of the handler type you want to use. The
following snippet switches to a Websocket handler:
``` erlang
-init(Req, Opts) ->
- {cowboy_websocket, Req, Opts}.
+init(Req, _Opts) ->
+ {cowboy_websocket, Req, #state{}}.
```
You can also switch to your own custom handler type:
``` erlang
-init(Req, Opts) ->
- {my_handler_type, Req, Opts}.
+init(Req, _Opts) ->
+ {my_handler_type, Req, #state{}}.
```
How to implement a custom handler type is described in the