UDPClusterManagerOptions interface

Pass any subset to the constructor; unspecified values come from DEFAULT_UDP_CLUSTER_MANAGER_OPTIONS.

Signature:

export interface UDPClusterManagerOptions

Remarks

All the broadcast-related values — address, port, limitedAddress, aliveTimeoutCorrection and useAliveCheck — together identify the shared broadcast worker, so two managers agreeing on all of them share one socket and one worker thread. logger and handleSignals are not part of that identity.

Properties

Property	Type	Description
address	string	Broadcast address the cluster announces on.
aliveTimeoutCorrection	number	Grace period in milliseconds added to the liveness timeout each server advertises in its broadcast.
handleSignals	boolean	Enable process signal handling (SIGTERM, SIGINT, SIGABRT) by the manager. When enabled, the manager stops its UDP workers on these signals and then re-raises the signal, so the process terminates through the default signal behavior. Disable if the host application manages its own shutdown sequence.
limitedAddress?	string	(Optional) Limited-broadcast address marker. No default: when unset, the worker tries to bind the local interface matching UDPClusterManagerOptions.address.
logger	ILogger	Logger used for worker supervision messages
port	number	UDP port the manager listens on for cluster announcements.
useAliveCheck	boolean	Whether announced servers are expired when they stop broadcasting.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.