Interface MetricsRPC

RPC operations exposed by the metrics

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

Properties

contentRouting peerRouting pubsub

Methods

closeConnection init openConnection setDebug

Properties

contentRouting

contentRouting: ContentRouting

Make content routing queries

peerRouting

peerRouting: PeerRouting

Make peer routing queries

pubsub

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

PubSub operations

Type declaration

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

    • Get the list of subscriptions for the current node

      Parameters

      • component: string

      Returns Promise<string[]>

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

    • Subscribe to a PubSub topic

      Parameters

      • component: string
      • topic: string

      Returns Promise<void>

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

    • Unsubscribe from a PubSub topic

      Parameters

      • component: string
      • topic: string

      Returns Promise<void>

Methods

closeConnection

init

  • init(options?): Promise<{
        capabilities: Record<string, string[]>;
        debug: string;
        peers: Peer[];
        self: Peer;
    }>

  • Called by DevTools on initial connect

    Parameters

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

openConnection

setDebug

  • setDebug(namespace?): Promise<void>

  • Update the currently active debugging namespaces

    Parameters

    • Optional namespace: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

contentRoutingpeerRoutingpubsubcloseConnectioninitopenConnectionsetDebug