@ipshipyard/libp2p-inspector
    Preparing search index...

    Interface MetricsRPC

    RPC operations exposed by the metrics

    interface MetricsRPC {
        contentRouting: ContentRouting;
        peerRouting: PeerRouting;
        pubsub: {
            getSubscribers(component: string, topic: string): Promise<PeerId[]>;
            getTopics(component: string): Promise<string[]>;
            publish(
                component: string,
                topic: string,
                message: Uint8Array,
            ): Promise<void>;
            subscribe(component: string, topic: string): Promise<void>;
            unsubscribe(component: string, topic: string): Promise<void>;
        };
        closeConnection(peerId: PeerId, options?: AbortOptions): Promise<void>;
        identify(
            component: string,
            peerIdOrMultiaddr: string,
            options?: AbortOptions,
        ): Promise<IdentifyResult>;
        init(
            options?: AbortOptions,
        ): Promise<
            {
                capabilities: Record<string, string[]>;
                debug: string;
                peers: Peer[];
                self: Peer;
            },
        >;
        openConnection(
            peerIdOrMultiaddr: string,
            options?: OpenConnectionOptions,
        ): Promise<Connection>;
        ping(
            component: string,
            peerIdOrMultiaddr: string,
            options?: AbortOptions,
        ): Promise<number>;
        setDebug(namespace?: string): Promise<void>;
    }
    Index

    Properties

    contentRouting peerRouting pubsub

    Methods

    closeConnection identify init openConnection ping setDebug

    Properties

    contentRouting: ContentRouting

    Make content routing queries

    peerRouting: PeerRouting

    Make peer routing queries

    pubsub: {
        getSubscribers(component: string, topic: string): Promise<PeerId[]>;
        getTopics(component: string): Promise<string[]>;
        publish(
            component: string,
            topic: string,
            message: Uint8Array,
        ): Promise<void>;
        subscribe(component: string, topic: string): Promise<void>;
        unsubscribe(component: string, topic: string): Promise<void>;
    }

    PubSub operations

    Type declaration

    • getSubscribers: function
      • getSubscribers(component: string, topic: string): Promise<PeerId[]>

        Get the list of peers we know about who subscribe to the topic

        Parameters

        • component: string
        • topic: string

        Returns Promise<PeerId[]>

    • getTopics: function
      • getTopics(component: string): Promise<string[]>

        Get the list of subscriptions for the current node

        Parameters

        • component: string

        Returns Promise<string[]>

    • publish: function
    • subscribe: function
      • subscribe(component: string, topic: string): Promise<void>

        Subscribe to a PubSub topic

        Parameters

        • component: string
        • topic: string

        Returns Promise<void>

    • unsubscribe: function
      • unsubscribe(component: string, topic: string): Promise<void>

        Unsubscribe from a PubSub topic

        Parameters

        • component: string
        • topic: string

        Returns Promise<void>

    Methods

    • Called by DevTools on initial connect

      Parameters

      Returns Promise<
          {
              capabilities: Record<string, string[]>;
              debug: string;
              peers: Peer[];
              self: Peer;
          },
      >

    • Ping a remote node and return the RTT

      Parameters

      • component: string
      • peerIdOrMultiaddr: string
      • Optionaloptions: AbortOptions

      Returns Promise<number>

    • Update the currently active debugging namespaces

      Parameters

      • Optionalnamespace: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods