From 8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 18 Jul 2018 17:24:41 +0200 Subject: Add one manual per function for the ranch module Also review and update the ranch(7) manual and fix a few specs. --- doc/src/manual/ranch.info.asciidoc | 65 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 doc/src/manual/ranch.info.asciidoc (limited to 'doc/src/manual/ranch.info.asciidoc') diff --git a/doc/src/manual/ranch.info.asciidoc b/doc/src/manual/ranch.info.asciidoc new file mode 100644 index 0000000..32cbefb --- /dev/null +++ b/doc/src/manual/ranch.info.asciidoc @@ -0,0 +1,65 @@ += ranch:info(3) + +== Name + +ranch:info - Overview of Ranch listeners + +== Description + +[source,erlang] +---- +info() -> [{Ref, Info}] +info(Ref) -> Info + +Info :: [{Key :: atom(), Value :: any()}] +---- + +Overview of Ranch listeners. + +== Arguments + +Ref:: + +The listener name. + +== Return value + +Returns detailed information about one or all +Ranch listeners. The following keys are returned: + +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. +active_connections:: Number of active connections. +all_connections:: Number of connections, including those removed from the count. +transport:: Transport module. +transport_options:: Transport options. +protocol:: Protocol module. +protocol_options:: Protocol options. + +// @todo I mistakenly removed the num_acceptors key, +// it should be added back. + +== Examples + +.Get information about all listeners +[source,erlang] +---- +AllInfo = ranch:info(). +---- + +.Get information about a specific listener +[source,erlang] +---- +Info = ranch:info(example). +---- + +== See also + +link:man:ranch:get_addr(3)[ranch:get_addr(3)], +link:man:ranch:get_port(3)[ranch:get_port(3)], +link:man:ranch:procs(3)[ranch:procs(3)], +link:man:ranch(3)[ranch(3)] -- cgit v1.2.3