radius-read/dist/services/socketio.client.register.service.d.ts

Realtime Dashboard

import { SocketIoClientInfo, SocketIoUserInfo } from "./../models/socketio.model";
/**
 * Service for managing Socket.IO client registrations.
 */
export declare class SocketIoClientRegisterService {
    /**
     * Client information for registered Socket.IO clients.
     * @date Jun 26, 2025 02:29:58 PM
     * @author Biswaranjan Nayak
     *
     * @private
     * @type {SocketIoClientInfo[]}
     */
    private static _clientInfos;
    /**
     * Creates an instance of SocketIoClientRegisterService.
     */
    constructor();
    /**
     * Registers a Socket.IO client by adding the provided client information to the list of registered clients.
     * @param clientInfo
     */
    static register(clientInfo: SocketIoClientInfo): void;
    /**
     * Unregisters a Socket.IO client by disconnecting the socket associated with the provided user information.
     * @param userInfo
     */
    static unregister(userInfo: SocketIoUserInfo): void;
    /**
     * Clears the registered Socket.IO clients associated with the provided user information.
     * @param userInfo
     */
    static clear(userInfo: SocketIoUserInfo): void;
    /**
     * Gets the registered Socket.IO client information for the provided user information.
     * @param userInfo
     * @returns
     */
    static getSocket(userInfo: SocketIoUserInfo): any;
}