aboutsummaryrefslogblamecommitdiffstats
path: root/doc/src/manual/ranch.get_max_connections.asciidoc
blob: d10c97531035f4ced8a23f3fee7a14f14f23b8b6 (plain) (tree)
1
2
3
4
5



                              
                                                                                       








                                       
                                                            








                  





                                                                            


           
                                                            










                                                                        
= ranch:get_max_connections(3)

== Name

ranch:get_max_connections - Get the max number of connections per connection supervisor

== Description

[source,erlang]
----
get_max_connections(Ref :: ranch:ref())
    -> MaxConns :: ranch:max_conns()
----

Get the max number of connections per connection supervisor.

== Arguments

Ref::

The listener name.

== Return value

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 per connection supervisor
[source,erlang]
----
MaxConns = ranch:get_max_connections(example).
----

== See also

link:man:ranch:get_protocol_options(3)[ranch:get_protocol_options(3)],
link:man:ranch:get_transport_options(3)[ranch:get_transport_options(3)],
link:man:ranch:set_max_connections(3)[ranch:set_max_connections(3)],
link:man:ranch(3)[ranch(3)]