MqttX.Transport.WebSocket (MqttX v0.11.2)

Copy Markdown View Source

WebSocket transport adapter for MqttX.

This adapter uses Bandit + WebSockAdapter to serve MQTT over WebSocket (RFC 6455).

Usage

MqttX.Server.start_link(MyHandler, handler_opts,
  transport: MqttX.Transport.WebSocket,
  port: 8083
)

Options

  • :port - Port to listen on (default: 8083)
  • :ip - IP address to bind to (default: {0, 0, 0, 0})
  • :path - WebSocket path (default: /mqtt)
  • :max_frame_size - Largest WebSocket frame accepted, in bytes (:infinity disables). When unset, websock_adapter's own default applies — note that changed in websock_adapter 0.6.0 from :infinity to 10 MB, so set this explicitly if you need behaviour independent of which adapter version resolves.

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