MqttX.Transport.Ranch (MqttX v0.11.2)

Copy Markdown View Source

Ranch transport adapter for MqttX.

This adapter uses Ranch as the underlying TCP/TLS server.

Usage

MqttX.Server.start_link(MyHandler, handler_opts,
  transport: MqttX.Transport.Ranch,
  port: 1883
)

Options

  • :port - Port to listen on (default: 1883)
  • :num_acceptors - Number of acceptor processes (default: 100)
  • :ranch_transport - Ranch transport (:ranch_tcp or :ranch_ssl, default: :ranch_tcp). Named :transport before v0.11.0, which collided with MqttX.Server's own :transport option (the adapter module) — that collision made this adapter fail to start.
  • :transport_options - SSL/TLS options when using :ranch_ssl, merged over a secure baseline (TLS 1.2/1.3, secure_renegotiate)

All protocol-level options (:max_packet_size, :max_idle_timeout, :connect_timeout, :max_retained_messages, :rate_limit, …) behave as documented in MqttX.Transport.ThousandIsland.