cowboy:stop_listener(3)

Name

cowboy:stop_listener - Stop the given listener

Description

stop_listener(Name :: ranch:ref())
    -> ok | {error, not_found}.

Stop a previously started listener.

Alias of ranch:stop_listener(3).

Arguments

Name

The name of the listener to be stopped.

The name of the listener is the first argument given to the cowboy:start_clear(3), cowboy:start_tls(3) or ranch:start_listener(3) function.

Return value

The atom ok is returned on success.

The {error, not_found} tuple is returned when the listener does not exist.

Changelog

  • 1.0: Function introduced.

Examples

Stop a listener
ok = cowboy:stop_listener(example).

See also

cowboy(3), cowboy:start_clear(3), cowboy:start_tls(3), ranch(3), ranch:start_listener(3)

Cowboy 2.10 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.