Interface AddressManager

Hierarchy

  • AddressManager

Properties

addObservedAddr confirmObservedAddr getAddresses getAnnounceAddrs getListenAddrs getObservedAddrs removeObservedAddr

Properties

addObservedAddr

addObservedAddr: ((addr: Multiaddr) => void)

Type declaration

    • (addr: Multiaddr): void

    • Add peer observed addresses. These will then appear in the output of getObservedAddrs but not getAddresses() until their dialability has been confirmed via a call to confirmObservedAddr.

      Parameters

      Returns void

confirmObservedAddr

confirmObservedAddr: ((addr: Multiaddr) => void)

Type declaration

    • (addr: Multiaddr): void

    • Signal that we have confidence an observed multiaddr is publicly dialable - this will make it appear in the output of getAddresses()

      Parameters

      Returns void

getAddresses

getAddresses: (() => Multiaddr[])

Type declaration

getAnnounceAddrs

getAnnounceAddrs: (() => Multiaddr[])

Type declaration

getListenAddrs

getListenAddrs: (() => Multiaddr[])

Type declaration

getObservedAddrs

getObservedAddrs: (() => Multiaddr[])

Type declaration

    • (): Multiaddr[]

    • Get observed multiaddrs - these addresses may not have been confirmed as publicly dialable yet

      Returns Multiaddr[]

removeObservedAddr

removeObservedAddr: ((addr: Multiaddr) => void)

Type declaration

    • (addr: Multiaddr): void

    • Signal that we do not have confidence an observed multiaddr is publicly dialable - this will remove it from the output of getObservedAddrs()

      Parameters

      Returns void

Settings

Member Visibility

Theme