aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.get_port.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/ranch.get_port.asciidoc')
-rw-r--r--doc/src/manual/ranch.get_port.asciidoc6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/src/manual/ranch.get_port.asciidoc b/doc/src/manual/ranch.get_port.asciidoc
index 0de4a3a..5c5563e 100644
--- a/doc/src/manual/ranch.get_port.asciidoc
+++ b/doc/src/manual/ranch.get_port.asciidoc
@@ -9,7 +9,7 @@ ranch:get_port - Get the listening port
[source,erlang]
----
get_port(Ref :: ranch:ref())
- -> Port :: inet:port_number()
+ -> Port :: inet:port_number() | undefined
----
Get the listening port.
@@ -28,6 +28,10 @@ The listener name.
The listening port is returned.
+When the listener is suspended or using a UNIX Domain
+socket instead of a network interface, `undefined`
+will be returned.
+
== Examples
.Get the listening port