library/org.meshtastic.mqtt/WillConfig/Builder

Builder

class Builder

Mutable builder for WillConfig.

Provides setter properties for all will fields plus convenience methods for setting the payload from different types.

Constructors

Builder

constructor()

Properties

contentType

var contentType: String?

MIME content type of the will payload (e.g. "application/json").

correlationData

var correlationData: ByteString?

Correlation data for request/response pattern in the will message.

messageExpiryInterval

var messageExpiryInterval: Long?

Lifetime of the will message in seconds after publication.

payloadBytes

var payloadBytes: ByteString

Payload as an immutable ByteString. Use payload methods for string/ByteArray convenience.

payloadFormatIndicator

var payloadFormatIndicator: Boolean

If true, the will payload is UTF-8 encoded text.

qos

var qos: QoS

QoS level for the will message delivery.

responseTopic

var responseTopic: String?

Topic for request/response pattern in the will message.

retain

var retain: Boolean

If true, the broker retains the will message.

topic

var topic: String

Topic the will message will be published to. Must not be blank.

userProperties

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

Application-defined key-value pairs sent with the will message.

willDelayInterval

var willDelayInterval: Long?

Delay in seconds before publishing the will after unexpected disconnect.

Functions

build

fun build(): WillConfig

Build the immutable WillConfig from the current builder state.

payload

fun payload(bytes: ByteArray)

Set the payload from raw bytes (copied into an immutable ByteString).

fun payload(text: String)

Set the payload from a UTF-8 string.

fun payload(byteString: ByteString)

Set the payload from an immutable ByteString.

Builder

See also

Constructors

Properties

Functions