Interface TransportManager

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>>
Returns void
- Defined in packages/interface-internal/src/transport-manager/index.ts:13

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
- Optional options: TransportManagerDialOptions
Returns Promise<Connection>
- Defined in packages/interface-internal/src/transport-manager/index.ts:21

dialTransportForMultiaddr

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

getAddrs

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

Returns Multiaddr[]
- Defined in packages/interface-internal/src/transport-manager/index.ts:26

getListeners

getListeners(): Listener[]
Return all listeners

Returns Listener[]
- Defined in packages/interface-internal/src/transport-manager/index.ts:36

getTransports

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

Returns Transport<ProgressEvent<any, unknown>>[]
- Defined in packages/interface-internal/src/transport-manager/index.ts:31

listen

listen(addrs): Promise<void>
Listen on the passed multiaddrs
Parameters
- addrs: Multiaddr[]
Returns Promise<void>
- Defined in packages/interface-internal/src/transport-manager/index.ts:52

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
Returns undefined | Transport<ProgressEvent<any, unknown>>
- Defined in packages/interface-internal/src/transport-manager/index.ts:47

remove

remove(key): Promise<void>
Remove a previously configured transport
Parameters
- key: string
Returns Promise<void>
- Defined in packages/interface-internal/src/transport-manager/index.ts:57

removeAll

removeAll(): Promise<void>
Remove all transports

Returns Promise<void>
- Defined in packages/interface-internal/src/transport-manager/index.ts:62