Interface TCPPeerDiscovery

Discovery for addresses of TCP peers.

Hierarchy

TCPPeerDiscovery

Implemented by

TCPPeerMDNSDiscovery

Index

Methods

Methods

Optional newDiscovery

newDiscovery(details: TCPDiscoveryDetails): undefined | ServiceDiscovery<MultiAddressService>

- Defined in packages/tcp/src/TCPPeerDiscovery.ts:52
Create a discovery that will return peers to connect to.

Parameters
- details: TCPDiscoveryDetails
  - details to use when finding peers
Returns undefined | ServiceDiscovery<MultiAddressService>
instance of ServiceDiscovery or undefined if no discovery was started

Optional publish

publish(details: TCPServerDetails): undefined | ServicePublisher

- Defined in packages/tcp/src/TCPPeerDiscovery.ts:64
Optional function used to publish information about the TCP transport so a discovery can see it.

Parameters
- details: TCPServerDetails
  - details to publish
Returns undefined | ServicePublisher
instance of ServicePublisher or undefined if service was not published

Generated using TypeDoc