Interface Transport

A libp2p transport is understood as something that offers a dial and listen interface to establish connections.

Hierarchy

Transport

Index

Properties

[symbol] [toStringTag] createListener dial filter

Properties

[symbol]

[symbol]: true

Used by the isTransport function

[toStringTag]

[toStringTag]: string

Used to identify the transport

createListener

createListener: ((options: CreateListenerOptions) => Listener)

Type declaration

- (options: CreateListenerOptions): Listener
- Create transport listeners.
  Parameters
  - options: CreateListenerOptions
  Returns Listener

dial

dial: ((ma: Multiaddr, options: DialOptions) => Promise<Connection>)

Type declaration

- (ma: Multiaddr, options: DialOptions): Promise<Connection>
- Dial a given multiaddr.
  Parameters
  - ma: Multiaddr
  - options: DialOptions
  Returns Promise<Connection>

filter

filter: MultiaddrFilter

Takes a list of Multiaddrs and returns only valid addresses for the transport