libp2p-tcp 0.15.3 | Documentation

libp2p-tcp

0.15.3

TCP ▸
- Instance members
- #dial
- #createListener
- #filter

Need help reading this?

TCP

src/index.js

new TCP()

Instance Members

▸ dial(ma, options)

src/index.js

dial(ma: Multiaddr, options: object): Connection

Parameters

ma (Multiaddr)

options (object)

Name	Description
options.signal `AbortSignal`	Used to abort dial requests

Returns

Connection: An upgraded Connection

▸ createListener(options?, handler)

src/index.js

Creates a TCP listener. The provided handler function will be called anytime a new incoming Connection has been successfully upgraded via upgrader.upgradeInbound.

createListener(options: any?, handler: function (Connection)): Listener

Parameters

options (any?)

handler (function (Connection))

Returns

Listener: A TCP listener

▸ filter(multiaddrs)

src/index.js

Takes a list of Multiaddrs and returns only valid TCP addresses

filter(multiaddrs: Array<Multiaddr>): Array<Multiaddr>

Parameters

multiaddrs (Array<Multiaddr>)

Returns

Array<Multiaddr>: Valid TCP multiaddrs