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.resume_listener.asciidoc | 57 +++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 doc/src/manual/ranch.resume_listener.asciidoc (limited to 'doc/src/manual/ranch.resume_listener.asciidoc') diff --git a/doc/src/manual/ranch.resume_listener.asciidoc b/doc/src/manual/ranch.resume_listener.asciidoc new file mode 100644 index 0000000..f3a9f84 --- /dev/null +++ b/doc/src/manual/ranch.resume_listener.asciidoc @@ -0,0 +1,57 @@ += ranch:resume_listener(3) + +== Name + +ranch:resume_listener - Resume a suspended listener + +== Description + +[source,erlang] +---- +resume_listener(Ref :: ranch_ref()) + -> ok | {error, any()} +---- + +Resume a suspended listener. + +Ranch will start listening for and accepting connections +again. The function +link:man:ranch:set_transport_options(3)[ranch:set_transport_options(3)] +can be used to change the transport options before resuming +the listener. + +Nothing is done when the listener is already running. + +== Arguments + +Ref:: + +The listener name. + +== Return value + +The atom `ok` is returned on success. + +An error tuple is returned when the listener could not be restarted. + +== Changelog + +* *1.6*: Function introduced. + +== Examples + +.Resume a listener +[source,erlang] +---- +ok = ranch:resume_listener(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:get_status(3)[ranch:get_status(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)] -- cgit v1.2.3