Skip to main content

Troubleshooting

getWebSocketEngine() returns nothing / throws​

No server adapter is registered. Load an adapter package such as @quik/websocket-express and enable the WebSocket server flag in bootstrap.

Clients get disconnected unexpectedly​

The server considers a peer dead if it doesn't answer a ping within websocket.heartbeat.timeoutMilliseconds. Raise the timeout for high-latency clients, or confirm the client calls attachWebSocketHeartbeat().

Client never receives pings​

Confirm websocket.heartbeat.enabled is true on the server and that the client is connected to the configured websocket.path.

Heartbeat messages collide with application messages​

Custom pingMessageType/pongMessageType values (websocket.heartbeat.pingMessageType/pongMessageType) must not overlap with message types used by your own application protocol.