Interface AdapterInterface

src/adapters/adapter-interface.ts:7–139

const Discover = require('node-discover');

export interface AdapterInterface {
    /**
     * The app connections storage class to manage connections.
     */
    namespaces?: Map<string, Namespace>;

    /**
     * The list of nodes in the current private network.
     */
    driver?: AdapterInterface;

    /**
     * Initialize the adapter.
     */
    init(): Promise<AdapterInterface>;

    /**
     * Get the app namespace.
     */
    getNamespace(appId: string): Namespace;

    /**
     * Get all namespaces.
     */
    getNamespaces(): Map<string, Namespace>;

    /**
     * Add a new socket to the namespace.
     */
    addSocket(appId: string, ws: WebSocket): Promise<boolean>;

    /**
     * Remove a socket from the namespace.
     */
    removeSocket(appId: string, wsId: string): Promise<boolean>;

    /**
     * Add a socket ID to the channel identifier.
     * Return the total number of connections after the connection.
     */
    addToChannel(appId: string, channel: string, ws: WebSocket): Promise<number>;

    /**
     * Remove a socket ID from the channel identifier.
     * Return the total number of connections remaining to the channel.
     */
    removeFromChannel(appId: string, channel: string|string[], wsId: string): Promise<number|void>;

    /**
     * Send a message to a namespace and channel.
     */
    send(appId: string, channel: string, data: string, exceptingId?: string|null): any;

    /**
     * Terminate an User ID's connections.
     */
    terminateUserConnections(appId: string, userId: number|string): void;