From 8cbd8c1882e33380875f2723cad258784ba3a360 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 7 Nov 2014 19:22:36 +0200 Subject: Rename 'shutdown' close reason and tuples to 'stop' The 'shutdown' atom has a specific meaning inside OTP. We are instead going to use 'stop' which is pretty much the equivalent of what we actually do. 'shutdown' is now reserved for future special processes implementation. --- doc/src/manual/cowboy_loop.ezdoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/src/manual/cowboy_loop.ezdoc') diff --git a/doc/src/manual/cowboy_loop.ezdoc b/doc/src/manual/cowboy_loop.ezdoc index 196cec6..79b96f9 100644 --- a/doc/src/manual/cowboy_loop.ezdoc +++ b/doc/src/manual/cowboy_loop.ezdoc @@ -29,10 +29,10 @@ The connection was closed normally before switching to the loop sub protocol. This typically happens if an `ok` tuple is returned from the `init/2` callback. -: shutdown +: stop The handler requested to close the connection by returning -a `shutdown` tuple. +a `stop` tuple. : timeout @@ -72,7 +72,7 @@ A socket error ocurred. : info(Info, Req, State) -> {ok, Req, State} | {ok, Req, State, hibernate} - | {shutdown, Req, State} + | {stop, Req, State} Types: @@ -85,7 +85,7 @@ Handle the Erlang message received. This function will be called every time an Erlang message has been received. The message can be any Erlang term. -The `shutdown` return value can be used to stop the receive loop, +The `stop` return value can be used to stop the receive loop, typically because a response has been sent. The `hibernate` option will hibernate the process until -- cgit v1.2.3