diff options
author | Loïc Hoguin <[email protected]> | 2014-09-30 20:12:13 +0300 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2014-09-30 20:12:13 +0300 |
commit | 0dc063ab7d94edb37c61f821b5d8e4c2da7f8ff1 (patch) | |
tree | aaa71b552b0348fc403cc68ba8318e58f213d4fd /doc/src/manual/cowboy_http_handler.ezdoc | |
parent | 5ce4c2bfb40ecc4b687a2941e612025a1c4ff913 (diff) | |
download | cowboy-0dc063ab7d94edb37c61f821b5d8e4c2da7f8ff1.tar.gz cowboy-0dc063ab7d94edb37c61f821b5d8e4c2da7f8ff1.tar.bz2 cowboy-0dc063ab7d94edb37c61f821b5d8e4c2da7f8ff1.zip |
Improve handler interface and documentation
This change simplifies a little more the sub protocols mechanism.
Aliases have been removed. The renaming of loop handlers as long
polling handlers has been reverted.
Plain HTTP handlers now simply do their work in the init/2
callback. There is no specific code for them.
Loop handlers now follow the same return value as Websocket,
they use ok to continue and shutdown to stop.
Terminate reasons for all handler types have been documented.
The terminate callback is now appropriately called in all cases
(or should be).
Behaviors for all handler types have been moved in the module
that implement them. This means that cowboy_handler replaces
the cowboy_http_handler behavior, and similarly cowboy_loop
replaces cowboy_loop_handler, cowboy_websocket replaces
cowboy_websocket_handler. Finally cowboy_rest now has the
start of a behavior in it and will have the full list of
optional callbacks defined once Erlang 18.0 gets released.
The guide has been reorganized and should be easier to follow.
Diffstat (limited to 'doc/src/manual/cowboy_http_handler.ezdoc')
-rw-r--r-- | doc/src/manual/cowboy_http_handler.ezdoc | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/doc/src/manual/cowboy_http_handler.ezdoc b/doc/src/manual/cowboy_http_handler.ezdoc deleted file mode 100644 index 6776598..0000000 --- a/doc/src/manual/cowboy_http_handler.ezdoc +++ /dev/null @@ -1,57 +0,0 @@ -::: cowboy_http_handler - -The `cowboy_http_handler` behaviour defines the interface used -by plain HTTP handlers. - -Unless noted otherwise, the callbacks will be executed sequentially. - -:: Types - -None. - -:: Callbacks - -: init({TransportName, ProtocolName}, Req, Opts) - -> {ok, Req, State} | {shutdown, Req, State} - -Types: - -* TransportName = tcp | ssl | atom() -* ProtocolName = http | atom() -* Req = cowboy_req:req() -* Opts = any() -* State = any() - -Initialize the state for this request. - -The `shutdown` return value can be used to skip the `handle/2` -call entirely. - -: handle(Req, State) -> {ok, Req, State} - -Types: - -* Req = cowboy_req:req() -* State = any() - -Handle the request. - -This callback is where the request is handled and a response -should be sent. If a response is not sent, Cowboy will send -a `204 No Content` response automatically. - -: terminate(Reason, Req, State) -> ok - -Types: - -* Reason = {normal, shutdown} | {error, atom()} -* Req = cowboy_req:req() -* State = any() - -Perform any necessary cleanup of the state. - -This callback should release any resource currently in use, -clear any active timer and reset the process to its original -state, as it might be reused for future requests sent on the -same connection. Typical plain HTTP handlers rarely need to -use it. |