aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch.get_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.get_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.get_max_connections.asciidoc')
-rw-r--r--doc/src/manual/ranch.get_max_connections.asciidoc13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/src/manual/ranch.get_max_connections.asciidoc b/doc/src/manual/ranch.get_max_connections.asciidoc
index 3267c2d..d10c975 100644
--- a/doc/src/manual/ranch.get_max_connections.asciidoc
+++ b/doc/src/manual/ranch.get_max_connections.asciidoc
@@ -2,7 +2,7 @@
== Name
-ranch:get_max_connections - Get the max number of connections
+ranch:get_max_connections - Get the max number of connections per connection supervisor
== Description
@@ -12,7 +12,7 @@ get_max_connections(Ref :: ranch:ref())
-> MaxConns :: ranch:max_conns()
----
-Get the max number of connections.
+Get the max number of connections per connection supervisor.
== Arguments
@@ -22,11 +22,16 @@ The listener name.
== Return value
-The maximum number of connections is returned.
+The maximum number of connections per connection supervisor
+is returned.
+
+== Changelog
+
+* *2.0*: The maximum number of connections is now per connection supervisor.
== Examples
-.Get the max number of connections
+.Get the max number of connections per connection supervisor
[source,erlang]
----
MaxConns = ranch:get_max_connections(example).