WebSocket Server

Module defined in lua/common/utils/wsUtils.lua. WebSocket server creation and management utilities using BeamNG's BNGWebWSServer API.

---

Exports

Functions

M.createOrGetWS(listenAddr, port, path, protocolName, redirPage, enableDataStreams)

Create or retrieve an existing WebSocket server, auto-detecting the best network adapter.

• Parameters:
  • listenAddr - string - Listen address
  • port - number - Listen port
  • path - string - WebSocket path (e.g., "/")
  • protocolName - string - WebSocket protocol name
  • redirPage - string|nil - HTTP redirect page for non-WS requests
  • enableDataStreams - boolean|nil - Enable data streaming (default: true)
• Returns: BNGWebWSServer, string - Server object and chosen IP address

Internal Notes

• Auto-tests each network adapter by creating a test client connection
• Skips VirtualBox and VMware virtual adapters
• generateRandomData creates random strings for connection testing
• testWSConnection validates bidirectional data transfer before selecting adapter
• Data streams enabled by default unless explicitly disabled

---

See Also

• utils/ - Utility Modules - Directory overview
• calltracer Reference - Related reference
• dateUtils Reference - Related reference
• debugDraw Reference - Related reference
• Common Libraries Overview - Guide