Class ConnectionManager

Hierarchy

EventEmitter<IPeersByDiscoveryEvents>
- ConnectionManager

Constructors

`Private` constructor

new ConnectionManager(libp2p: Libp2p, keepAliveOptions: KeepAliveOptions, relay?: IRelay, options?: Partial<ConnectionManagerOptions>): 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:99

Properties

`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: CustomEvent<PeerId>) => void);
    peer:disconnect: (() => ((evt: CustomEvent<PeerId>) => void));
    peer:discovery: ((evt: CustomEvent<PeerInfo>) => void);
} = ...

Type declaration

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

`Private` options

options: ConnectionManagerOptions

`Private` pendingPeerDialQueue

pendingPeerDialQueue: PeerId[] = []

`Static` `Private` instances

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

Methods

`Private` attemptDial

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

`Private` dialPeer

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

`Private` dialPeerStorePeers

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

dropConnection

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

getPeersByDiscovery

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

`Private` getTagNamesForPeer

getTagNamesForPeer(peerId: 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:408

`Private` processDialQueue

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

`Private` run

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

`Private` shouldDialPeer

shouldDialPeer(peerId: 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:381

`Private` startPeerConnectionListener

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

`Private` startPeerDisconnectionListener

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

`Private` startPeerDiscoveryListener

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

stop

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

`Static` create

create(peerId: string, libp2p: Libp2p, keepAliveOptions: KeepAliveOptions, relay?: IRelay, options?: ConnectionManagerOptions): 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:34

Class ConnectionManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

libp2p: Libp2p

keepAliveOptions: KeepAliveOptions

Optional relay: IRelay

Optional options: Partial<ConnectionManagerOptions>

Returns ConnectionManager

Properties

Private currentActiveDialCount

Private dialAttemptsForPeer

Private dialErrorsForPeer

Private keepAliveManager

Private libp2p

Private onEventHandlers

Type declaration

peer:connect: ((evt: CustomEvent<PeerId>) => void)

Parameters

evt: CustomEvent<PeerId>

Returns void

peer:disconnect: (() => ((evt: CustomEvent<PeerId>) => void))

Returns ((evt: CustomEvent<PeerId>) => void)

Parameters

evt: CustomEvent<PeerId>

Returns void

peer:discovery: ((evt: CustomEvent<PeerInfo>) => void)

Parameters

evt: CustomEvent<PeerInfo>

Returns void

Private options

Private pendingPeerDialQueue

Static Private instances

Methods

Private attemptDial

Parameters

peerId: PeerId

Returns Promise<void>

Private dialPeer

Parameters

peerId: PeerId

Returns Promise<void>

Private dialPeerStorePeers

Returns Promise<void>

dropConnection

Parameters

peerId: PeerId

Returns Promise<void>

getPeersByDiscovery

Returns Promise<PeersByDiscoveryResult>

Private getTagNamesForPeer

Parameters

peerId: PeerId

Returns Promise<string[]>

Private processDialQueue

Returns void

Private run

Returns Promise<void>

Private shouldDialPeer

Parameters

peerId: PeerId

Returns Promise<boolean>

Private startPeerConnectionListener

Returns void

Private startPeerDisconnectionListener

Returns void

Private startPeerDiscoveryListener

Returns void

stop

Returns void

Static create

Parameters

peerId: string

libp2p: Libp2p

keepAliveOptions: KeepAliveOptions

`Private` constructor

`Optional` relay: IRelay

`Optional` options: Partial<ConnectionManagerOptions>

`Private` currentActiveDialCount

`Private` dialAttemptsForPeer

`Private` dialErrorsForPeer

`Private` keepAliveManager

`Private` libp2p

`Private` onEventHandlers

`Private` options

`Private` pendingPeerDialQueue

`Static` `Private` instances

`Private` attemptDial

`Private` dialPeer

`Private` dialPeerStorePeers

`Private` getTagNamesForPeer

`Private` processDialQueue

`Private` run

`Private` shouldDialPeer

`Private` startPeerConnectionListener

`Private` startPeerDisconnectionListener

`Private` startPeerDiscoveryListener

`Static` create

`Optional` relay: IRelay

`Optional` options: ConnectionManagerOptions