diff options
author | Loïc Hoguin <[email protected]> | 2018-07-18 17:24:41 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-07-18 17:24:41 +0200 |
commit | 8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a (patch) | |
tree | 8cfcf87f69be525252addd32d880abb8ad02a1ad /doc/src/manual/ranch.get_status.asciidoc | |
parent | a230411488fe2d8ae1e8bf414a4fe4ecf3662a83 (diff) | |
download | ranch-8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a.tar.gz ranch-8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a.tar.bz2 ranch-8b4c6f4bf9880d59bbc012b6ba9d5e60c4f62b3a.zip |
Add one manual per function for the ranch module
Also review and update the ranch(7) manual and fix a few specs.
Diffstat (limited to 'doc/src/manual/ranch.get_status.asciidoc')
-rw-r--r-- | doc/src/manual/ranch.get_status.asciidoc | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/src/manual/ranch.get_status.asciidoc b/doc/src/manual/ranch.get_status.asciidoc new file mode 100644 index 0000000..eb45614 --- /dev/null +++ b/doc/src/manual/ranch.get_status.asciidoc @@ -0,0 +1,46 @@ += ranch:get_status(3) + +== Name + +ranch:get_status - Get a listener's running state + +== Description + +[source,erlang] +---- +get_status(Ref :: ranch_ref()) -> running | suspended +---- + +Get a listener's running state. + +== Arguments + +Ref:: + +The listener name. + +== Return value + +An atom is returned indicating the running status of the listener. + +== Changelog + +* *1.6*: Function introduced. + +== Examples + +.Get a listener's running state +[source,erlang] +---- +ranch:get_status(example). +---- + +== See also + +link:man:ranch:start_listener(3)[ranch:start_listener(3)], +link:man:ranch:stop_listener(3)[ranch:stop_listener(3)], +link:man:ranch:suspend_listener(3)[ranch:suspend_listener(3)], +link:man:ranch:resume_listener(3)[ranch:resume_listener(3)], +link:man:ranch:set_transport_options(3)[ranch:set_transport_options(3)], +link:man:ranch:wait_for_connections(3)[ranch:wait_for_connections(3)], +link:man:ranch(3)[ranch(3)] |