ranch.get_max_connections.asciidoc 938 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. = ranch:get_max_connections(3)
  2. == Name
  3. ranch:get_max_connections - Get the max number of connections per connection supervisor
  4. == Description
  5. [source,erlang]
  6. ----
  7. get_max_connections(Ref :: ranch:ref())
  8. -> MaxConns :: ranch:max_conns()
  9. ----
  10. Get the max number of connections per connection supervisor.
  11. == Arguments
  12. Ref::
  13. The listener name.
  14. == Return value
  15. The maximum number of connections per connection supervisor
  16. is returned.
  17. == Changelog
  18. * *2.0*: The maximum number of connections is now per connection supervisor.
  19. == Examples
  20. .Get the max number of connections per connection supervisor
  21. [source,erlang]
  22. ----
  23. MaxConns = ranch:get_max_connections(example).
  24. ----
  25. == See also
  26. link:man:ranch:get_protocol_options(3)[ranch:get_protocol_options(3)],
  27. link:man:ranch:get_transport_options(3)[ranch:get_transport_options(3)],
  28. link:man:ranch:set_max_connections(3)[ranch:set_max_connections(3)],
  29. link:man:ranch(3)[ranch(3)]