MqttWireMessage

java.lang.Object
- org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage

Direct Known Subclasses:

MqttAck, MqttConnect, MqttDisconnect, MqttPersistableWireMessage, MqttPingReq, MqttSubscribe, MqttUnsubscribe
```
public abstract class MqttWireMessage
extends java.lang.Object
```
An on-the-wire representation of an MQTT message.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`MESSAGE_TYPE_CONNACK`
`static byte`	`MESSAGE_TYPE_CONNECT`
`static byte`	`MESSAGE_TYPE_DISCONNECT`
`static byte`	`MESSAGE_TYPE_PINGREQ`
`static byte`	`MESSAGE_TYPE_PINGRESP`
`static byte`	`MESSAGE_TYPE_PUBACK`
`static byte`	`MESSAGE_TYPE_PUBCOMP`
`static byte`	`MESSAGE_TYPE_PUBLISH`
`static byte`	`MESSAGE_TYPE_PUBREC`
`static byte`	`MESSAGE_TYPE_PUBREL`
`static byte`	`MESSAGE_TYPE_SUBACK`
`static byte`	`MESSAGE_TYPE_SUBSCRIBE`
`static byte`	`MESSAGE_TYPE_UNSUBACK`
`static byte`	`MESSAGE_TYPE_UNSUBSCRIBE`

Constructor Summary

Constructors
Constructor and Description

MqttWireMessage(byte type)

Constructors
Constructor and Description
`MqttWireMessage(byte type)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MqttWireMessage`	`createWireMessage(byte[] bytes)`
`static MqttWireMessage`	`createWireMessage(MqttPersistable data)`
`byte[]`	`getHeader()`
`java.lang.String`	`getKey()` Returns a key associated with the message.
`int`	`getMessageId()` Returns the MQTT message ID.
`byte[]`	`getPayload()` Sub-classes should override this method to supply the payload bytes.
`byte`	`getType()` Returns the type of the message.
`boolean`	`isMessageIdRequired()` Returns whether or not this message needs to include a message ID.
`boolean`	`isRetryable()`
`void`	`setDuplicate(boolean duplicate)`
`void`	`setMessageId(int msgId)` Sets the MQTT message ID.
`java.lang.String`	`toString()`

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

- Field Detail
  - MESSAGE_TYPE_CONNECT
```
public static final byte MESSAGE_TYPE_CONNECT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_CONNACK
```
public static final byte MESSAGE_TYPE_CONNACK
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PUBLISH
```
public static final byte MESSAGE_TYPE_PUBLISH
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PUBACK
```
public static final byte MESSAGE_TYPE_PUBACK
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PUBREC
```
public static final byte MESSAGE_TYPE_PUBREC
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PUBREL
```
public static final byte MESSAGE_TYPE_PUBREL
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PUBCOMP
```
public static final byte MESSAGE_TYPE_PUBCOMP
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_SUBSCRIBE
```
public static final byte MESSAGE_TYPE_SUBSCRIBE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_SUBACK
```
public static final byte MESSAGE_TYPE_SUBACK
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_UNSUBSCRIBE
```
public static final byte MESSAGE_TYPE_UNSUBSCRIBE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_UNSUBACK
```
public static final byte MESSAGE_TYPE_UNSUBACK
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PINGREQ
```
public static final byte MESSAGE_TYPE_PINGREQ
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_PINGRESP
```
public static final byte MESSAGE_TYPE_PINGRESP
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TYPE_DISCONNECT
```
public static final byte MESSAGE_TYPE_DISCONNECT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MqttWireMessage
```
public MqttWireMessage(byte type)
```
- Method Detail
  - getPayload
```
public byte[] getPayload()
                  throws MqttException
```
    Sub-classes should override this method to supply the payload bytes.
    
    Throws:
    
    MqttException
  - getType
```
public byte getType()
```
    Returns the type of the message.
  - getMessageId
```
public int getMessageId()
```
    Returns the MQTT message ID.
  - setMessageId
```
public void setMessageId(int msgId)
```
    Sets the MQTT message ID.
  - getKey
```
public java.lang.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
    
    Returns:
    
    key a key associated with the message
  - getHeader
```
public byte[] getHeader()
                 throws MqttException
```
    Throws:
    
    MqttException
  - isMessageIdRequired
```
public boolean isMessageIdRequired()
```
    Returns whether or not this message needs to include a message ID.
  - createWireMessage
```
public static MqttWireMessage createWireMessage(MqttPersistable data)
                                         throws MqttException
```
    Throws:
    
    MqttException
  - createWireMessage
```
public static MqttWireMessage createWireMessage(byte[] bytes)
                                         throws MqttException
```
    Throws:
    
    MqttException
  - isRetryable
```
public boolean isRetryable()
```
  - setDuplicate
```
public void setDuplicate(boolean duplicate)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MqttWireMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE_CONNECT

MESSAGE_TYPE_CONNACK

MESSAGE_TYPE_PUBLISH

MESSAGE_TYPE_PUBACK

MESSAGE_TYPE_PUBREC

MESSAGE_TYPE_PUBREL

MESSAGE_TYPE_PUBCOMP

MESSAGE_TYPE_SUBSCRIBE

MESSAGE_TYPE_SUBACK

MESSAGE_TYPE_UNSUBSCRIBE

MESSAGE_TYPE_UNSUBACK

MESSAGE_TYPE_PINGREQ

MESSAGE_TYPE_PINGRESP

MESSAGE_TYPE_DISCONNECT

Constructor Detail

MqttWireMessage

Method Detail

getPayload

getType

getMessageId

setMessageId

getKey

getHeader

isMessageIdRequired

createWireMessage

createWireMessage

isRetryable

setDuplicate

toString