Class PubSubPeerDiscovery

A Peer Discovery Service that leverages libp2p Pubsub to find peers.

Hierarchy

TypedEventEmitter<PeerDiscoveryEvents>
- PubSubPeerDiscovery

Implements

Constructors

constructor

new PubSubPeerDiscovery(components, init?): PubSubPeerDiscovery
Parameters
- components: PubSubPeerDiscoveryComponents
- init: PubsubPeerDiscoveryInit = {}
Returns PubSubPeerDiscovery
Overrides TypedEventEmitter<PeerDiscoveryEvents>.constructor
- Defined in src/index.ts:142

Properties

`Private` #private

#private: any

`Readonly` [peerDiscoverySymbol]

[peerDiscoverySymbol]: true = true

`Readonly` [toStringTag]

[toStringTag]: "@libp2p/pubsub-peer-discovery" = '@libp2p/pubsub-peer-discovery'

`Private` `Readonly` components

components: PubSubPeerDiscoveryComponents

`Private` `Readonly` interval

interval: number

`Private` `Optional` intervalId

intervalId?: Timeout

`Private` `Readonly` listenOnly

listenOnly: boolean

`Private` `Readonly` log

`Private` `Readonly` topics

topics: string[]

Methods

_broadcast

_broadcast(): void
Performs a broadcast via Pubsub publish

Returns void
- Defined in src/index.ts:235

_onMessage

_onMessage(event): void
Handles incoming pubsub messages for our discovery topic
Parameters
- event: CustomEvent<Message>
Returns void
- Defined in src/index.ts:268

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "peer"
Parameters
- type: K
- listener: null | EventHandler<PeerDiscoveryEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Implementation of PeerDiscovery.addEventListener
Inherited from TypedEventEmitter.addEventListener
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:31

afterStart

afterStart(): void
Subscribes to the discovery topic on libp2p.pubsub and performs a broadcast immediately, and every this.interval

Returns void
Implementation of Startable.afterStart
- Defined in src/index.ts:178

beforeStop

beforeStop(): void
Returns void
Implementation of Startable.beforeStop
- Defined in src/index.ts:209

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Implementation of PeerDiscovery.dispatchEvent
Inherited from TypedEventEmitter.dispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:33

isStarted

isStarted(): boolean
Returns boolean
- Defined in src/index.ts:166

listenerCount

listenerCount(type): number
Parameters
- type: string
Returns number
Implementation of PeerDiscovery.listenerCount
Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:30

removeEventListener

removeEventListener<K>(type, listener?, options?): void
Type Parameters
- K extends "peer"
Parameters
- type: K
- Optional listener: null | EventHandler<PeerDiscoveryEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of PeerDiscovery.removeEventListener
Inherited from TypedEventEmitter.removeEventListener
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:32

safeDispatchEvent

safeDispatchEvent<Detail>(type, detail?): boolean
Type Parameters
- Detail
Parameters
- type: "peer"
- Optional detail: CustomEventInit<Detail>
Returns boolean
Implementation of PeerDiscovery.safeDispatchEvent
Inherited from TypedEventEmitter.safeDispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:34

start

start(): void
Returns void
Implementation of Startable.start
- Defined in src/index.ts:170

stop

stop(): void
Unsubscribes from the discovery topic

Returns void
Implementation of Startable.stop
- Defined in src/index.ts:225