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_middleware.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_middleware.ezdoc')
-rw-r--r-- | doc/src/manual/cowboy_middleware.ezdoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/src/manual/cowboy_middleware.ezdoc b/doc/src/manual/cowboy_middleware.ezdoc index 2275d35..dacaf6c 100644 --- a/doc/src/manual/cowboy_middleware.ezdoc +++ b/doc/src/manual/cowboy_middleware.ezdoc @@ -21,7 +21,7 @@ optionally with its contents modified. : execute(Req, Env) -> {ok, Req, Env} | {suspend, Module, Function, Args} - | {halt, Req} + | {stop, Req} Types: @@ -41,7 +41,7 @@ The `suspend` return value will hibernate the process until an Erlang message is received. Note that when resuming, any previous stacktrace information will be gone. -The `halt` return value stops Cowboy from doing any further +The `stop` return value stops Cowboy from doing any further processing of the request, even if there are middlewares that haven't been executed yet. The connection may be left open to receive more requests from the client. |