Class ConnectionManager

Hierarchy

EventEmitter<IPeersByDiscoveryEvents>
- ConnectionManager

Implements

IConnectionManager

Constructors

`Private` constructor

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

Properties

`Private` #private

#private: any

`Private` attemptDial

attemptDial: any

`Private` currentActiveDialCount

currentActiveDialCount: any

`Private` dialAttemptsForPeer

dialAttemptsForPeer: any

`Private` dialErrorsForPeer

dialErrorsForPeer: any

`Private` dialPeer

dialPeer: any

`Private` dialPeerStorePeers

dialPeerStorePeers: any

`Private` dropConnection

dropConnection: any

`Private` getTagNamesForPeer

getTagNamesForPeer: any

Fetches the tag names for a given peer

`Private` keepAliveManager

keepAliveManager: any

`Private` libp2p

libp2p: any

`Private` onEventHandlers

onEventHandlers: 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 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` startPeerConnectionListener

startPeerConnectionListener: any

`Private` startPeerDisconnectionListener

startPeerDisconnectionListener: any

`Private` startPeerDiscoveryListener

startPeerDiscoveryListener: any

`Private` `Static` instances

instances: any

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof IPeersByDiscoveryEvents
Parameters
- type: K
- listener: null | EventHandler<IPeersByDiscoveryEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Implementation of IConnectionManager.addEventListener

Inherited from EventEmitter.addEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:19

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Implementation of IConnectionManager.dispatchEvent

Inherited from EventEmitter.dispatchEvent
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:21

getPeersByDiscovery

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

listenerCount

listenerCount(type): number
Parameters
- type: string
Returns number
Implementation of IConnectionManager.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:18

removeEventListener

removeEventListener<K>(type, listener?, options?): void
Type Parameters
- K extends keyof IPeersByDiscoveryEvents
Parameters
- type: K
- Optional listener: null | EventHandler<IPeersByDiscoveryEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of IConnectionManager.removeEventListener

Inherited from EventEmitter.removeEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:20

safeDispatchEvent

safeDispatchEvent<Detail>(type, detail): boolean
Type Parameters
- Detail
Parameters
- type: keyof IPeersByDiscoveryEvents
- detail: CustomEventInit<Detail>
Returns boolean
Implementation of IConnectionManager.safeDispatchEvent

Inherited from EventEmitter.safeDispatchEvent
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:22

stop

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

`Static` create

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

Class ConnectionManager

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Returns waku.ConnectionManager

Properties

Private #private

Private attemptDial

Private currentActiveDialCount

Private dialAttemptsForPeer

Private dialErrorsForPeer

Private dialPeer

Private dialPeerStorePeers

Private dropConnection

Private getTagNamesForPeer

Private keepAliveManager

Private libp2p

Private onEventHandlers

Private options

Private pendingPeerDialQueue

Private processDialQueue

Private run

Private shouldDialPeer

Private startPeerConnectionListener

Private startPeerDisconnectionListener

Private startPeerDiscoveryListener

Private Static instances

Methods

addEventListener

Type Parameters

K extends keyof IPeersByDiscoveryEvents

Parameters

type: K

listener: null | EventHandler<IPeersByDiscoveryEvents[K]>

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

getPeersByDiscovery

Returns Promise<PeersByDiscoveryResult>

listenerCount

Parameters

type: string

Returns number

removeEventListener

Type Parameters

K extends keyof IPeersByDiscoveryEvents

Parameters

type: K

Optional listener: null | EventHandler<IPeersByDiscoveryEvents[K]>

Optional options: boolean | EventListenerOptions

Returns void

safeDispatchEvent

Type Parameters

Detail

Parameters

type: keyof IPeersByDiscoveryEvents

detail: CustomEventInit<Detail>

Returns boolean

stop

Returns void

Static create

Parameters

peerId: string

libp2p: Libp2p

keepAliveOptions: KeepAliveOptions

Optional relay: IRelay

Optional options: ConnectionManagerOptions

Returns waku.ConnectionManager

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Private` #private

`Private` attemptDial

`Private` currentActiveDialCount

`Private` dialAttemptsForPeer

`Private` dialErrorsForPeer

`Private` dialPeer

`Private` dialPeerStorePeers

`Private` dropConnection

`Private` getTagNamesForPeer

`Private` keepAliveManager

`Private` libp2p

`Private` onEventHandlers

`Private` options

`Private` pendingPeerDialQueue

`Private` processDialQueue

`Private` run

`Private` shouldDialPeer

`Private` startPeerConnectionListener

`Private` startPeerDisconnectionListener

`Private` startPeerDiscoveryListener

`Private` `Static` instances

`Optional` options: boolean | AddEventListenerOptions

`Optional` listener: null | EventHandler<IPeersByDiscoveryEvents[K]>

`Optional` options: boolean | EventListenerOptions

`Static` create

`Optional` relay: IRelay

`Optional` options: ConnectionManagerOptions