Method disconnect

src/socketio/async_server.py:408–437

Disconnect a client. :param sid: Session ID of the client. :param namespace: The Socket.IO namespace to disconnect. If this argument is omitted the default namespace is used. :param ignore_queue: Only used when a message queue is configured. If

(self, sid, namespace=None, ignore_queue=False)

        return _session_context_manager(self, sid, namespace)

    async def disconnect(self, sid, namespace=None, ignore_queue=False):
        """Disconnect a client.

        :param sid: Session ID of the client.
        :param namespace: The Socket.IO namespace to disconnect. If this
                          argument is omitted the default namespace is used.
        :param ignore_queue: Only used when a message queue is configured. If
                             set to ``True``, the disconnect is processed
                             locally, without broadcasting on the queue. It is
                             recommended to always leave this parameter with
                             its default value of ``False``.

        Note: this method is a coroutine.
        """
        namespace = namespace or '/'
        if ignore_queue:
            delete_it = self.manager.is_connected(sid, namespace)
        else:
            delete_it = await self.manager.can_disconnect(sid, namespace)
        if delete_it:
            self.logger.info('Disconnecting %s [%s]', sid, namespace)
            eio_sid = self.manager.pre_disconnect(sid, namespace=namespace)
            if eio_sid in self._binary_packet:
                del self._binary_packet[eio_sid]
            await self._send_packet(eio_sid, self.packet_class(
                packet.DISCONNECT, namespace=namespace))
            await self._trigger_event('disconnect', namespace, sid,
                                      self.reason.SERVER_DISCONNECT)
            await self.manager.disconnect(sid, namespace=namespace,
                                          ignore_queue=True)

    async def shutdown(self):
        """Stop Socket.IO background tasks.