From 666c59bc422172562673916ed3a8a796c4f9fbf4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Fri, 17 May 2013 13:13:27 +0200
Subject: Add the Cowboy Function Reference

The manual details every stable public functions of Cowboy.
---
 manual/cowboy_sub_protocol.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 manual/cowboy_sub_protocol.md

(limited to 'manual/cowboy_sub_protocol.md')

diff --git a/manual/cowboy_sub_protocol.md b/manual/cowboy_sub_protocol.md
new file mode 100644
index 0000000..a8ecae1
--- /dev/null
+++ b/manual/cowboy_sub_protocol.md
@@ -0,0 +1,34 @@
+cowboy_sub_protocol
+===================
+
+The `cowboy_sub_protocol` behaviour defines the interface used
+by modules that implement a protocol on top of HTTP.
+
+Types
+-----
+
+None.
+
+Callbacks
+---------
+
+### upgrade(Req, Env, Handler, Opts)
+	-> {ok, Req, Env}
+	| {suspend, Module, Function, Args}
+	| {halt, Req}
+	| {error, StatusCode, Req}
+
+> Types:
+>  *  Req = cowboy_req:req()
+>  *  Env = env()
+>  *  Handler = module()
+>  *  Opts = any()
+>  *  Module = module()
+>  *  Function = atom()
+>  *  Args = [any()]
+>  *  StatusCode = cowboy:http_status()
+>
+> Upgrade the protocol.
+>
+> Please refer to the `cowboy_middleware` manual for a
+> description of the return values.
-- 
cgit v1.2.3