From 119d52295f5723ca5ade6661a11621a88e021677 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 14 Nov 2013 16:46:31 +0100 Subject: Add documentation for cowboy_spdy --- manual/cowboy_spdy.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 manual/cowboy_spdy.md (limited to 'manual/cowboy_spdy.md') diff --git a/manual/cowboy_spdy.md b/manual/cowboy_spdy.md new file mode 100644 index 0000000..527dbb1 --- /dev/null +++ b/manual/cowboy_spdy.md @@ -0,0 +1,40 @@ +cowboy_spdy +=========== + +The `cowboy_spdy` module implements SPDY/3 as a Ranch protocol. + +Types +----- + +### opts() = [{env, cowboy_middleware:env()} + | {middlewares, [module()]} + | {onrequest, cowboy:onrequest_fun()} + | {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. + - onrequest (undefined) + - Fun called every time a request is received. + - onresponse (undefined) + - Fun called every time a response is sent. + +Exports +------- + +None. -- cgit v1.2.3