Class AddressManager

fires

AddressManager#change:addresses Emitted when a addresses change.

Hierarchy

Index

References

Constructors

Properties

Methods

References

AddressManagerOptions

Re-exports AddressManagerOptions

Events

Re-exports Events

Multiaddr

Re-exports Multiaddr

Constructors

constructor

  • new AddressManager(peerId: PeerId, __namedParameters?: { announce: undefined | string[]; listen: undefined | string[] }): AddressManager

  • Responsible for managing the peer addresses. Peers can specify their listen and announce addresses. The listen addresses will be used by the libp2p transports to listen for new connections, while the announce addresses will be used for the peer addresses' to other peers in the network.

    Parameters

    • peerId: PeerId

      The Peer ID of the node

    • Optional __namedParameters: { announce: undefined | string[]; listen: undefined | string[] }
      • announce: undefined | string[]
      • listen: undefined | string[]

    Returns AddressManager

Properties

announce

announce: Set<string>

listen

listen: Set<string>

observed

observed: Set<any>

peerId

peerId: PeerId

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

addObservedAddr

  • addObservedAddr(addr: string | Multiaddr): void

  • Add peer observed addresses

    Parameters

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

getAnnounceAddrs

  • Get peer announcing multiaddrs.

    Returns Multiaddr[]

getListenAddrs

  • Get peer listen multiaddrs.

    Returns Multiaddr[]

getMaxListeners

  • getMaxListeners(): number

getObservedAddrs

  • Get observed multiaddrs.

    Returns Array<Multiaddr>

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

on

  • on(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

once

  • once(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): any

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): any

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns any

setMaxListeners

  • setMaxListeners(n: number): any