
public abstract class MqttWireMessage

An on-the-wire representation of an MQTT message.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static byte`	`MESSAGE_TYPE_CONNECT`
`public final static byte`	`MESSAGE_TYPE_CONNACK`
`public final static byte`	`MESSAGE_TYPE_PUBLISH`
`public final static byte`	`MESSAGE_TYPE_PUBACK`
`public final static byte`	`MESSAGE_TYPE_PUBREC`
`public final static byte`	`MESSAGE_TYPE_PUBREL`
`public final static byte`	`MESSAGE_TYPE_PUBCOMP`
`public final static byte`	`MESSAGE_TYPE_SUBSCRIBE`
`public final static byte`	`MESSAGE_TYPE_SUBACK`
`public final static byte`	`MESSAGE_TYPE_UNSUBSCRIBE`
`public final static byte`	`MESSAGE_TYPE_UNSUBACK`
`public final static byte`	`MESSAGE_TYPE_PINGREQ`
`public final static byte`	`MESSAGE_TYPE_PINGRESP`
`public final static byte`	`MESSAGE_TYPE_DISCONNECT`
`private byte`	`type`
`protected boolean`	`duplicate`
`private MqttToken`	`token`

Constructor Summary

Constructors
Constructor	Description
`MqttWireMessage(byte type)`

Method Summary

Modifier and Type	Method	Description
`byte`	`getType()`	Returns the type of the message.
`void`	`setDuplicate(boolean duplicate)`
`MqttToken`	`getToken()`	Get the token associated with the message.
`void`	`setToken(MqttToken token)`	Set the token associated with the message.
`Array<byte>`	`getPayload()`	Sub-classes should override this method to supply the payload bytes.
`int`	`getMessageId()`	Returns the MQTT message ID.
`void`	`setMessageId(int msgId)`	Sets the MQTT message ID.
`String`	`getKey()`	Returns a key associated with the message.
`Array<byte>`	`getHeader()`
`boolean`	`isMessageIdRequired()`	Returns whether or not this message needs to include a message ID.
`static MqttWireMessage`	`createWireMessage(MqttPersistable data, String mqttVersion)`
`static MqttWireMessage`	`createWireMessage(Array<byte> bytes, String mqttVersion)`
`boolean`	`isRetryable()`
`String`	`toString()`
`String`	`packetName()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MqttWireMessage
```
MqttWireMessage(byte type)
```
- Method Detail
  - getType
```
 byte getType()
```
    Returns the type of the message.
  - setDuplicate
```
 void setDuplicate(boolean duplicate)
```
  - getToken
```
 MqttToken getToken()
```
    Get the token associated with the message.
  - setToken
```
 void setToken(MqttToken token)
```
    Set the token associated with the message.
    
    Parameters:
    
    token - the token associated with the message.
  - getPayload
```
 Array<byte> getPayload()
```
    Sub-classes should override this method to supply the payload bytes.
  - getMessageId
```
 int getMessageId()
```
    Returns the MQTT message ID.
  - setMessageId
```
 void setMessageId(int msgId)
```
    Sets the MQTT message ID.
  - getKey
```
 String getKey()
```
    Returns a key associated with the message. For most message types this will be unique. For connect, disconnect and ping only one message of this type is allowed so a fixed key will be returned
  - getHeader
```
 Array<byte> getHeader()
```
  - isMessageIdRequired
```
 boolean isMessageIdRequired()
```
    Returns whether or not this message needs to include a message ID.
  - createWireMessage
```
 static MqttWireMessage createWireMessage(MqttPersistable data, String mqttVersion)
```
  - createWireMessage
```
 static MqttWireMessage createWireMessage(Array<byte> bytes, String mqttVersion)
```
  - isRetryable
```
 boolean isRetryable()
```
  - toString
```
 String toString()
```
  - packetName
```
 String packetName()
```

Class MqttWireMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MqttWireMessage

Method Detail

getType

setDuplicate

getToken

setToken

getPayload

getMessageId

setMessageId

getKey

getHeader

isMessageIdRequired

createWireMessage

createWireMessage

isRetryable

toString

packetName