Class KeepAliveManager

Hierarchy

KeepAliveManager

Index

Constructors

Properties

options pingKeepAliveTimers relay? relayKeepAliveTimers

Methods

start stop stopAll

Constructors

constructor

new KeepAliveManager(options: KeepAliveOptions, relay?: IRelay): KeepAliveManager
Parameters
- options: KeepAliveOptions
- Optional relay: IRelay
Returns KeepAliveManager
- Defined in packages/core/src/lib/keep_alive_manager.ts:22

Properties

`Private` options

options: KeepAliveOptions

`Private` pingKeepAliveTimers

pingKeepAliveTimers: Map<string, Timer>

`Private` `Optional` relay

relay?: IRelay

`Private` relayKeepAliveTimers

relayKeepAliveTimers: Map<PeerId, Timer>

Methods

start

start(peerId: PeerId, libp2pPing: ((peer: PeerId | Multiaddr, options?: AbortOptions) => Promise<number>)): void
Parameters
- peerId: PeerId
- libp2pPing: ((peer: PeerId | Multiaddr, options?: AbortOptions) => Promise<number>)
  - - (peer: PeerId | Multiaddr, options?: AbortOptions): Promise<number>
    - Pings the given peer in order to obtain the operation latency
      
      Example
      const latency = await libp2p.ping(otherPeerId)
      
      Parameters
      
      peer: PeerId | Multiaddr
      
      Optional options: AbortOptions
      
      Returns Promise<number>
Returns void
- Defined in packages/core/src/lib/keep_alive_manager.ts:29

stop

stop(peerId: PeerId): void
Parameters
- peerId: PeerId
Returns void
- Defined in packages/core/src/lib/keep_alive_manager.ts:63

stopAll

stopAll(): void
Returns void
- Defined in packages/core/src/lib/keep_alive_manager.ts:77

Generated using TypeDoc