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:

• ranch(3) - Socket acceptor pool
• ranch_proxy_header(3) - PROXY protocol

Transports:

• ranch_ssl(3) - SSL transport
• ranch_tcp(3) - TCP transport

Behaviors:

• ranch_protocol(3) - Protocol modules
• ranch_transport(3) - Transport modules

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 the following application environment configuration parameters:

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.

ranch_sup_intensity (1)

Maximum number of restarts allowed for the ranch_sup supervisor during ranch_sup_period seconds.

ranch_sup_period (5)

Time window, in seconds, for the ranch_sup restart intensity.

Changelog

• 2.4: The ranch_sup_intensity and ranch_sup_period application environment parameters were documented.

See also

ssl(7)