cowboy_req:port(3)

Name

cowboy_req:port - URI port number

Description

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:

#{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
Port = cowboy_req:port(Req).

See also

cowboy_req(3)

Cowboy 2.8 Function Reference

Navigation

Version select

Like my work? Donate!

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.