From 992831c7a516b5183c2af06260829d41aa45267c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 9 Sep 2021 12:15:32 +0200 Subject: Ranch 2.1.0 --- docs/en/ranch/2.1/manual/ranch.get_addr/index.html | 197 +++++++++++++++++++++ 1 file changed, 197 insertions(+) create mode 100644 docs/en/ranch/2.1/manual/ranch.get_addr/index.html (limited to 'docs/en/ranch/2.1/manual/ranch.get_addr/index.html') diff --git a/docs/en/ranch/2.1/manual/ranch.get_addr/index.html b/docs/en/ranch/2.1/manual/ranch.get_addr/index.html new file mode 100644 index 00000000..12ce9487 --- /dev/null +++ b/docs/en/ranch/2.1/manual/ranch.get_addr/index.html @@ -0,0 +1,197 @@ + + + + + + + + + + Nine Nines: ranch:get_addr(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

ranch:get_addr(3)

+ +

Name

+

ranch:get_addr - Get the listening address

+

Description

+
+
get_addr(Ref :: ranch:ref())
+    -> {IP   :: inet:ip_address(),
+        Port :: inet:port_number()}
+     | {local, SocketFile :: binary()}
+     | {undefined, undefined}
+
+

Get the listening address.

+

Arguments

+
Ref
+

The listener name.

+
+
+

Return value

+

The address of the listener is returned as a tuple of the form {IP, Port} when listening on a network interface, or {local, SocketFile} when listening on a UNIX Domain socket. When the listener is suspended, {undefined, undefined} will be returned.

+

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

+

The socket file is the path of a file on your system the socket is bound to.

+

Examples

+
Get the listening port and IP
+
+
{IP, Port} = ranch:get_addr(example).
+
+
Get the listening UNIX Domain socket file
+
+
{local, SocketFile} = ranch:get_addr(example).
+
+

See also

+

ranch:start_listener(3), ranch:get_port(3), ranch:info(3), ranch(3)

+ + + + + + +
+ +
+ + +

+ Ranch + 2.1 + 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.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3