MqttSubscribePayload class
The payload of a subscribe message contains a list of topic filters indicating the topics to which the client wants to subscribe. Each topic filter is followed by a subscription options value.
The payload must contain at least one topic filter and subscription options pair.
- Implemented types
Constructors
- MqttSubscribePayload()
- Initializes a new instance of the MqttSubscribePayload class.
Properties
- count → int
-
Number of topic subscriptions
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- header ↔ MqttHeader?
-
Message header
getter/setter pair
- isValid → bool
-
Check validity, there must be at least one subscription topic before the
subscription message can be sent.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subscriptions
→ List<
MqttSubscribePayloadTopic> -
no setter
- variableHeader ↔ MqttIVariableHeader?
-
Variable header
getter/setter pair
Methods
-
addSubscription(
MqttSubscriptionTopic topic, [MqttSubscriptionOption? option]) → void - Adds a new subscription to the collection of subscriptions.
-
clearSubscriptions(
) → void - Clears the subscriptions.
-
getWriteLength(
) → int -
Gets the length of the payload in bytes when written to a stream.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readFrom(
MqttByteBuffer payloadStream) → void -
Creates a payload from the specified header stream.
Not implemented, the subscribe message is send only.
override
-
toString(
) → String -
A string representation of this object.
override
-
writeTo(
MqttByteBuffer payloadStream) → void -
Writes the payload to the supplied stream.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited