Interface TransportManager

The TransportManager handles the management of network transports, allowing opening connections or listening using specific transports, etc.

This is a low-level component - any connections opened will not be managed by the ConnectionManager or included in any configured connection limits, etc.

Most consumers will call openConnection on the ConnectionManager instead.

interface TransportManager {
    add(transport): void;
    dial(ma, options?): Promise<Connection>;
    dialTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
    getAddrs(): Multiaddr[];
    getListeners(): Listener[];
    getTransports(): Transport<ProgressEvent<any, unknown>>[];
    listen(addrs): Promise<void>;
    listenTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
    remove(key): Promise<void>;
    removeAll(): Promise<void>;
}

Index

Methods

add dial dialTransportForMultiaddr getAddrs getListeners getTransports listen listenTransportForMultiaddr remove removeAll

Methods

add

add(transport): void
Add a transport to the transport manager.
Parameters
- transport: Transport<ProgressEvent<any, unknown>>
  The transport instance to be added.
Returns void
- Defined in packages/interface-internal/src/transport-manager.ts:27

dial

dial(ma, options?): Promise<Connection>
Dial a multiaddr. Connections returned by this method will not be tracked by the connection manager so can cause memory leaks. If you need to dial a multiaddr, you may want to call openConnection on the connection manager instead.
Parameters
- ma: Multiaddr
  The multiaddr to dial.
- Optional options: TransportManagerDialOptions
  Optional dial options.
Returns Promise<Connection>
A promise that resolves to a Connection object.
- Defined in packages/interface-internal/src/transport-manager.ts:39

dialTransportForMultiaddr

dialTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>
Get the transport to dial a given multiaddr, if one has been configured
Parameters
- ma: Multiaddr
  The target multiaddr.
Returns undefined | Transport<ProgressEvent<any, unknown>>
A Transport instance if available, otherwise undefined.
- Defined in packages/interface-internal/src/transport-manager.ts:68

getAddrs

getAddrs(): Multiaddr[]
Return all addresses currently being listened on

Returns Multiaddr[]
An array of Multiaddr objects.
- Defined in packages/interface-internal/src/transport-manager.ts:46

getListeners

getListeners(): Listener[]
Return all listeners

Returns Listener[]
An array of Listener instances.
- Defined in packages/interface-internal/src/transport-manager.ts:60

getTransports

getTransports(): Transport<ProgressEvent<any, unknown>>[]
Return all registered transports

Returns Transport<ProgressEvent<any, unknown>>[]
An array of Transport instances.
- Defined in packages/interface-internal/src/transport-manager.ts:53

listen

listen(addrs): Promise<void>
Listen on the passed multiaddrs
Parameters
- addrs: Multiaddr[]
  An array of multiaddrs to listen on.
Returns Promise<void>
A promise that resolves once the transport is actively listening.
- Defined in packages/interface-internal/src/transport-manager.ts:85

listenTransportForMultiaddr

listenTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>
Get the transport to listen on a given multiaddr, if one has been configured
Parameters
- ma: Multiaddr
  The target multiaddr.
Returns undefined | Transport<ProgressEvent<any, unknown>>
A Transport instance if available, otherwise undefined.
- Defined in packages/interface-internal/src/transport-manager.ts:77

remove

remove(key): Promise<void>
Remove a previously configured transport
Parameters
- key: string
  The transport key or identifier.
Returns Promise<void>
A promise that resolves once the transport is removed.
- Defined in packages/interface-internal/src/transport-manager.ts:93

removeAll

removeAll(): Promise<void>
Remove all transports

Returns Promise<void>
A promise that resolves once all transports are removed.
- Defined in packages/interface-internal/src/transport-manager.ts:100

Interface TransportManager

Index

Methods

Methods

add

Parameters

Returns void

dial

Parameters

Returns Promise<Connection>

dialTransportForMultiaddr

Parameters

Returns undefined | Transport<ProgressEvent<any, unknown>>

getAddrs

Returns Multiaddr[]

getListeners

Returns Listener[]

getTransports

Returns Transport<ProgressEvent<any, unknown>>[]

listen

Parameters

Returns Promise<void>

listenTransportForMultiaddr

Parameters

Returns undefined | Transport<ProgressEvent<any, unknown>>

remove

Parameters

Returns Promise<void>

removeAll

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page