diff options
| author | Loïc Hoguin <[email protected]> | 2014-11-07 20:19:05 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2014-11-07 20:19:05 +0200 |
| commit | 999dc5b7c1665fb620c14f6303610793313efe58 (patch) | |
| tree | 8371be2957e20b40fa9b5b93c63e414510e93c2e /doc/src/manual/cowboy_rest.ezdoc | |
| parent | 8cbd8c1882e33380875f2723cad258784ba3a360 (diff) | |
| download | cowboy-999dc5b7c1665fb620c14f6303610793313efe58.tar.gz cowboy-999dc5b7c1665fb620c14f6303610793313efe58.tar.bz2 cowboy-999dc5b7c1665fb620c14f6303610793313efe58.zip | |
Rename 'halt' to 'stop' for better consistency
Now everywhere in Cowboy when we want to stop something we return
a 'stop' tuple instead of one of the many choices depending on
context that we had before.
This particular change affects middlewares, sub protocols and
REST handlers which were using 'halt' to stop processing.
Diffstat (limited to 'doc/src/manual/cowboy_rest.ezdoc')
| -rw-r--r-- | doc/src/manual/cowboy_rest.ezdoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/src/manual/cowboy_rest.ezdoc b/doc/src/manual/cowboy_rest.ezdoc index f9e938a..eef622a 100644 --- a/doc/src/manual/cowboy_rest.ezdoc +++ b/doc/src/manual/cowboy_rest.ezdoc @@ -58,7 +58,7 @@ stacktrace of the process when the crash occurred. :: Callbacks -: Callback(Req, State) -> {Value, Req, State} | {halt, Req, State} +: Callback(Req, State) -> {Value, Req, State} | {stop, Req, State} Types: @@ -72,7 +72,7 @@ on the `Value` type, the default value if the callback is not defined, and more general information on when the callback is called and what its intended use is. -The `halt` tuple can be returned to stop REST processing. +The `stop` tuple can be returned to stop REST processing. It is up to the resource code to send a reply before that, otherwise a `204 No Content` will be sent. |