diff options
author | Loïc Hoguin <[email protected]> | 2016-11-05 14:17:30 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-11-05 14:17:30 +0200 |
commit | faca7866ed1c59cd41e11fcfc5a9f95378380497 (patch) | |
tree | 7e33284b3426083154b7a1d52ae5db8996212739 /doc/src/manual/cowboy_req.port.asciidoc | |
parent | 8fe700f341d324c44f6c5f196f8c699c85ee6d78 (diff) | |
download | cowboy-faca7866ed1c59cd41e11fcfc5a9f95378380497.tar.gz cowboy-faca7866ed1c59cd41e11fcfc5a9f95378380497.tar.bz2 cowboy-faca7866ed1c59cd41e11fcfc5a9f95378380497.zip |
Partially update manual for the cowboy_req
Only the access functions have been modified so far.
Diffstat (limited to 'doc/src/manual/cowboy_req.port.asciidoc')
-rw-r--r-- | doc/src/manual/cowboy_req.port.asciidoc | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.port.asciidoc b/doc/src/manual/cowboy_req.port.asciidoc new file mode 100644 index 0000000..57f0875 --- /dev/null +++ b/doc/src/manual/cowboy_req.port.asciidoc @@ -0,0 +1,52 @@ += cowboy_req:port(3) + +== Name + +cowboy_req:port - URI port number + +== Description + +[source,erlang] +---- +port(Req :: cowboy_req:req()) -> Port :: inet:port_number() +---- + +Return the port number of the effective request URI. + +Note that the port number returned by this function is obtained +by parsing the host header. It may be different from the port +the peer used to connect to Cowboy. + +The port number can also be obtained using pattern matching: + +[source,erlang] +---- +#{port := Port} = Req. +---- + +== Arguments + +Req:: + +The Req object. + +== Return value + +The port number is returned as an integer. + +== Changelog + +* *2.0*: Only the port number is returned, it is no longer wrapped in a tuple. +* *1.0*: Function introduced. + +== Examples + +.Get the effective request URI's port number +[source,erlang] +---- +Port = cowboy_req:port(Req). +---- + +== See also + +link:man:cowboy_req(3)[cowboy_req(3)] |