aboutsummaryrefslogtreecommitdiffstats
path: root/manual/cowboy_handler.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-05-17 13:13:27 +0200
committerLoïc Hoguin <[email protected]>2013-05-17 13:13:27 +0200
commit666c59bc422172562673916ed3a8a796c4f9fbf4 (patch)
treef561151846de077513fa767edc10165a469d09ef /manual/cowboy_handler.md
parent0e0ec7b1203a8490ee9a876f9274fe0c64e708f8 (diff)
downloadcowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.tar.gz
cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.tar.bz2
cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.zip
Add the Cowboy Function Reference
The manual details every stable public functions of Cowboy.
Diffstat (limited to 'manual/cowboy_handler.md')
-rw-r--r--manual/cowboy_handler.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/manual/cowboy_handler.md b/manual/cowboy_handler.md
new file mode 100644
index 0000000..8d13492
--- /dev/null
+++ b/manual/cowboy_handler.md
@@ -0,0 +1,25 @@
+cowboy_handler
+==============
+
+The `cowboy_handler` middleware executes the handler passed
+through the environment values `handler` and `handler_opts`,
+and add the result of this execution to the environment as
+the value `result`, indicating that the request has been
+handled and received a response.
+
+Environment input:
+ * handler = module()
+ * handler_opts = any()
+
+Environment output:
+ * result = ok
+
+Types
+-----
+
+None.
+
+Exports
+-------
+
+None.