Connection Status - CometChat Docs

CometChat SDK provides you with a mechanism to get real-time status of the connection to CometChat web-socket servers. Connection Status provides you with the below 3 methods to get the status of the connection to CometChat web-socket servers:

Delegate Method	Information
connecting	This method is triggered when CometChat SDK is trying to establish a connection to the web-socket server.
connected	This method is called when CometChat SDK has successfully established a connection and now is connected.
disconnected	This method is called when the CometChat SDK gets disconnected due to any issue while maintaining the connection like network fluctuations, etc.

Once the connection is broken, the disconnected callback is triggered, the SDK automatically tries to establish the connection again, thus going into the connecting state and triggering the connecting method. Once the attempt to connect is successful, the connected method is triggered thus letting the developer know that the connection is established and is active. To receive real-time connection status, you need to register ConnectionListener wherever you wish to receive the real-time status. You can use the addConnectionListener() method to do so.

TypeScript
JavaScript

const connectionStatus: string = CometChat.getConnectionStatus();

const connectionStatus = CometChat.getConnectionStatus();

Listen for Connection Changes

Register a ConnectionListener to receive real-time connection state updates. We recommend adding this on app startup after CometChat.init() completes.

TypeScript
JavaScript

let listenerID: string = "UNIQUE_LISTENER_ID";
CometChat.addConnectionListener(
  listenerID,
  new CometChat.ConnectionListener({
    onConnected: () => {
      console.log("ConnectionListener => On Connected");
    },
    inConnecting: () => {
      console.log("ConnectionListener => In connecting");
    },
    onDisconnected: () => {
      console.log("ConnectionListener => On Disconnected");
    },
  })
);

let listenerID = "UNIQUE_LISTENER_ID";
CometChat.addConnectionListener(
  listenerID,
  new CometChat.ConnectionListener({
    onConnected: () => {
      console.log("ConnectionListener => On Connected");
    },
    inConnecting: () => {
      console.log("ConnectionListener => In connecting");
    },
    onDisconnected: () => {
      console.log("ConnectionListener => On Disconnected");
    },
  })
);

Always remove connection listeners when they’re no longer needed (e.g., on component unmount or page navigation). Failing to remove listeners can cause memory leaks and duplicate event handling.

Next Steps

WebSocket Management

Manually manage WebSocket connections

Login Listener

Listen for login and logout events

All Real-Time Listeners

Complete reference for all SDK listeners

Setup SDK

Install and initialize the CometChat SDK

​Listen for Connection Changes

​Next Steps

WebSocket Management

Login Listener

All Real-Time Listeners

Setup SDK

Listen for Connection Changes

Next Steps