aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
AgeCommit message (Collapse)Author
2017-02-19Change the type of cookie name to binary()Loïc Hoguin
The API will be more consistent like this, and we can ensure that duplicate cookie names are never sent.
2017-02-18Allow passing options to sub protocolsLoïc Hoguin
Before this commit we had an issue where configuring a Websocket connection was simply not possible without doing magic, adding callbacks or extra return values. The init/2 function only allowed setting hibernate and timeout options. After this commit, when switching to a different type of handler you can either return {module, Req, State} or {module, Req, State, Opts} where Opts is any value (as far as the sub protocol interface is concerned) and is ultimately checked by the custom handlers. A large protocol like Websocket would accept only a map there, with many different options, while a small interface like loop handlers would allow passing hibernate and nothing else. For Websocket, hibernate must be set from the websocket_init/1 callback, because init/2 executes in a separate process. Sub protocols now have two callbacks: one with the Opts value, one without. The loop handler code was largely reworked and simplified. It does not need to manage a timeout or read from the socket anymore, it's the job of the protocol code. A lot of unnecessary stuff was therefore removed. Websocket compression must now be enabled from the handler options instead of per listener. This means that a project can have two separate Websocket handlers with different options. Compression is still disabled by default, and the idle_timeout value was changed from inifnity to 60000 (60 seconds), as that's safer and is also a good value for mobile devices.
2017-01-04Improve the manual for the new resp_header functionsLoïc Hoguin
2017-01-04Add functions for getting and setting response headersJohan Lövdahl
2016-12-28Update the cowboy_rest manualLoïc Hoguin
2016-12-23Leave a few manual pages for post 2.0.0-pre.4Loïc Hoguin
In particular the cowboy_sub_protocol is subject to change soon. Also the cowboy_stream behavior is going to be left hidden in this release and enabled when it becomes easier to chain them.
2016-12-23Update cowboy_middlewareLoïc Hoguin
2016-12-23Update cowboy_loop manualLoïc Hoguin
2016-12-23Update the cowboy_handler manualLoïc Hoguin
Also fixes a small mistake in cowboy_websocket.
2016-12-23Update the cowboy_static manualLoïc Hoguin
2016-12-22Updates cowboy_http documents changelogSasan Hezarkhani
The changelog had a wrong reference to an option that was updated. `max_header_request_line_length` -> `max_request_line_length`
2016-12-22Update cowboy_websocket_manualLoïc Hoguin
2016-12-22Add the manual for cowboy_http2Loïc Hoguin
2016-12-22Add cowboy_http manualLoïc Hoguin
Updates and replaces the cowboy_protocol manual.
2016-12-22Update the cowboy_router manualLoïc Hoguin
2016-12-21Add man pages for the reply functionsLoïc Hoguin
2016-12-02Add the man pages for body reading functionsLoïc Hoguin
[ci skip]
2016-11-07Add man pages for the parse/match/binding cowboy_req functionsLoïc Hoguin
2016-11-07Small tweak to AsciidocLoïc Hoguin
Fixes Hugo rendering.
2016-11-07Add man pages for parse_qs, match_qs and parse_headerLoïc Hoguin
[ci skip]
2016-11-05Tweak small things in the cowboy manualLoïc Hoguin
2016-11-05Partially update manual for the cowboy_reqLoïc Hoguin
Only the access functions have been modified so far.
2016-10-01Small tweaks to cowboy module manualLoïc Hoguin
2016-09-29Tweak the one-liner description of the projectLoïc Hoguin
2016-09-25Tweak the cowboy(7) manualLoïc Hoguin
2016-09-25Update the cowboy(7) manualLoïc Hoguin
It now links to all modules found in the manual and can therefore easily act as an index for the application.
2016-09-25Fix whitespace in exampleLoïc Hoguin
2016-09-25Update manual for the cowboy moduleLoïc Hoguin
This commit separates the documentation of the functions into separate manual pages, with at least one example per function and a lot more details about parameters, return values and related functions and modules. It also includes a changelog indicating when the function was added or changed. The inspiration for this comes mainly from the PHP documentation and feedback from users.
2016-08-31Update websocket documentation: based on ↵Alex Prut
https://github.com/ninenines/cowboy/blob/master/examples/websocket/src/ws_handler.erl
2016-08-30Fix rendering issues in the guide and manualLoïc Hoguin
2016-03-06Completely remove SPDYLoïc Hoguin
2016-01-15Minor grammar improvements from Derek Brown2.0.0-pre.3Loïc Hoguin
[ci-skip]
2016-01-14Convert the documentation to AsciidocLoïc Hoguin
A few small revisions were made, and Erlang.mk has been updated.
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-02-16Use cow_ws for the Websocket parsing codeLoïc Hoguin
Updates Cowlib to 1.1.0
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-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-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/.