library/org.meshtastic.mqtt/ProbeServerInfo

ProbeServerInfo

data class ProbeServerInfo(val assignedClientIdentifier: String? = null, val serverKeepAliveSeconds: Int? = null, val maximumQosOrdinal: Int? = null, val retainAvailable: Boolean? = null, val wildcardSubscriptionAvailable: Boolean? = null, val sharedSubscriptionAvailable: Boolean? = null, val subscriptionIdentifiersAvailable: Boolean? = null, val maximumPacketSize: Long? = null, val receiveMaximum: Int? = null, val topicAliasMaximum: Int? = null, val serverReference: String? = null, val responseInformation: String? = null)

Curated, public-API subset of the broker capabilities advertised in CONNACK properties (§3.2.2.3), surfaced via ProbeResult.Success. Mirrors the internal MqttProperties shape but exposes only fields that are actionable for a probe diagnostic UI.

Constructors

ProbeServerInfo

constructor(assignedClientIdentifier: String? = null, serverKeepAliveSeconds: Int? = null, maximumQosOrdinal: Int? = null, retainAvailable: Boolean? = null, wildcardSubscriptionAvailable: Boolean? = null, sharedSubscriptionAvailable: Boolean? = null, subscriptionIdentifiersAvailable: Boolean? = null, maximumPacketSize: Long? = null, receiveMaximum: Int? = null, topicAliasMaximum: Int? = null, serverReference: String? = null, responseInformation: String? = null)

Properties

assignedClientIdentifier

val assignedClientIdentifier: String?

Client identifier assigned by the broker when the probe sent clientId = "". Useful for confirming the broker accepts anonymous identifiers.

maximumPacketSize

val maximumPacketSize: Long?

Largest PUBLISH payload the broker will accept, or null.

maximumQosOrdinal

val maximumQosOrdinal: Int?

Maximum QoS the broker will deliver (0, 1, or 2). null means the broker did not include the property and supports up to QoS 2.

receiveMaximum

val receiveMaximum: Int?

Maximum number of in-flight QoS 1/2 publishes the broker will accept from the client at once.

responseInformation

val responseInformation: String?

Optional response-information topic prefix (§3.1.2.11.6).

retainAvailable

val retainAvailable: Boolean?

true (or null) when the broker honors RETAIN=1 PUBLISH packets; false if retained messages are disabled.

serverKeepAliveSeconds

val serverKeepAliveSeconds: Int?

Keepalive interval the broker overrode (§3.2.2.3.14), or null if the broker accepted the requested keepalive.

serverReference

val serverReference: String?

Optional server-reference hint included even on success for some brokers (§4.13).

sharedSubscriptionAvailable

val sharedSubscriptionAvailable: Boolean?

true (or null) when shared subscriptions (§4.8.2) are supported.

subscriptionIdentifiersAvailable

val subscriptionIdentifiersAvailable: Boolean?

true (or null) when subscription identifiers (§3.8.2.1.2) are supported.

topicAliasMaximum

val topicAliasMaximum: Int?

Maximum topic alias the client may use (§3.3.2.3.4).

wildcardSubscriptionAvailable

val wildcardSubscriptionAvailable: Boolean?

true (or null) when wildcard topic filters (+, #) are supported.