Class ConnectionManager

Hierarchy

TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>
- ConnectionManager

Implements

IConnectionManager

Constructors

`Private` constructor

new ConnectionManager(libp2p, keepAliveOptions, configuredPubsubTopics, relay?, options?): ConnectionManager
Parameters
- libp2p: Libp2p
- keepAliveOptions: KeepAliveOptions
- configuredPubsubTopics: string[]
- Optional relay: IRelay
- Optional options: Partial<ConnectionManagerOptions>
Returns ConnectionManager
Overrides TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>.constructor
- Defined in packages/core/src/lib/connection_manager.ts:173

Properties

`Private` #private

#private: any

`Readonly` configuredPubsubTopics

configuredPubsubTopics: string[]

`Private` currentActiveParallelDialCount

currentActiveParallelDialCount: number = 0

`Private` dialAttemptsForPeer

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

`Private` dialErrorsForPeer

dialErrorsForPeer: Map<string, any> = ...

`Private` keepAliveManager

keepAliveManager: KeepAliveManager

`Private` libp2p

libp2p: Libp2p

`Private` onEventHandlers

onEventHandlers: {
    peer:connect: ((evt) => void);
    peer:disconnect: ((evt) => void);
    peer:discovery: ((evt) => void);
} = ...

Type declaration

peer:connect: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerId>
    Returns void
peer:disconnect: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerId>
    Returns void
peer:discovery: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerInfo>
    Returns void

`Private` online

online: boolean = false

`Private` options

options: ConnectionManagerOptions

`Private` pendingPeerDialQueue

pendingPeerDialQueue: PeerId[] = []

`Private` `Static` instances

instances: Map<string, ConnectionManager> = ...

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

attemptDial

attemptDial(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:364

`Private` dialPeer

dialPeer(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:235

`Private` dialPeerStorePeers

dialPeerStorePeers(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:210

`Private` dispatchDiscoveryEvent

dispatchDiscoveryEvent(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:519

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

dropConnection

dropConnection(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
Implementation of IConnectionManager.dropConnection
- Defined in packages/core/src/lib/connection_manager.ts:108

`Private` getPeerShardInfo

getPeerShardInfo(peerId, peerStore): Promise<undefined | ShardInfo>
Parameters
- peerId: PeerId
- peerStore: PeerStore
Returns Promise<undefined | ShardInfo>
- Defined in packages/core/src/lib/connection_manager.ts:566

getPeersByDiscovery

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

`Private` getTagNamesForPeer

getTagNamesForPeer(peerId): Promise<string[]>
Fetches the tag names for a given peer
Parameters
- peerId: PeerId
Returns Promise<string[]>
- Defined in packages/core/src/lib/connection_manager.ts:539

isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/core/src/lib/connection_manager.ts:43

`Private` isPeerDialableBasedOnBootstrapStatus

isPeerDialableBasedOnBootstrapStatus(peerId): Promise<boolean>
Checks if the peer is dialable based on the following conditions:
1. If the peer is a bootstrap peer, it is only dialable if the number of current bootstrap connections is less than the max allowed.
2. If the peer is not a bootstrap peer
Parameters
- peerId: PeerId
Returns Promise<boolean>
- Defined in packages/core/src/lib/connection_manager.ts:499

`Private` isPeerTopicConfigured

isPeerTopicConfigured(peerId): Promise<boolean>
Parameters
- peerId: PeerId
Returns Promise<boolean>
- Defined in packages/core/src/lib/connection_manager.ts:549

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

`Private` processDialQueue

processDialQueue(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:318

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

`Private` run

run(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:228

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

`Private` shouldDialPeer

shouldDialPeer(peerId): Promise<boolean>
Checks if the peer should be dialed based on the following conditions:
1. If the peer is already connected, don't dial
2. If the peer is not part of any of the configured pubsub topics, don't dial
3. If the peer is not dialable based on bootstrap status, don't dial
4. If the peer is already has an active dial attempt, or has been dialed before, don't dial it
Parameters
- peerId: PeerId
Returns Promise<boolean>
true if the peer should be dialed, false otherwise
- Defined in packages/core/src/lib/connection_manager.ts:450

`Private` startPeerConnectionListener

startPeerConnectionListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:338

`Private` startPeerDisconnectionListener

startPeerDisconnectionListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:345

`Private` startPeerDiscoveryListener

startPeerDiscoveryListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:331

`Static` create

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

Class ConnectionManager

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

Returns ConnectionManager

Properties

Private #private

Readonly configuredPubsubTopics

Private currentActiveParallelDialCount

Private dialAttemptsForPeer

Private dialErrorsForPeer

Private keepAliveManager

Private libp2p

Private onEventHandlers

Type declaration

peer:connect: ((evt) => void)

Parameters

Returns void

peer:disconnect: ((evt) => void)

Parameters

Returns void

peer:discovery: ((evt) => void)

Parameters

Returns void

Private online

Private options

Private pendingPeerDialQueue

Private Static instances

Methods

addEventListener

Type Parameters

Parameters

Returns void

attemptDial

Parameters

Returns Promise<void>

Private dialPeer

Parameters

Returns Promise<void>

Private dialPeerStorePeers

Returns Promise<void>

Private dispatchDiscoveryEvent

Parameters

Returns Promise<void>

dispatchEvent

Parameters

Returns boolean

dropConnection

Parameters

Returns Promise<void>

Private getPeerShardInfo

Parameters

Returns Promise<undefined | ShardInfo>

getPeersByDiscovery

Returns Promise<PeersByDiscoveryResult>

Private getTagNamesForPeer

Parameters

Returns Promise<string[]>

isConnected

Returns boolean

Private isPeerDialableBasedOnBootstrapStatus

Parameters

Returns Promise<boolean>

Private isPeerTopicConfigured

Parameters

Returns Promise<boolean>

listenerCount

Parameters

Returns number

Private processDialQueue

Returns void

removeEventListener

Type Parameters

Parameters

`Private` constructor

`Private` #private

`Readonly` configuredPubsubTopics

`Private` currentActiveParallelDialCount

`Private` dialAttemptsForPeer

`Private` dialErrorsForPeer

`Private` keepAliveManager

`Private` libp2p

`Private` onEventHandlers

`Private` online

`Private` options

`Private` pendingPeerDialQueue

`Private` `Static` instances

`Private` dialPeer

`Private` dialPeerStorePeers

`Private` dispatchDiscoveryEvent

`Private` getPeerShardInfo

`Private` getTagNamesForPeer

`Private` isPeerDialableBasedOnBootstrapStatus

`Private` isPeerTopicConfigured

`Private` processDialQueue

`Private` run

`Private` shouldDialPeer

`Private` startPeerConnectionListener

`Private` startPeerDisconnectionListener

`Private` startPeerDiscoveryListener

`Private` toggleOffline

`Private` toggleOnline

`Static` create