library/org.meshtastic.mqtt/RetainHandling

RetainHandling

enum RetainHandling : Enum<RetainHandling>

Controls when the broker sends retained messages for a subscription (§3.8.3.1).

When subscribing to a topic that has a retained message, this option controls whether and when that retained message is delivered to the subscribing client.

Entries

SEND_AT_SUBSCRIBE

Send retained messages at the time of the subscribe (default).

SEND_IF_NEW_SUBSCRIPTION

Send retained messages only if the subscription does not already exist.

DO_NOT_SEND

Do not send retained messages at the time of the subscribe.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<RetainHandling>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

value

val value: Int

The numeric option value (0, 1, or 2) as encoded in the SUBSCRIBE packet.

Functions

valueOf

fun valueOf(value: String): RetainHandling

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<RetainHandling>

Returns an array containing the constants of this enum type, in the order they're declared.