aboutsummaryrefslogtreecommitdiffstats
path: root/doc
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
2017-01-02Welcome to 2017Loïc Hoguin
2017-01-02Various fixes and tweaks to the user guideLoïc Hoguin
2016-12-28Add templates as Erlang.mk pluginLoïc Hoguin
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-09-14Use spaces in snippets in the guideLoïc Hoguin
2016-09-14Update the Websocket handlers chapterLoïc Hoguin
2016-09-04Update the routing chapterLoïc Hoguin
2016-09-04Rework the constraints chapterLoïc Hoguin
2016-09-02Minor updates to static files chapterLoïc Hoguin
2016-09-02Update the multipart chapterLoïc Hoguin
2016-09-01Update the Websocket protocol chapterLoïc Hoguin
2016-09-01Update the cookies guide chapterLoïc Hoguin
2016-08-31Merge branch 'master' of https://github.com/alexprut/cowboyLoïc Hoguin
2016-08-31Update the guide chapter for responsesLoïc Hoguin
2016-08-31Update websocket documentation: based on ↵Alex Prut
https://github.com/ninenines/cowboy/blob/master/examples/websocket/src/ws_handler.erl
2016-08-30Add the missing listeners guide chapterLoïc Hoguin
While incomplete it's still a pretty good start.
2016-08-30Minor documentation fixesLoïc Hoguin
"make docs" should now work again.
2016-08-30Fix a couple xref linksLoïc Hoguin
They were still using the old ezdoc syntax.
2016-08-30Add placeholder flow diagram chapterLoïc Hoguin
2016-08-30Fix rendering issues in the guide and manualLoïc Hoguin
2016-08-25Update the body reading chapterLoïc Hoguin
2016-08-24More 2.0 documentation updatesLoïc Hoguin
Still incomplete.
2016-06-06Wording tweak in static handler chapter in the guideLoïc Hoguin
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-16 13:17:23 +0000