diff options
author | Loïc Hoguin <[email protected]> | 2016-01-14 13:35:25 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-01-14 13:37:20 +0100 |
commit | 4023e7f4e429179fd9c2cce4487c33646c6bd327 (patch) | |
tree | 3c4e26d1b5592958e35297c82ad3069bdb642594 /doc/src/manual/cowboy_protocol.ezdoc | |
parent | b7d666cfc746f55b0a72ef8d37f703885099daf7 (diff) | |
download | cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.gz cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.bz2 cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.zip |
Convert the documentation to Asciidoc
A few small revisions were made, and Erlang.mk has been updated.
Diffstat (limited to 'doc/src/manual/cowboy_protocol.ezdoc')
-rw-r--r-- | doc/src/manual/cowboy_protocol.ezdoc | 75 |
1 files changed, 0 insertions, 75 deletions
diff --git a/doc/src/manual/cowboy_protocol.ezdoc b/doc/src/manual/cowboy_protocol.ezdoc deleted file mode 100644 index 1d65a5c..0000000 --- a/doc/src/manual/cowboy_protocol.ezdoc +++ /dev/null @@ -1,75 +0,0 @@ -::: cowboy_protocol - -The `cowboy_protocol` module implements HTTP/1.1 and HTTP/1.0 -as a Ranch protocol. - -:: Types - -: opts() = [{compress, boolean()} - | {env, cowboy_middleware:env()} - | {max_empty_lines, non_neg_integer()} - | {max_header_name_length, non_neg_integer()} - | {max_header_value_length, non_neg_integer()} - | {max_headers, non_neg_integer()} - | {max_keepalive, non_neg_integer()} - | {max_request_line_length, non_neg_integer()} - | {middlewares, [module()]} - | {onresponse, cowboy:onresponse_fun()} - | {timeout, timeout()}] - -Configuration for the HTTP protocol handler. - -This configuration is passed to Cowboy when starting listeners -using `cowboy:start_http/4` or `cowboy:start_https/4` functions. - -It can be updated without restarting listeners using the -Ranch functions `ranch:get_protocol_options/1` and -`ranch:set_protocol_options/2`. - -:: Option descriptions - -The default value is given next to the option name. - -: compress (false) - -When enabled, Cowboy will attempt to compress the response body. - -: env ([{listener, Ref}]) - -Initial middleware environment. - -: max_empty_lines (5) - -Maximum number of empty lines before a request. - -: max_header_name_length (64) - -Maximum length of header names. - -: max_header_value_length (4096) - -Maximum length of header values. - -: max_headers (100) - -Maximum number of headers allowed per request. - -: max_keepalive (100) - -Maximum number of requests allowed per connection. - -: max_request_line_length (4096) - -Maximum length of the request line. - -: middlewares ([cowboy_router, cowboy_handler]) - -List of middlewares to execute for every requests. - -: onresponse (undefined) - -Fun called every time a response is sent. - -: timeout (5000) - -Time in ms with no requests before Cowboy closes the connection. |