Class PassThroughUpgrader

Implements

Upgrader

Index

Constructors

Methods

createInboundAbortSignal getConnectionEncrypters getStreamMuxers upgradeInbound upgradeOutbound

Constructors

constructor

new PassThroughUpgrader(handler?: OnConnection): PassThroughUpgrader
Parameters
- Optionalhandler: OnConnection
Returns PassThroughUpgrader
- Defined in upgrader.ts:11

Methods

createInboundAbortSignal

createInboundAbortSignal(signal: AbortSignal): ClearableSignal
Used by transports that perform part of the upgrade process themselves and do some async work. This allows configuring inbound upgrade timeouts from a single location.

Regular transports should just pass the signal from their shutdown controller to upgradeInbound.
Parameters
- signal: AbortSignal
Returns ClearableSignal
Implementation of Upgrader.createInboundAbortSignal
- Defined in upgrader.ts:24

getConnectionEncrypters

getConnectionEncrypters(): Map<string, ConnectionEncrypter<unknown>>
Returns configured connection encrypters

Returns Map<string, ConnectionEncrypter<unknown>>
Implementation of Upgrader.getConnectionEncrypters
- Defined in upgrader.ts:32

getStreamMuxers

getStreamMuxers(): Map<string, StreamMuxerFactory>
Returns configured stream muxers

Returns Map<string, StreamMuxerFactory>
Implementation of Upgrader.getStreamMuxers
- Defined in upgrader.ts:28

upgradeInbound

upgradeInbound(maConn: MultiaddrConnection): Promise<void>
Upgrades an inbound connection received by a transport listener and notifies other libp2p components about the new connection
Parameters
- maConn: MultiaddrConnection
Returns Promise<void>
Implementation of Upgrader.upgradeInbound
- Defined in upgrader.ts:15

upgradeOutbound

upgradeOutbound(maConn: MultiaddrConnection): Promise<Connection>
Upgrades an outbound connection created by the dial method of a transport
Parameters
- maConn: MultiaddrConnection
Returns Promise<Connection>
Implementation of Upgrader.upgradeOutbound
- Defined in upgrader.ts:19