0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Commit graph

14 commits

Author SHA1 Message Date
Loïc Hoguin
cf44496005 Remove the .app.src file in all examples 2016-01-14 20:56:31 +01:00
Loïc Hoguin
394b4f0bf7 Simplify example instructions and fix broken examples
Also convert to AsciiDoc while we're at it.
2016-01-14 20:00:50 +01:00
Loïc Hoguin
18f50b8697 Make examples use Cowboy master 2014-10-03 16:28:02 +03:00
Loïc Hoguin
0dc063ab7d 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.
2014-09-30 20:12:13 +03:00
Loïc Hoguin
5ce4c2bfb4 Unify the init and terminate callbacks
This set of changes is the first step to simplify the
writing of handlers, by removing some extraneous
callbacks and making others optional.

init/3 is now init/2, its first argument being removed.

rest_init/2 and rest_terminate/2 have been removed.

websocket_init/3 and websocket_terminate/3 have been removed.

terminate/3 is now optional. It is called regardless of
the type of handler, including rest and websocket.

The return value of init/2 changed. It now returns
{Mod, Req, Opts} with Mod being either one of the four
handler type or a custom module. It can also return extra
timeout and hibernate options.

The signature for sub protocols has changed, they now
receive these extra timeout and hibernate options.

Loop handlers are now implemented in cowboy_long_polling,
and will be renamed throughout the project in a future commit.
2014-09-26 15:58:44 +03:00
Loïc Hoguin
f1c3b6d76f Breaking update of the cowboy_req interface
Simplify the interface for most cowboy_req functions. They all return
a single value except the four body reading functions. The reply functions
now only return a Req value.

Access functions do not return a Req anymore.

Functions that used to cache results do not have a cache anymore.

The interface for accessing query string and cookies has therefore
been changed.

There are now three query string functions: qs/1 provides access
to the raw query string value; parse_qs/1 returns the query string
as a list of key/values; match_qs/2 returns a map containing the
values requested in the second argument, after applying constraints
and default value.

Similarly, there are two cookie functions: parse_cookies/1 and
match_cookies/2. More match functions will be added in future commits.

None of the functions return an error tuple anymore. It either works
or crashes. Cowboy will attempt to provide an appropriate status code
in the response of crashed handlers.

As a result, the content decode function has its return value changed
to a simple binary, and the body reading functions only return on success.
2014-09-23 16:43:29 +03:00
Loïc Hoguin
62de3a62f9 Update to erlang.mk 1.0.0 2014-08-01 14:26:51 +02:00
Loïc Hoguin
abcc6e96d8 Update erlang.mk and update paths to start the release
Fixes a couple invalid instructions at the same time.
2014-06-30 10:14:05 +02:00
Loïc Hoguin
96755dd973 No need for relx in path for examples anymore 2013-10-22 09:14:32 +02:00
Loïc Hoguin
4769412daa erlang.mk now has built-in support for relx 2013-10-14 16:05:19 +02:00
Loïc Hoguin
1a4e7a8618 Fix the list of registered processes in the examples 2013-09-09 16:46:21 +02:00
Loïc Hoguin
1f8119ef31 Fix the command to start the release in rest_basic_auth example 2013-09-08 19:51:41 +02:00
Loïc Hoguin
dacaf5d293 Add missing files to the REST basic auth example 2013-09-08 12:22:52 +02:00
Loïc Hoguin
bb9a2e975e Rename the basic_auth example to rest_basic_auth 2013-09-07 16:23:13 +02:00