library/org.meshtastic.mqtt/MqttConfig/Builder

Builder

Mutable builder for MqttConfig.

All properties default to the same values as the MqttConfig data class constructor. Set only the properties you want to customize.

Constructors

constructor()

Properties

authenticationData

var authenticationData: ByteString?

Initial authentication data for enhanced auth (§3.1.2.11.10).

authenticationMethod

var authenticationMethod: String?

Authentication method for enhanced authentication (§4.12).

var autoReconnect: Boolean

If true, automatically reconnect with exponential backoff on connection loss.

var cleanStart: Boolean

If true, the broker discards any existing session state (§3.1.2.4).

var clientId: String

Client identifier sent to the broker. Empty requests broker-assigned ID.

var defaultQos: QoS

Default QoS level for convenience MqttClient.publish calls.

var defaultRetain: Boolean

Default retain flag for convenience MqttClient.publish calls.

keepAliveSeconds

var keepAliveSeconds: Int

Maximum interval in seconds between control packets (§3.1.2.10). Range: 0..65,535.

var logger: MqttLogger?

Optional MqttLogger for receiving library log output.

var logLevel: MqttLogLevel

Minimum log level for messages delivered to logger.

maximumPacketSize

var maximumPacketSize: Long?

Maximum MQTT packet size in bytes the client accepts (§3.1.2.11.5).

maxReconnectAttempts

var maxReconnectAttempts: Int

Maximum consecutive reconnect attempts. 0 = unlimited.

negotiateVersion

var negotiateVersion: Boolean

If true (default) and protocolVersion is MqttProtocolVersion.V5_0, the client automatically falls back to MQTT 3.1.1 when the broker rejects the 5.0 CONNECT with UNSUPPORTED_PROTOCOL_VERSION. The negotiated version is remembered for reconnects. Set to false to require the exact protocolVersion without fallback.

var password: ByteString?

Optional password as an immutable ByteString (§3.1.3.6).

protocolVersion

var protocolVersion: MqttProtocolVersion

MQTT protocol version for this connection. Defaults to MQTT 5.0.

var receiveMaximum: Int

Maximum concurrent in-flight QoS 1/2 messages. Range: 1..65,535 (§3.1.2.11.4).

reconnectBaseDelayMs

var reconnectBaseDelayMs: Long

Initial delay in milliseconds between reconnection attempts. Must be > 0.

reconnectMaxDelayMs

var reconnectMaxDelayMs: Long

Maximum delay in milliseconds between reconnection attempts.

requestProblemInformation

var requestProblemInformation: Boolean

If true, allows Reason String and User Properties on failure packets (§3.1.2.11.8).

requestResponseInformation

var requestResponseInformation: Boolean

If true, requests Response Information in CONNACK (§3.1.2.11.7).

sessionExpiryInterval

var sessionExpiryInterval: Long?

Session state retention duration in seconds after disconnect (§3.1.2.11.3).

topicAliasMaximum

var topicAliasMaximum: Int

Maximum topic aliases the client accepts from the broker (§3.1.2.11.6).

useOutboundTopicAliases

var useOutboundTopicAliases: Boolean

If true, use outbound topic aliases when broker advertises support.

var username: String?

Optional username for password-based authentication (§3.1.3.5).

var userProperties: List<Pair<String, String>>

Application-defined key-value pairs sent with the CONNECT packet.

var will: WillConfig?

Optional will message published on unexpected disconnect (§3.1.3.2).

Functions

fun build(): MqttConfig

Build the immutable MqttConfig from the current builder state.

fun password(value: String)

Set the password from a plain String.

fun will(block: WillConfig.Builder.() -> Unit)

Configure a will message using a DSL block.