MqttVariableHeader class

Represents the base class for the Variable Header portion of some MQTT Messages.

Implementers

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
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
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.
read / write
length int
The length, in bytes, consumed by the variable header.
read / write
messageIdentifier int
Message identifier
read / write
protocolName String
Protocol name
read / write
protocolVersion int
Protocol version
read / write
returnCode MqttConnectReturnCode
Return code
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
topicName String
Topic name
read / write

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 non-existent 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
Returns 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 ==(dynamic other) bool
The equality operator. [...]
inherited