aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_spdy.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/cowboy_spdy.asciidoc')
-rw-r--r--doc/src/manual/cowboy_spdy.asciidoc42
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.