aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.host_info.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-11-07 18:03:47 +0200
committerLoïc Hoguin <[email protected]>2016-11-07 18:03:47 +0200
commit7b248e5163fd852d6defe967318da849433dadb1 (patch)
tree2db5fc09210cb77e77cf14a9ac61fef932131f15 /doc/src/manual/cowboy_req.host_info.asciidoc
parentbd34dfdedd369b42b1e6920f60c32b0594802aa2 (diff)
downloadcowboy-7b248e5163fd852d6defe967318da849433dadb1.tar.gz
cowboy-7b248e5163fd852d6defe967318da849433dadb1.tar.bz2
cowboy-7b248e5163fd852d6defe967318da849433dadb1.zip
Add man pages for the parse/match/binding cowboy_req functions
Diffstat (limited to 'doc/src/manual/cowboy_req.host_info.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.host_info.asciidoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.host_info.asciidoc b/doc/src/manual/cowboy_req.host_info.asciidoc
new file mode 100644
index 0000000..77a4c11
--- /dev/null
+++ b/doc/src/manual/cowboy_req.host_info.asciidoc
@@ -0,0 +1,48 @@
+= cowboy_req:host_info(3)
+
+== Name
+
+cowboy_req:host_info - Access the route's heading host segments
+
+== Description
+
+[source,erlang]
+----
+host_info(Req :: cowboy_req:req()) -> cowboy_router:tokens()
+----
+
+Return the tokens for the heading host segments.
+
+This is the part of the host name that was matched using
+the `...` notation.
+
+== Arguments
+
+Req::
+
+The Req object.
+
+== Return value
+
+The tokens are returned as a list of case insensitive
+binary strings.
+
+== Changelog
+
+* *2.0*: Only the tokens are returned, they are no longer wrapped in a tuple.
+* *1.0*: Function introduced.
+
+== Examples
+
+.Get the host_info tokens
+[source,erlang]
+----
+HostInfo = cowboy_req:host_info(Req).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:binding(3)[cowboy_req:binding(3)],
+link:man:cowboy_req:bindings(3)[cowboy_req:bindings(3)],
+link:man:cowboy_req:path_info(3)[cowboy_req:path_info(3)]