From 136d443b5c38bee96f5d995dfea3629ef07564c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 18 Jul 2019 09:59:28 +0200 Subject: Announce Ranch 2.0.0-rc.1 Adds Ranch 2.0 documentation and removes documentation for very old Cowboy and Ranch, along with Erlang.mk documentation which is available on its own website. --- .../manual/ranch.set_transport_options/index.html | 229 +++++++++++++++++++++ 1 file changed, 229 insertions(+) create mode 100644 docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html (limited to 'docs/en/ranch/2.0/manual/ranch.set_transport_options') diff --git a/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html b/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html new file mode 100644 index 00000000..49c6c424 --- /dev/null +++ b/docs/en/ranch/2.0/manual/ranch.set_transport_options/index.html @@ -0,0 +1,229 @@ + + + + + + + + + + Nine Nines: ranch:set_transport_options(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

ranch:set_transport_options(3)

+ +

Name

+

ranch:set_transport_options - Set the transport options

+

Description

+
+
set_transport_options(Ref       :: ranch:ref(),
+                      TransOpts :: ranch:opts())
+    -> ok | {error, Reason :: term()}
+
+

Set the transport options.

+

Changes to the following options will take effect...

+
  • immediately: +
    • max_connections +
      • +
    • handshake_timeout +
      • +
    • shutdown +
      • +
    +
    • +
  • only after the listener has been suspended and resumed: +
    • num_acceptors +
      • +
    • num_listen_sockets +
      • +
    • socket_opts +
      • +
    +
    • +
  • only when the entire listener is restarted: +
    • connection_type +
      • +
    • num_conns_sups +
      • +
    • logger +
      • +
    +
    • +
+

Arguments

+
Ref
+

The listener name.

+
+
TransOpts
+

The new transport options.

+
+
+

Return value

+

The atom ok is returned on success.

+

An error tuple is returned on failure, for example if the given transport options contain invalid values.

+

Changelog

+
  • 2.0: The restriction that the listener must be suspended has been removed. +
    • +
  • 2.0: The TransOpts argument must no longer contain Ranch-specific options if given as a list. Use a map. +
    • +
+

Examples

+
Set the transport options
+
+
Ref = example,
+
+ok = ranch:suspend_listener(Ref),
+ok = ranch:set_transport_options(Ref, TransOpts),
+ok = ranch:resume_listener(Ref).
+
+

See also

+

ranch:suspend_listener(3), ranch:resume_listener(3), ranch:get_transport_options(3), ranch:set_max_connections(3), ranch:set_protocol_options(3), ranch(3)

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

+ Ranch + 2.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.

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