Class ConnectionManager

Hierarchy

TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>
- ConnectionManager

Implements

IConnectionManager

Constructors

`Private` constructor

new ConnectionManager(): waku.ConnectionManager
Returns waku.ConnectionManager
Overrides TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>.constructor
- Defined in packages/core/dist/lib/connection_manager.d.ts:23

Properties

`Private` #private

#private: any

`Private` attemptDial

attemptDial: any

`Private` configuredPubsubTopics

configuredPubsubTopics: any

`Private` currentActiveParallelDialCount

currentActiveParallelDialCount: any

`Private` dialAttemptsForPeer

dialAttemptsForPeer: any

`Private` dialErrorsForPeer

dialErrorsForPeer: any

`Private` dialPeer

dialPeer: any

`Private` dialPeerStorePeers

dialPeerStorePeers: any

`Private` dispatchDiscoveryEvent

dispatchDiscoveryEvent: any

`Private` dropConnection

dropConnection: any

`Private` getPeerShardInfo

getPeerShardInfo: any

`Private` getTagNamesForPeer

getTagNamesForPeer: any

Fetches the tag names for a given peer

`Private` isPeerDialableBasedOnBootstrapStatus

isPeerDialableBasedOnBootstrapStatus: any

Checks if the peer is dialable based on the following conditions:

If the peer is a bootstrap peer, it is only dialable if the number of current bootstrap connections is less than the max allowed.
If the peer is not a bootstrap peer

`Private` isPeerTopicConfigured

isPeerTopicConfigured: any

`Private` keepAliveManager

keepAliveManager: any

`Private` libp2p

libp2p: any

`Private` onEventHandlers

onEventHandlers: any

`Private` online

online: any

`Private` options

options: any

`Private` pendingPeerDialQueue

pendingPeerDialQueue: any

`Private` processDialQueue

processDialQueue: any

`Private` run

run: any

`Private` shouldDialPeer

shouldDialPeer: any

Checks if the peer should be dialed based on the following conditions:

If the peer is already connected, don't dial
If the peer is not part of any of the configured pubsub topics, don't dial
If the peer is not dialable based on bootstrap status, don't dial
If the peer is already has an active dial attempt, or has been dialed before, don't dial it

Returns

true if the peer should be dialed, false otherwise

`Private` startPeerConnectionListener

startPeerConnectionListener: any

`Private` startPeerDisconnectionListener

startPeerDisconnectionListener: any

`Private` startPeerDiscoveryListener

startPeerDiscoveryListener: any

`Private` toggleOffline

toggleOffline: any

`Private` toggleOnline

toggleOnline: any

`Private` `Static` instances

instances: any

Methods

addEventListener

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

dispatchEvent

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

getPeersByDiscovery

getPeersByDiscovery(): Promise<PeersByDiscoveryResult>
Returns Promise<PeersByDiscoveryResult>
Implementation of IConnectionManager.getPeersByDiscovery
- Defined in packages/core/dist/lib/connection_manager.d.ts:22

isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/core/dist/lib/connection_manager.d.ts:18

listenerCount

listenerCount(type): number
Parameters
- type: string
Returns number
Implementation of IConnectionManager.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 CONNECTION_STATUS | (keyof IPeersByDiscoveryEvents)
Parameters
- type: K
- Optional listener: null | EventHandler<(IPeersByDiscoveryEvents & IConnectionStateEvents)[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of IConnectionManager.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: CONNECTION_STATUS | (keyof IPeersByDiscoveryEvents)
- Optional detail: CustomEventInit<Detail>
Returns boolean
Implementation of IConnectionManager.safeDispatchEvent
Inherited from TypedEventEmitter.safeDispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:34

stop

stop(): void
Returns void
Implementation of IConnectionManager.stop
- Defined in packages/core/dist/lib/connection_manager.d.ts:26

`Static` create

create(peerId, libp2p, keepAliveOptions, pubsubTopics, relay?, options?): waku.ConnectionManager
Parameters
- peerId: string
- libp2p: Libp2p
- keepAliveOptions: KeepAliveOptions
- pubsubTopics: string[]
- Optional relay: IRelay
- Optional options: ConnectionManagerOptions
Returns waku.ConnectionManager
- Defined in packages/core/dist/lib/connection_manager.d.ts:21

Class ConnectionManager

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Returns waku.ConnectionManager

Properties

Private #private

Private attemptDial

Private configuredPubsubTopics

Private currentActiveParallelDialCount

Private dialAttemptsForPeer

Private dialErrorsForPeer

Private dialPeer

Private dialPeerStorePeers

Private dispatchDiscoveryEvent

Private dropConnection

Private getPeerShardInfo

Private getTagNamesForPeer

Private isPeerDialableBasedOnBootstrapStatus

Private isPeerTopicConfigured

Private keepAliveManager

Private libp2p

Private onEventHandlers

Private online

Private options

Private pendingPeerDialQueue

Private processDialQueue

Private run

Private shouldDialPeer

Returns

Private startPeerConnectionListener

Private startPeerDisconnectionListener

Private startPeerDiscoveryListener

Private toggleOffline

Private toggleOnline

Private Static instances

Methods

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

getPeersByDiscovery

Returns Promise<PeersByDiscoveryResult>

isConnected

Returns boolean

listenerCount

Parameters

Returns number

removeEventListener

Type Parameters

Parameters

Returns void

safeDispatchEvent

Type Parameters

Parameters

Returns boolean

stop

Returns void

Static create

Parameters

Returns waku.ConnectionManager

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Private` #private

`Private` attemptDial

`Private` configuredPubsubTopics

`Private` currentActiveParallelDialCount

`Private` dialAttemptsForPeer

`Private` dialErrorsForPeer

`Private` dialPeer

`Private` dialPeerStorePeers

`Private` dispatchDiscoveryEvent

`Private` dropConnection

`Private` getPeerShardInfo

`Private` getTagNamesForPeer

`Private` isPeerDialableBasedOnBootstrapStatus

`Private` isPeerTopicConfigured

`Private` keepAliveManager

`Private` libp2p

`Private` onEventHandlers

`Private` online

`Private` options

`Private` pendingPeerDialQueue

`Private` processDialQueue

`Private` run

`Private` shouldDialPeer

`Private` startPeerConnectionListener

`Private` startPeerDisconnectionListener

`Private` startPeerDiscoveryListener

`Private` toggleOffline

`Private` toggleOnline

`Private` `Static` instances

`Static` create