aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
AgeCommit message (Collapse)Author
2017-11-09Add a changelog for cowboy_restLoïc Hoguin
2017-11-09Fix the introduction version for the new 2.1 functionsLoïc Hoguin
2017-11-01Add {switch_handler, Module} return value to cowboy_restLoïc Hoguin
Also {switch_handler, Module, Opts}. Allows switching to a different handler type. This is particularly useful for processing most of the request with cowboy_rest and then streaming the response body using cowboy_loop.
2017-10-29Add cowboy_req:inform/2,3Loïc Hoguin
User code can now send as many 1xx responses as necessary.
2017-10-25Introduce cowboy_req:sock/1 and cowboy_req:cert/1Loïc Hoguin
To obtain the local socket ip/port and the client TLS certificate, respectively.
2017-10-22Ensure stream terminate is called when switching protocolsLoïc Hoguin
2017-10-02Document cow_ws:frame in Cowboy for nowLoïc Hoguin
2017-10-02Fix the documentation for the command flowLoïc Hoguin
2017-09-05Update naming in REST flowchartsLoïc Hoguin
2017-09-05Add tests for direct Req accessLoïc Hoguin
2017-09-05Remove transfer-encoding parsing from cowboy_reqLoïc Hoguin
The header never reaches this point.
2017-09-04Accept sendfile tuple with 0 length in cowboy_reqLoïc Hoguin
This will result in no data being sent. It's simply easier to do this than to have to handle 0 size cases in user code.
2017-09-04Fix more documentation todosLoïc Hoguin
I have decided not to include a manual page for cowboy_stream_h at this point because it clashes with the cowboy_stream manual page. This decision will be revisited in the future.
2017-07-20Remove cowboy_sub_protocol from the documentationLoïc Hoguin
This will be reintroduced in a future release once the interface stabilizes. For the time being it will be an internal module only.
2017-07-19Websocket options are no longer per listenerLoïc Hoguin
2017-06-09Make cowboy_req:read_part return multipart headers as mapLoïc Hoguin
2017-06-07Remove NumAcceptors argument from start_clear/tlsLoïc Hoguin
They are now cowboy:start_clear/3 and cowboy:start_tls/3. The NumAcceptors argument can be specified via the num_acceptor transport option. Ranch has been updated to 1.4.0 to that effect.
2017-05-28Introduce the req_filter Websocket optionLoïc Hoguin
This option allows customizing the compacting of the Req object when using Websocket. By default it will keep most public fields excluding headers of course, since those can be large.
2017-05-05Add inactivity_timeout and other options improvementsLoïc Hoguin
2017-05-03Add the idle_timeout HTTP/1.1 protocol optionLoïc Hoguin
This fixes the connection being dropped because of request_timeout despite there being some active streams.
2017-04-18Pass the HTTP/2 switch_protocol event to stream handlersLoïc Hoguin
To accomplish this the code for sending the 101 response was moved to the cowboy_http2 module.
2017-04-10Initial cowboy_stream manualLoïc Hoguin
2017-02-19Change the type of bindings from a list to a mapLoïc Hoguin
Maps make more sense because the keys are unique.
2017-02-19Change the order of set_resp_cookie argumentsLoïc Hoguin
The Opts value is put last, to be more consistent with the rest of the cowboy_req module. Additionally a test handler was fixed which reduced the number of errors in http_SUITE.
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.