Interface Upgrader

interface Upgrader {
    createInboundAbortSignal(signal): ClearableSignal;
    getConnectionEncrypters(): Map<string, ConnectionEncrypter<unknown>>;
    getStreamMuxers(): Map<string, StreamMuxerFactory>;
    upgradeInbound(maConn, opts?): Promise<void>;
    upgradeOutbound(maConn, opts?): Promise<Connection>;
}

Index

Methods

createInboundAbortSignal getConnectionEncrypters getStreamMuxers upgradeInbound upgradeOutbound

Methods

createInboundAbortSignal

createInboundAbortSignal(signal): 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
- Defined in packages/interface/src/transport.ts:161

getConnectionEncrypters

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

Returns Map<string, ConnectionEncrypter<unknown>>
- Defined in packages/interface/src/transport.ts:171

getStreamMuxers

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

Returns Map<string, StreamMuxerFactory>
- Defined in packages/interface/src/transport.ts:166

upgradeInbound

upgradeInbound(maConn, opts?): Promise<void>
Upgrades an inbound connection received by a transport listener and notifies other libp2p components about the new connection
Parameters
- maConn: MultiaddrConnection
- Optional opts: UpgraderOptions<InboundConnectionUpgradeEvents>
Returns Promise<void>
- Defined in packages/interface/src/transport.ts:151

upgradeOutbound

upgradeOutbound(maConn, opts?): Promise<Connection>
Upgrades an outbound connection created by the dial method of a transport
Parameters
- maConn: MultiaddrConnection
- Optional opts: UpgraderOptions<OutboundConnectionUpgradeEvents>
Returns Promise<Connection>
- Defined in packages/interface/src/transport.ts:145