ranch:resume_listener(3)

Name

ranch:resume_listener - Resume a suspended listener

Description

resume_listener(Ref :: ranch_ref())
    -> ok | {error, any()}

Resume a suspended listener.

Ranch will start listening for and accepting connections again. The function ranch:set_transport_options(3) can be used to change the transport options before resuming the listener.

Nothing is done when the listener is already running.

Arguments

Ref

The listener name.

Return value

The atom ok is returned on success.

An error tuple is returned when the listener could not be restarted.

Changelog

  • 1.6: Function introduced.

Examples

Resume a listener
ok = ranch:resume_listener(example).

See also

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

Ranch 1.7 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.