aboutsummaryrefslogtreecommitdiffstats
path: root/manual
AgeCommit message (Collapse)Author
2014-06-26Document the HTTP status codes Cowboy may send in the manualLoïc Hoguin
422 is left out as it's soon to be replaced by 400.
2014-06-10Allow users to pass a raw binary() as the expires header.Drew Varner
2014-06-02Add request body reading optionsLoïc Hoguin
The options were added to allow developers to fix timeout issues when reading large bodies. It is also a cleaner and easier to extend interface. This commit deprecates the functions init_stream, stream_body and skip_body which are no longer needed. They will be removed in 1.0. The body function can now take an additional argument that is a list of options. The body_qs, part and part_body functions can too and simply pass this argument down to the body call. There are options for disabling the automatic continue reply, setting a maximum length to be returned (soft limit), setting the read length and read timeout, and setting the transfer and content decode functions. The return value of the body and body_qs have changed slightly. The body function now works similarly to the part_body function, in that it returns either an ok or a more tuple depending on whether there is additional data to be read. The body_qs function can return a badlength tuple if the body is too big. The default size has been increased from 16KB to 64KB. The default read length and timeout have been tweaked and vary depending on the function called. The body function will now adequately process chunked bodies, which means that the body_qs function will too. But this means that the behavior has changed slightly and your code should be tested properly when updating your code. The body and body_qs still accept a length as first argument for compatibility purpose with older code. Note that this form is deprecated and will be removed in 1.0. The part and part_body function, being new and never having been in a release yet, have this form completely removed in this commit. Again, while most code should work as-is, you should make sure that it actually does before pushing this to production.
2014-04-17Fix manual for content_types_providedLoïc Hoguin
2014-03-26Remove outdated comments, all edoc, plus a few minor tweaksLoïc Hoguin
2014-02-21Fix cowboy:stop_listener/1 spec in manualSina Samavati
2014-02-06Add and document the new multipart codeLoïc Hoguin
The old undocumented API is removed entirely. While a documentation exists for the new API, it will not be considered set in stone until further testing has been performed, and a file upload example has been added. The new API should be a little more efficient than the old API, especially with smaller messages.
2014-01-23Clarify what stream_body is doingLoïc Hoguin
2013-12-28Fix typespecs for cowboy_req:binding/{2,3} and :bindings/1Loïc Hoguin
2013-12-28Clarify functions that can only be called onceLoïc Hoguin
2013-11-26manual: Add note about cowlibKlaus Trainer
2013-11-14Add link to cowboy_spdy function reference in indexLoïc Hoguin
2013-11-14Add documentation for cowboy_spdyLoïc Hoguin
2013-11-02Review, improve and document the static files handlerLoïc Hoguin
Changes include: * Much simplified route configuration. * Etag generation is now enabled by default. * Web mimetypes are now detected by default. A bigger list of mimetypes can be detected without any additional library. * Mimetypes can no longer be specified as a list. Copying this list for new connections is too costy. You can easily convert it into a function and pass that function to the handler instead. * You can however specify a single hardcoded mimetype. Mostly useful when serving a single file, like an index.html file, to avoid extra operations. * Specifying a path as a list of tokens is not possible anymore. Use either a binary or a string. * Using a private directory will not work if the application was not started properly. Cowboy will not attempt to find the location of this directory if the VM doesn't know it, as this caused issues in some setups. * Overall the code has been much simplified and clarified, and of course has now been documented.
2013-08-27Alphabetical orderLoïc Hoguin
2013-08-15add websocket_compress metadataRJ
2013-07-08Fix qs_vals description on missing value for a nameEduardo Gurgel
2013-06-20Add asn1 to the list of applications to be started for SSLLoïc Hoguin
Required since R16B01. And apparently needed in some cases before.
2013-05-31In content-types, the charset parameter is converted to lowercaseLoïc Hoguin
We know this specific parameter is case insensitive so we automatically lowercase it to make things simpler to the developer.
2013-05-31Improve generate_etag return value descriptionLoïc Hoguin
2013-05-25manual: Fix a typo in a typespecLoïc Hoguin
2013-05-25manual: Add a missing return type for generate_etagLoïc Hoguin
2013-05-17Add the Cowboy Function ReferenceLoïc Hoguin
The manual details every stable public functions of Cowboy.