MqttOptionsType

Defined in: src/io/broker/MqttOptions.ts:39

Plain options-object shape accepted by an MqttActor.

Extends

• BrokerCommonOptionsType

Properties

brokerUrl?

readonly optional brokerUrl?: string

Defined in: src/io/broker/MqttOptions.ts:41

Broker URL — mqtt://, mqtts://, ws://, wss://.

---

circuitBreaker?

readonly optional circuitBreaker?: object

Defined in: src/io/broker/BrokerOptions.ts:48

Optional circuit-breaker around connectImplementation. After failureThreshold consecutive failed connect attempts the breaker opens for resetMs and rejects new attempts immediately.

failureThreshold

readonly failureThreshold: number

resetMs

readonly resetMs: number

Inherited from

BrokerCommonOptionsType.circuitBreaker

---

cleanSession?

readonly optional cleanSession?: boolean

Defined in: src/io/broker/MqttOptions.ts:50

Clean-session flag. Default true.

---

clientId?

readonly optional clientId?: string

Defined in: src/io/broker/MqttOptions.ts:43

Stable client id. When omitted the broker assigns one.

---

codec?

readonly optional codec?: MqttCodec<unknown>

Defined in: src/io/broker/MqttOptions.ts:65

Payload codec used by MqttPayload.entity (inbound decode) and by publish when handed a non-string/non-Uint8Array entity. Default: mqttJsonCodec. One codec per actor.

---

credentials?

readonly optional credentials?: MqttCredentials

Defined in: src/io/broker/MqttOptions.ts:44

---

keepAlive?

readonly optional keepAlive?: number

Defined in: src/io/broker/MqttOptions.ts:52

Keep-alive interval in seconds. Default 60.

---

outboundBuffer?

readonly optional outboundBuffer?: number

Defined in: src/io/broker/BrokerOptions.ts:61

Maximum number of outbound messages buffered while the connection is connecting or disconnected. When the buffer is full the oldest message is dropped (FIFO eviction) and a BrokerBufferOverflow event is published. Default: 1000. Set to 0 to fail-fast (publish a BrokerNotConnected event and drop the message).

Inherited from

BrokerCommonOptionsType.outboundBuffer

---

protocolVersion?

readonly optional protocolVersion?: 4 | 5

Defined in: src/io/broker/MqttOptions.ts:59

MQTT protocol version negotiated with the broker. Default 4 (MQTT 3.1.1); set to 5 to opt in to MQTT 5.0 features (user properties + reason codes — see MqttPublish.userProperties

• MqttMessage.reasonCode).

---

qos?

readonly optional qos?: MqttQos

Defined in: src/io/broker/MqttOptions.ts:46

Default QoS used by publish / subscribe when not overridden per call.

---

reconnect?

readonly optional reconnect?: false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

Defined in: src/io/broker/BrokerOptions.ts:35

Reconnect strategy applied when the underlying connection drops or connectImplementation throws. Default: exponential backoff starting at 200ms, doubling, capped at 30s, infinite attempts. Set to false to disable auto-reconnect (one-shot connections).

Union Members

false

---

Type Literal

{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

factor?

readonly optional factor?: number

initialDelayMs?

readonly optional initialDelayMs?: number

maxAttempts?

readonly optional maxAttempts?: number

Cap on retry attempts. Default: Infinity (retry forever).

maxDelayMs?

readonly optional maxDelayMs?: number

Inherited from

BrokerCommonOptionsType.reconnect

---

will?

readonly optional will?: object

Defined in: src/io/broker/MqttOptions.ts:48

Last-will-and-testament published by the broker if the actor disconnects ungracefully.

payload

readonly payload: string | Uint8Array<ArrayBufferLike>

qos?

readonly optional qos?: MqttQos

retain?

readonly optional retain?: boolean

topic

readonly topic: string