aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-08-25 18:49:58 +0200
committerLoïc Hoguin <[email protected]>2015-08-25 18:49:58 +0200
commit236d0f8eec82eb43c566d4aa6d2532e1318665f3 (patch)
tree58de9af7309094a3896fdebf21fce0f37f917d6c /doc
parentd1cd1674e8dd8ef3f9bc2b5d3e86d95a3dbceb0d (diff)
downloadranch-236d0f8eec82eb43c566d4aa6d2532e1318665f3.tar.gz
ranch-236d0f8eec82eb43c566d4aa6d2532e1318665f3.tar.bz2
ranch-236d0f8eec82eb43c566d4aa6d2532e1318665f3.zip
Add ranch:get_addr/1
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/ranch.asciidoc8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/src/manual/ranch.asciidoc b/doc/src/manual/ranch.asciidoc
index f2e8a7d..22ab159 100644
--- a/doc/src/manual/ranch.asciidoc
+++ b/doc/src/manual/ranch.asciidoc
@@ -82,6 +82,14 @@ Return child specifications for a new listener.
This function can be used to embed a listener directly
in an application instead of letting Ranch handle it.
+=== get_addr(Ref) -> {IP, Port}
+
+Ref = ref():: Listener name.
+IP = inet:ip_address():: IP of the interface used by this listener.
+Port = inet:port_number():: Port number used by this listener.
+
+Return the IP address and port for the given listener.
+
=== get_max_connections(Ref) -> MaxConns
Ref = ref():: Listener name.