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_spdy.asciidoc | |
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_spdy.asciidoc')
-rw-r--r-- | doc/src/manual/cowboy_spdy.asciidoc | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_spdy.asciidoc b/doc/src/manual/cowboy_spdy.asciidoc new file mode 100644 index 0000000..b0dcb70 --- /dev/null +++ b/doc/src/manual/cowboy_spdy.asciidoc @@ -0,0 +1,42 @@ += cowboy_spdy(3) + +== Name + +cowboy_spdy - SPDY protocol + +== Description + +The `cowboy_spdy` module implements SPDY/3 as a Ranch protocol. + +== Types + +=== opts() = [Option] + +[source,erlang] +---- +Option = {env, cowboy_middleware:env()} + | {middlewares, [module()]} + | {onresponse, cowboy:onresponse_fun()} +---- + +Configuration for the SPDY protocol handler. + +This configuration is passed to Cowboy when starting listeners +using the `cowboy:start_spdy/4` function. + +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. + +env ([{listener, Ref}]):: + Initial middleware environment. + +middlewares ([cowboy_router, cowboy_handler]):: + List of middlewares to execute for every requests. + +onresponse (undefined):: + Fun called every time a response is sent. |