Class PeerExchangeDiscovery

Hierarchy

TypedEventEmitter<PeerDiscoveryEvents>
- PeerExchangeDiscovery

Implements

PeerDiscovery

Index

Constructors

constructor

new PeerExchangeDiscovery(components, pubsubTopics, options?): PeerExchangeDiscovery
Parameters
- components: Components
- pubsubTopics: string[]
- options: Options = {}
Returns PeerExchangeDiscovery
Overrides TypedEventEmitter<PeerDiscoveryEvents>.constructor
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:80

Properties

`Private` #private

#private: any

`Private` `Readonly` components

components: Components

`Private` isStarted

isStarted: boolean

`Private` `Readonly` options

options: Options

`Private` `Readonly` peerExchange

peerExchange: WakuPeerExchange

`Private` queryAttempts

queryAttempts: Map<string, number> = ...

`Private` queryingPeers

queryingPeers: Set<string> = ...

Accessors

[peerDiscoverySymbol]

get [peerDiscoverySymbol](): true
Returns true
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:123

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:127

Methods

`Private` abortQueriesForPeer

abortQueriesForPeer(peerIdStr): void
Parameters
- peerIdStr: string
Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:219

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:30

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:32

`Private` `Readonly` handleDiscoveredPeer

handleDiscoveredPeer(event): void
Parameters
- event: CustomEvent<IdentifyResult>
Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:63

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:29

`Private` query

query(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:163

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:31

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:33

start

start(): void
Start emitting events

Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:95

`Private` `Readonly` startRecurringQueries

startRecurringQueries(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:131

stop

stop(): void
Remove event listener

Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange_discovery.ts:112

Generated using TypeDoc