ranch:get_status(3)

Name

ranch:get_status - Get a listener's running state

Description

get_status(Ref :: ranch_ref()) -> running | suspended

Get a listener's running state.

Arguments

Ref

The listener name.

Return value

An atom is returned indicating the running status of the listener.

Changelog

• 1.6: Function introduced.

Examples

ranch:get_status(example).

See also

ranch:start_listener(3), ranch:stop_listener(3), ranch:suspend_listener(3), ranch:resume_listener(3), ranch:set_transport_options(3), ranch:wait_for_connections(3), ranch(3)