aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)Author
2015-07-27Add optional callbacksLoïc Hoguin
Mostly useful for REST, which has a ton. This is an initial commit, it still needs to be tested, but it's time to sleep.
2015-05-05Add rfc7230 test suite and update others to recent GunLoïc Hoguin
This is a large commit. The rfc7230 test suite adds many tests from the RFC7230 document. Gun has been updated quite a bit recently, which broke the Cowboy suites. This is now fixed with this commit. A new hook onfirstrequest has been added. It was very useful during debugging of the test suites. The initial process code has changed a little; more changes are expected with the switch to maps for options.
2015-02-16Merge branch 'master' of https://github.com/sstrigler/cowboyLoïc Hoguin
2015-02-16Merge branch 'patch-1' of https://github.com/grahamrhay/cowboyLoïc Hoguin
2015-02-16Use cow_ws for the Websocket parsing codeLoïc Hoguin
Updates Cowlib to 1.1.0
2015-02-01Fix small detail in docsLoïc Hoguin
2015-01-19Update getting_started.ezdocGraham Hay
Make example code dialyzer approved.
2014-11-25Small clarification on max_request_line_lengthLoïc Hoguin
2014-11-24Docs clarification when returning a list of ws framesLoïc Hoguin
2014-11-23Add a specs document for RFC6585Loïc Hoguin
Only a few status codes. Comments in the previous commit apply.
2014-11-23Add an RFC7230 HTTP/1.1 server specification documentLoïc Hoguin
This document lists all rules that Cowboy HTTP server will follow after careful analysis of the RFC7230. Do note that not all these rules are implemented or tested yet, and that at the time of commit there may be rules that Cowboy will ultimately not implement (for various reasons including performance or leaving certain aspects up to the user code).
2014-11-07Rename 'halt' to 'stop' for better consistencyLoïc Hoguin
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.
2014-11-07Rename 'shutdown' close reason and tuples to 'stop'Loïc Hoguin
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.
2014-10-08change init/2 to return #state{} in documentationStefan Strigler
Most examples returned 'Opts' as given by second argument to init. By using '#state{}' the examples make it more clear that this is what is being passed as 'State' to all subsequent callbacks (if any).
2014-10-04Fix a bad link in the guideLoïc Hoguin
2014-10-04Reverse the order of arguments of match_* functionsLoïc Hoguin
Wasn't following the same order as the rest of the module.
2014-10-03Remove the REST known_content_type callbackLoïc Hoguin
This callback was simply useless.
2014-10-01Remove empty sections from the manualLoïc Hoguin
2014-09-30Improve handler interface and documentationLoïc Hoguin
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-26Unify the init and terminate callbacksLoïc Hoguin
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-24Remove the error tuple return value for middlewaresLoïc Hoguin
It wasn't interesting compared to simply returning a halt tuple with an explicit reply.
2014-09-24Remove the onrequest hookLoïc Hoguin
It was redundant with middlewares. Allows us to save a few operations for every incoming requests.
2014-09-23Make routing constraints use the fields formatLoïc Hoguin
This makes routing more in line with the rest of Cowboy and allows us to use cowboy_constraints directly.
2014-09-23Breaking update of the cowboy_req interfaceLoïc Hoguin
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-08-12Fix incorrect type in cowboy_static manualLoïc Hoguin
2014-08-11Fix REST guide reference to accept_missing_postAli Sabil
The guide refers to accept_missing_post instead of allow_missing_post.
2014-08-02Fix language in getting startedLoïc Hoguin
2014-08-02Update links extend -> nineninesLoïc Hoguin
2014-08-02Fix bad link format in the guideLoïc Hoguin
2014-08-01Add OTP release support and versioning info to the guideLoïc Hoguin
2014-08-01Update the Getting started chapter to new erlang.mkLoïc Hoguin
Length of the chapter divided by 2! \o/
2014-07-26fix a documentation typoTomas Morstein
The function `set_resp_header' is defined in `cowboy_req' module, not the `cowboy'.
2014-07-12Drop R15 supportLoïc Hoguin
2014-07-10Clarify {true, URL} return for AcceptResource callbackLoïc Hoguin
2014-07-06Provide installable man pagesLoïc Hoguin
make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/.
2013-12-02Remove the confusing doc folderLoïc Hoguin
All documentation is in README.md, guide/ or manual/ now.
2013-03-02Add a simple README in the doc folder for guidanceLoïc Hoguin
2012-05-23Update version to 0.6.00.6.0Loïc Hoguin
Also update the CHANGELOG and copyright years.
2011-07-06Add documentation for the public interface.Loïc Hoguin
This is probably not perfect yet but it should be better than nothing. We'll improve things with feedback received from the many users.