Class LocalDiscovery

Hierarchy

TypedEmitter
- LocalDiscovery

Index

Constructors

Methods

connectPeer start stop

Constructors

constructor

new LocalDiscovery(opts): LocalDiscovery
Parameters
- opts: {
  identityKeypair: Keypair;
  logger: undefined | Logger;
  }
  - identityKeypair: Keypair
  - logger: undefined | Logger
Returns LocalDiscovery
Overrides TypedEmitter.constructor

Methods

connectPeer

connectPeer(peer): void
Parameters
- peer: {
      address: string;
      name: string;
      port: number;
  }
  - address: string
  - name: string
  - port: number
Returns void

start

start(): Promise<{
name: string;
port: number;
}>
Returns Promise<{
name: string;
port: number;
}>

stop

stop(opts?): Promise<void>
Close all servers and stop multicast advertising and browsing. Will wait for open sockets to close unless opts.force=true in which case open sockets are force-closed after opts.timeout milliseconds
Parameters
- Optionalopts: {
  force: undefined | boolean;
  timeout: undefined | number;
  }
  - force: undefined | boolean
    Force-close open sockets after timeout milliseconds
  - timeout: undefined | number
    Optional timeout when calling stop() with force=true
Returns Promise<void>