path: root/guide
diff options
authorLoïc Hoguin <[email protected]>2013-01-03 16:01:49 +0100
committerLoïc Hoguin <[email protected]>2013-01-03 16:01:49 +0100
commit398d3503c46f5ff157d59c9ac30e6dc327b91fec (patch)
tree6f2ccdbc333dda4c0b8aba6e02eaf7709dafd7f3 /guide
parent06e74355c0a993b416b21bb4e9586c37973e8d83 (diff)
Salvage the README and move parts into the guide
Diffstat (limited to 'guide')
2 files changed, 73 insertions, 1 deletions
diff --git a/guide/loop_handlers.md b/guide/loop_handlers.md
index 67f8ec9..6d67c62 100644
--- a/guide/loop_handlers.md
+++ b/guide/loop_handlers.md
@@ -12,6 +12,10 @@ a response.
They are most useful when performing long-polling operations or
when using server-sent events.
+While the same can be accomplished using plain HTTP handlers,
+it is recommended to use loop handlers because they are well-tested
+and allow using built-in features like hibernation and timeouts.
@@ -21,3 +25,30 @@ Usage
@todo Explain how to use them.
+The following handler waits for a message `{reply, Body}` before
+sending a response. If this message doesn't arrive within 60
+seconds, it gives up and a `204 No Content` will be replied.
+It also hibernates the process to save memory while waiting for
+this message.
+``` erlang
+init({tcp, http}, Req, Opts) ->
+ {loop, Req, undefined_state, 60000, hibernate}.
+info({reply, Body}, Req, State) ->
+ {ok, Req2} = cowboy_req:reply(200, [], Body, Req),
+ {ok, Req2, State};
+info(Message, Req, State) ->
+ {loop, Req, State, hibernate}.
+terminate(Req, State) ->
+ ok.
diff --git a/guide/ws_handlers.md b/guide/ws_handlers.md
index fc5d953..226ada0 100644
--- a/guide/ws_handlers.md
+++ b/guide/ws_handlers.md
@@ -4,12 +4,18 @@ Websocket handlers
-Websockets are an extension to HTTP to emulate plain TCP connections
+Websocket is an extension to HTTP to emulate plain TCP connections
between the user's browser and the server. Requests that are upgraded
are then handled by websocket handlers.
Both sides of the socket can send data at any time asynchronously.
+Websocket is an IETF standard. Cowboy supports the standard and all
+the drafts that were previously implemented by browsers. Websocket
+is implemented by most browsers today, although for backward
+compatibility reasons a solution like [Bullet](https://github.com/extend/bullet)
+might be preferred.
@@ -19,3 +25,38 @@ Usage
@todo Explain how to use them.
+The following handler sends a message every second. It also echoes
+back what it receives.
+``` erlang
+init({tcp, http}, Req, Opts) ->
+ {upgrade, protocol, cowboy_websocket}.
+websocket_init(TransportName, Req, _Opts) ->
+ erlang:start_timer(1000, self(), <<"Hello!">>),
+ {ok, Req, undefined_state}.
+websocket_handle({text, Msg}, Req, State) ->
+ {reply, {text, << "That's what she said! ", Msg/binary >>}, Req, State};
+websocket_handle(_Data, Req, State) ->
+ {ok, Req, State}.
+websocket_info({timeout, _Ref, Msg}, Req, State) ->
+ erlang:start_timer(1000, self(), <<"How' you doin'?">>),
+ {reply, {text, Msg}, Req, State};
+websocket_info(_Info, Req, State) ->
+ {ok, Req, State}.
+websocket_terminate(_Reason, _Req, _State) ->
+ ok.