0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 13:10:24 +00:00

Partially update manual for the cowboy_req

Only the access functions have been modified so far.
This commit is contained in:
Loïc Hoguin 2016-11-05 14:17:30 +02:00
parent 8fe700f341
commit faca7866ed
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
16 changed files with 1409 additions and 895 deletions

View file

@ -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)]