aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.set_max_connections.asciidoc
diff options
context:
space:
mode:
authorjuhlig <[email protected]>2019-05-08 15:05:27 +0200
committerLoïc Hoguin <[email protected]>2019-05-08 16:38:47 +0200
commitd59eef5c737d0b08eb8c16c5316300e863bc935c (patch)
treebe6ab3327717f847677484edf027af9e21266045 /doc/src/manual/ranch.set_max_connections.asciidoc
parentaa64151149e947145728a1f1339c689f1100720e (diff)
downloadranch-d59eef5c737d0b08eb8c16c5316300e863bc935c.tar.gz
ranch-d59eef5c737d0b08eb8c16c5316300e863bc935c.tar.bz2
ranch-d59eef5c737d0b08eb8c16c5316300e863bc935c.zip
Add the num_conns_sups option
This new option allows configuring the number of connection supervisors. The old behavior can be obtained by setting this value to 1. A value larger than num_acceptors will result in some connection supervisors not being used as the acceptors currently only use one connection supervisor.
Diffstat (limited to 'doc/src/manual/ranch.set_max_connections.asciidoc')
-rw-r--r--doc/src/manual/ranch.set_max_connections.asciidoc12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/src/manual/ranch.set_max_connections.asciidoc b/doc/src/manual/ranch.set_max_connections.asciidoc
index 2559afe..cc1bb20 100644
--- a/doc/src/manual/ranch.set_max_connections.asciidoc
+++ b/doc/src/manual/ranch.set_max_connections.asciidoc
@@ -2,7 +2,7 @@
== Name
-ranch:set_max_connections - Set the max number of connections
+ranch:set_max_connections - Set the max number of connections per connection supervisor
== Description
@@ -13,7 +13,7 @@ set_max_connections(Ref :: ranch:ref(),
-> ok
----
-Set the max number of connections.
+Set the max number of connections per connection supervisor.
The change will be applied immediately. If the new value is
smaller than the previous one, Ranch will wait for the extra
@@ -28,15 +28,19 @@ The listener name.
MaxConns::
-The new maximum number of connections.
+The new maximum number of connections per connection supervisor.
== Return value
The atom `ok` is always returned. It can be safely ignored.
+== Changelog
+
+* *2.0*: The maximum number of connections is now per connection supervisor.
+
== Examples
-.Set the max number of connections
+.Set the max number of connections per connection supervisor
[source,erlang]
----
ranch:set_max_connections(example, 10000).