MqttVariableHeader class
Represents the base class for the Variable Header portion of some MQTT Messages.
- Implementers
- MqttConnectAckVariableHeader
- MqttConnectVariableHeader
- MqttPublishAckVariableHeader
- MqttPublishCompleteVariableHeader
- MqttPublishReceivedVariableHeader
- MqttPublishReleaseVariableHeader
- MqttPublishVariableHeader
- MqttSubscribeAckVariableHeader
- MqttSubscribeVariableHeader
- MqttUnsubscribeAckVariableHeader
- MqttUnsubscribeVariableHeader
Constructors
- MqttVariableHeader()
- Initializes a new instance of the MqttVariableHeader class.
- MqttVariableHeader.fromByteBuffer(MqttByteBuffer headerStream)
- Initializes a new instance of the MqttVariableHeader class, populating it with data from a stream.
Properties
- connectFlags ↔ MqttConnectFlags
-
Conenct flags
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- keepAlive ↔ int
-
Defines the maximum allowable lag, in seconds, between expected messages.
The spec indicates that clients won't be disconnected until KeepAlive + 1/2 KeepAlive time period
elapses.
getter/setter pair
- length ↔ int
-
The length, in bytes, consumed by the variable header.
getter/setter pair
- messageIdentifier ↔ int?
-
Message identifier
getter/setter pair
- protocolName ↔ String
-
Protocol name
getter/setter pair
- protocolVersion ↔ int
-
Protocol version
getter/setter pair
- returnCode ↔ MqttConnectReturnCode
-
Return code
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- topicName ↔ String
-
Topic name
getter/setter pair
Methods
-
getWriteLength(
) → int - Gets the length of the write data when WriteTo will be called. A subclass that overrides writeTo must also overwrite this method.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readConnectFlags(
MqttByteBuffer stream) → void - Connect flags
-
readFrom(
MqttByteBuffer variableHeaderStream) → void - Creates a variable header from the specified header stream. A subclass can override this method to do completely custom read operations if required.
-
readKeepAlive(
MqttByteBuffer stream) → void - Keep alive
-
readMessageIdentifier(
MqttByteBuffer stream) → void - Message identifier
-
readProtocolName(
MqttByteBuffer stream) → void - Read functions Protocol name
-
readProtocolVersion(
MqttByteBuffer stream) → void - Protocol version
-
readReturnCode(
MqttByteBuffer stream) → void - Return code
-
readTopicName(
MqttByteBuffer stream) → void - Topic name
-
toString(
) → String -
A string representation of this object.
inherited
-
writeConnectFlags(
MqttByteBuffer stream) → void - Connect flags
-
writeKeepAlive(
MqttByteBuffer stream) → void - Keep alive
-
writeMessageIdentifier(
MqttByteBuffer stream) → void - Message identifier
-
writeProtocolName(
MqttByteBuffer stream) → void - Write functions Protocol name
-
writeProtocolVersion(
MqttByteBuffer stream) → void - Protocol version
-
writeReturnCode(
MqttByteBuffer stream) → void - Return code
-
writeTo(
MqttByteBuffer variableHeaderStream) → void - Writes the variable header to the supplied stream. A subclass can override this method to do completely custom write operations if required.
-
writeTopicName(
MqttByteBuffer stream) → void - Topic name
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited