aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjuhlig <[email protected]>2019-07-17 16:02:47 +0200
committerLoïc Hoguin <[email protected]>2019-07-18 09:35:56 +0200
commitaf739162fd43d46f2562af96c56147054457518e (patch)
tree51d5c937c3ee0af17c8cbe75d0f7bcd70aacfa91 /doc
parentd017c0f5860bc1a5c775c9a61db407e29c575f80 (diff)
downloadranch-af739162fd43d46f2562af96c56147054457518e.tar.gz
ranch-af739162fd43d46f2562af96c56147054457518e.tar.bz2
ranch-af739162fd43d46f2562af96c56147054457518e.zip
Return listener info as a map2.0.0-rc.1
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/ranch.info.asciidoc11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/src/manual/ranch.info.asciidoc b/doc/src/manual/ranch.info.asciidoc
index 69a8818..651daf2 100644
--- a/doc/src/manual/ranch.info.asciidoc
+++ b/doc/src/manual/ranch.info.asciidoc
@@ -8,10 +8,10 @@ ranch:info - Overview of Ranch listeners
[source,erlang]
----
-info() -> [{Ref, Info}]
+info() -> #{Ref := Info}
info(Ref) -> Info
-Info :: [{Key :: atom(), Value :: any()}]
+Info :: #{Key :: atom() := Value :: any()}
----
Overview of Ranch listeners.
@@ -31,7 +31,6 @@ pid:: Pid of the listener's top-level supervisor.
status:: Listener status, either running or suspended.
ip:: Interface Ranch listens on.
port:: Port number Ranch listens on.
-num_acceptors:: Number of acceptor processes.
max_connections:: Maximum number of connections per connection supervisor.
active_connections:: Number of active connections.
all_connections:: Number of connections, including those removed from the count.
@@ -40,8 +39,10 @@ transport_options:: Transport options.
protocol:: Protocol module.
protocol_options:: Protocol options.
-// @todo I mistakenly removed the num_acceptors key,
-// it should be added back.
+== Changelog
+
+* *2.0*: The listener info is now returned as a map.
+* *2.0*: The `num_acceptors` key has been removed.
== Examples