ranch:remove_connection(3)

Name

ranch:remove_connection - Remove connection from the count

Description

remove_connection(Ref :: ranch:ref()) -> ok

Remove connection from the count.

This connection will no longer be included in the count when limiting the number of connections. This can be useful in a mixed environment where some connections are active and others are passive. Passive connections spend most of their time idling and are not consuming much resources.

This function may only be called from a connection process.

Arguments

Ref

The listener name.

Return value

The atom ok is always returned. It can be safely ignored.

Examples

Remove the connection process from the count
ranch:remove_connection(example).

See also

ranch:start_listener(3), ranch:handshake(3), ranch(3)

Ranch 2.1 Function Reference

Navigation

Version select

Like my work? Donate!

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.