JSPrismarine

API reference / @jsprismarine/nethernet / LanDiscovery

Class: LanDiscovery ​

Defined in: packages/nethernet/src/LanDiscovery.ts:34

The client half of LAN discovery on UDP 7551: broadcasts requests, collects the servers that answer, and carries signals to one of them, so a NetherNetClient can join over the LAN.

Events: server (DiscoveredServer), signal (SignalStructure from a server).

Extends ​

  • EventEmitter

Constructors ​

Constructor ​

new LanDiscovery(options?): LanDiscovery

Defined in: packages/nethernet/src/LanDiscovery.ts:46

Parameters ​

options? ​

LanDiscoveryOptions = {}

The client's network ID and where to ask.

Returns ​

LanDiscovery

Overrides ​

EventEmitter.constructor

Properties ​

networkId ​

readonly networkId: bigint

Defined in: packages/nethernet/src/LanDiscovery.ts:35

servers ​

readonly servers: Map<bigint, DiscoveredServer>

Defined in: packages/nethernet/src/LanDiscovery.ts:37

Every server that answered, by network ID.

Methods ​

close() ​

close(): void

Defined in: packages/nethernet/src/LanDiscovery.ts:95

Stops asking and closes the socket.

Returns ​

void

request() ​

request(): void

Defined in: packages/nethernet/src/LanDiscovery.ts:70

Asks once.

Returns ​

void

sendSignal() ​

sendSignal(signal): void

Defined in: packages/nethernet/src/LanDiscovery.ts:79

Sends a signal to a server that answered.

Parameters ​

signal ​

SignalStructure

The signal; its network ID names the server.

Returns ​

void

Throws ​

When no server with that ID answered.

start() ​

start(): Promise<void>

Defined in: packages/nethernet/src/LanDiscovery.ts:55

Binds a socket and starts asking every DISCOVERY_INTERVAL_MS.

Returns ​

Promise<void>