Ranch Function Reference

Name

ranch - Socket acceptor pool for TCP protocols

Description

Ranch is a socket acceptor pool for TCP protocols.

Ranch manages listeners which are a set of processes that accept and manage connections. The connection's transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service.

Modules

Functions:

Transports:

Behaviors:

Dependencies

  • ssl - Secure communication over sockets

All these applications must be started before the ranch application. To start Ranch and all dependencies at once:

{ok, _} = application:ensure_all_started(ranch).

Environment

The ranch application defines one application environment configuration parameter.

profile (false)

When enabled, Ranch will start eprof profiling automatically.

You can use the ranch_app:profile_output/0 function to stop profiling and output the results to the files procs.profile and total.profile. Do not use in production.

See also

ssl(7)

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