Class ConnectionManager

Hierarchy

EventEmitter<IPeersByDiscoveryEvents>
- ConnectionManager

Implements

IConnectionManager

Constructors

`Private` constructor

new ConnectionManager(libp2p, keepAliveOptions, relay?, options?): ConnectionManager
Parameters
- libp2p: Libp2p
- keepAliveOptions: KeepAliveOptions
- Optional relay: IRelay
- Optional options: Partial<ConnectionManagerOptions>
Returns ConnectionManager
Overrides EventEmitter<IPeersByDiscoveryEvents>.constructor
- Defined in packages/core/src/lib/connection_manager.ts:104

Properties

`Private` #private

#private: any

`Private` currentActiveDialCount

currentActiveDialCount: 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)
  - Returns ((evt) => void)
    - - (evt): void
      - Parameters
        
        evt: CustomEvent<PeerId>
        
        Returns void
peer:discovery: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerInfo>
    Returns void

`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 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

`Private` attemptDial

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

`Private` dialPeer

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

`Private` dialPeerStorePeers

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

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

`Private` dropConnection

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

getPeersByDiscovery

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

`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:424

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

`Private` processDialQueue

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

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

`Private` run

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

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

`Private` shouldDialPeer

shouldDialPeer(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:397

`Private` startPeerConnectionListener

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

`Private` startPeerDisconnectionListener

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

`Private` startPeerDiscoveryListener

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

stop

stop(): void
Returns void
Implementation of IConnectionManager.stop
- Defined in packages/core/src/lib/connection_manager.ts:158

`Static` create

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

Class ConnectionManager

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

libp2p: Libp2p

keepAliveOptions: KeepAliveOptions

Optional relay: IRelay

Optional options: Partial<ConnectionManagerOptions>

Returns ConnectionManager

Properties

Private #private

Private currentActiveDialCount

Private dialAttemptsForPeer

Private dialErrorsForPeer

Private keepAliveManager

Private libp2p

Private onEventHandlers

Type declaration

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

Parameters

evt: CustomEvent<PeerId>

Returns void

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

Returns ((evt) => void)

Parameters

evt: CustomEvent<PeerId>

Returns void

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

Parameters

evt: CustomEvent<PeerInfo>

Returns void

Private options

Private pendingPeerDialQueue

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

Private attemptDial

Parameters

peerId: PeerId

Returns Promise<void>

Private dialPeer

Parameters

peerId: PeerId

Returns Promise<void>

Private dialPeerStorePeers

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

Private dropConnection

Parameters

peerId: PeerId

Returns Promise<void>

getPeersByDiscovery

Returns Promise<PeersByDiscoveryResult>

Private getTagNamesForPeer

Parameters

peerId: PeerId

Returns Promise<string[]>

listenerCount

Parameters

type: string

Returns number

Private processDialQueue

Returns void

removeEventListener

`Private` constructor

`Optional` relay: IRelay

`Optional` options: Partial<ConnectionManagerOptions>

`Private` #private

`Private` currentActiveDialCount

`Private` dialAttemptsForPeer

`Private` dialErrorsForPeer

`Private` keepAliveManager

`Private` libp2p

`Private` onEventHandlers

`Private` options

`Private` pendingPeerDialQueue

`Private` `Static` instances

`Optional` options: boolean | AddEventListenerOptions

`Private` attemptDial

`Private` dialPeer

`Private` dialPeerStorePeers

`Private` dropConnection

`Private` getTagNamesForPeer

`Private` processDialQueue

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

`Optional` options: boolean | EventListenerOptions

`Private` run

`Private` shouldDialPeer

`Private` startPeerConnectionListener

`Private` startPeerDisconnectionListener

`Private` startPeerDiscoveryListener

`Static` create

`Optional` relay: IRelay

`Optional` options: ConnectionManagerOptions