From a63ee9b363aa7214343966690b50d77f4d3475e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 1 Aug 2018 16:52:33 +0200 Subject: Ranch 1.6.0 --- .../1.6/manual/ranch.suspend_listener/index.html | 177 +++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html (limited to 'docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html') diff --git a/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html b/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html new file mode 100644 index 00000000..0ade506f --- /dev/null +++ b/docs/en/ranch/1.6/manual/ranch.suspend_listener/index.html @@ -0,0 +1,177 @@ + + + + + + + + + + Nine Nines: ranch:suspend_listener(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

ranch:suspend_listener(3)

+ +

Name

+

ranch:suspend_listener - Suspend a running listener

+

Description

+
+
suspend_listener(Ref :: ranch_ref())
+    -> ok | {error, any()}
+
+

Suspend a running listener.

+

Ranch will stop listening for and accepting connections and the listening socket will be closed. Existing connections will continue undisturbed. The function ranch:wait_for_connections(3) can be used to wait for connections to be closed if necessary.

+

Some transport options can only be changed when the listener is suspended. Please consult the ranch:set_transport_options(3) manual for more information.

+

Nothing is done when the listener is already suspended.

+

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 suspended.

+

Changelog

+
  • 1.6: Function introduced. +
    • +
+

Examples

+
Suspend a listener
+
+
ok = ranch:suspend_listener(example).
+
+

See also

+

ranch:start_listener(3), ranch:stop_listener(3), ranch:resume_listener(3), ranch:get_status(3), ranch:set_transport_options(3), ranch:wait_for_connections(3), ranch(3)

+ + + + + + +
+ +
+ + +

+ Ranch + 1.6 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3