Skip to content

UdpBindLockConfig

UdpBindLockConfig = object

Defined in: packages/app-system/src/async/udp-bind-lock.ts:5

optional udpBindAddress?: string | null

Defined in: packages/app-system/src/async/udp-bind-lock.ts:24

The address to bind the UDP socket to. Default is “localhost”

Example: “localhost” or “127.1.2.3” (in which case udpSocketType should be “udp4”) or “::1” (in which case udpSocketType should be “udp6”).

Note: Using “localhost” is generally safe as it resolves to both IPv4 and IPv6 loopback addresses, but if you want to be certain about the IP version, specify the address explicitly.


udpBindPort: number

Defined in: packages/app-system/src/async/udp-bind-lock.ts:31

The port to bind the UDP socket to.

Should be a port that is unlikely to be used by other applications.


udpSocketType: "udp4" | "udp6"

Defined in: packages/app-system/src/async/udp-bind-lock.ts:12

The type of UDP socket to create, either “udp4” for IPv4 or “udp6” for IPv6.

It should match the IP version of the udpBindAddress.