# UDPClusterManagerOptions interface · @imqueue/core

Source: https://imqueue.org/api/core/latest/core.udpclustermanageroptions/
Published: 2026-08-04
Author: @imqueue maintainers (https://github.com/imqueue)
Package: @imqueue/core 3.3.2 — generated reference, not hand-written

Configuration for [UDPClusterManager](https://imqueue.org/api/core/latest/core.udpclustermanager/).

Pass any subset to the constructor; unspecified values come from [DEFAULT\_UDP\_CLUSTER\_MANAGER\_OPTIONS](https://imqueue.org/api/core/latest/core.default_udp_cluster_manager_options/).

**Signature:**

```typescript
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 | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [address](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.address/) |  | string | Broadcast address the cluster announces on. |
| [aliveTimeoutCorrection](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.alivetimeoutcorrection/) |  | number | Grace period in milliseconds added to the liveness timeout each server advertises in its broadcast. |
| [handleSignals](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.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?](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.limitedaddress/) |  | string | _(Optional)_ Limited-broadcast address marker. No default: when unset, the worker tries to bind the local interface matching [UDPClusterManagerOptions.address](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.address/). |
| [logger](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.logger/) |  | [ILogger](https://imqueue.org/api/core/latest/core.ilogger/) | Logger used for worker supervision messages |
| [port](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.port/) |  | number | UDP port the manager listens on for cluster announcements. |
| [useAliveCheck](https://imqueue.org/api/core/latest/core.udpclustermanageroptions.usealivecheck/) |  | boolean | Whether announced servers are expired when they stop broadcasting. |