RTCForge API Reference v1.1.1
    Preparing search index...

    Interface Membership

    Registry of the nodes currently forming a cluster.

    Membership lets components discover peers, register themselves with a heartbeat TTL, and react to nodes joining or leaving. The default in-process implementation is MemoryMembership; GossipMembership provides a decentralized, gossip-based implementation for multi-node deployments. Pair with MembershipReconciler to turn membership snapshots into add/remove/update callbacks.

    interface Membership {
        deregister(nodeId: string): Promise<void>;
        list(): Promise<NodeInfo[]>;
        register(node: NodeInfo, ttlMs: number): Promise<void>;
        watch(callback: (nodes: NodeInfo[]) => void): () => void;
    }
    Index

    Methods

    deregister list register watch

    Methods

    • Removes a node from the registry.

      Parameters

      • nodeId: string

        The id of the node to remove.

      Returns Promise<void>

    • Registers (or refreshes) a node with a heartbeat lifetime.

      Parameters

      • node: NodeInfo

        The node to register.

      • ttlMs: number

        Lifetime in milliseconds; the node is considered gone if not refreshed within this window.

      Returns Promise<void>

    • Subscribes to membership changes.

      Parameters

      • callback: (nodes: NodeInfo[]) => void

        Invoked with the full set of live nodes whenever membership changes.

      Returns () => void

      A function that cancels the subscription when called.

    Settings

    Member Visibility

    On This Page

    Methods