Aller au contenu principal

How to disconnect a specific client

Standalone​

function disconnectSocket(id) {
  io.of("/").sockets.get(id)?.disconnect();
}

Cluster​

Without acknowledgement​

function disconnectSocket(id) {
  io.in(id).disconnectSockets();
}

Reference: server.disconnectSockets([close])

astuce

This method can also be used to disconnect a given user:

function computeUserId(socket) {
  // to be implemented
}

io.on("connection", (socket) => {
  const userId = computeUserId(socket);
  socket.join(userId); // use a room named after the user ID
});

function disconnectUser(userId) {
  io.in(userId).disconnectSockets();
}

With acknowledgement​

function disconnectLocalSocket(id) {
  return io.of("/").sockets.get(id)?.disconnect() !== undefined;
}

io.on("disconnectSocket", (id, cb) => {
  cb(disconnectLocalSocket(id));
});

async function disconnectSocket(id) {
  if (disconnectLocalSocket(id)) {
    return true;
  }
  try {
    const res = await io.serverSideEmitWithAck("disconnectSocket", id);
    return res.some(v => v);
  } catch (e) {
    // something went wrong
  }
}

Reference: server.serverSideEmitWithAck(eventName[, ...args]);

< Back to the list of examples