aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.get_addr.asciidoc
blob: 3938347b3a053f001d6171e6cce5f711c6c25c63 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
= ranch:get_addr(3)

== Name

ranch:get_addr - Get the listening port and IP

== Description

[source,erlang]
----
get_addr(Ref :: ranch:ref())
    -> {IP   :: inet:ip_address(),
        Port :: inet:port_number()}
----

Get the listening port and IP.

== Arguments

Ref::

The listener name.

== Return value

The address of the listener is returned as a tuple.

The IP address is the IP of the network interface the
socket is bound to.

== Examples

.Get the listening port and IP
[source,erlang]
----
{IP, Port} = ranch:get_addr(example).
----

== See also

link:man:ranch:start_listener(3)[ranch:start_listener(3)],
link:man:ranch:get_port(3)[ranch:get_port(3)],
link:man:ranch:info(3)[ranch:info(3)],
link:man:ranch(3)[ranch(3)]