From 4023e7f4e429179fd9c2cce4487c33646c6bd327 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Thu, 14 Jan 2016 13:35:25 +0100
Subject: Convert the documentation to Asciidoc

A few small revisions were made, and Erlang.mk has been updated.
---
 doc/src/manual/cowboy_spdy.asciidoc | 42 +++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 doc/src/manual/cowboy_spdy.asciidoc

(limited to 'doc/src/manual/cowboy_spdy.asciidoc')

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.
-- 
cgit v1.2.3

