ranch.get_max_connections.asciidoc 742 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. = ranch:get_max_connections(3)
  2. == Name
  3. ranch:get_max_connections - Get the max number of connections
  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.
  11. == Arguments
  12. Ref::
  13. The listener name.
  14. == Return value
  15. The maximum number of connections is returned.
  16. == Examples
  17. .Get the max number of connections
  18. [source,erlang]
  19. ----
  20. MaxConns = ranch:get_max_connections(example).
  21. ----
  22. == See also
  23. link:man:ranch:get_protocol_options(3)[ranch:get_protocol_options(3)],
  24. link:man:ranch:get_transport_options(3)[ranch:get_transport_options(3)],
  25. link:man:ranch:set_max_connections(3)[ranch:set_max_connections(3)],
  26. link:man:ranch(3)[ranch(3)]