Package de.uniks.networkparser.ext.io

Class MQTTMessage

java.lang.Object

de.uniks.networkparser.ext.io.MQTTMessage

public class MQTTMessage
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected int	code
protected int[]	data
protected boolean	duplicate
protected int	keepAliveInterval
static java.lang.String	KEY_CONNACK
static java.lang.String	KEY_CONNECT
static java.lang.String	KEY_DISCONNECT
static java.lang.String	KEY_PING
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
static int	MQTT_VERSION_3_1_1	Mqtt Version 3.1.1
protected int	msgId
protected java.lang.String[]	names
protected boolean	session

Constructor Summary

Constructors

Constructor	Description
MQTTMessage()

Method Summary

Modifier and Type	Method	Description
static MQTTMessage	create(byte type)
static MQTTMessage	create(byte type, byte info, byte[] variableHeader)
static MQTTMessage	createChannelOpen(java.lang.String topic)
MQTTMessage	createMessage(java.lang.String content)
protected java.lang.String	decodeUTF8(ByteBuffer input)	Decodes a UTF-8 string
protected static void	encodeMBI(ByteBuffer buffer, long number)
protected void	encodeUTF8(ByteBuffer buffer, java.lang.String stringToEncode)
ByteBuffer	getHeader()
int	getMessageId()
protected byte	getMessageInfo()	Sub-classes should override this to encode the message info.
int	getMessageQOS()
java.lang.String[]	getNames()
byte[]	getPayload()	Sub-classes should override this method to supply the payload bytes.
java.lang.String	getText()
byte	getType()
protected byte[]	getVariableHeader()
boolean	isMessageIdRequired()
static MQTTMessage	readFrom(java.io.DataInputStream in)
protected static int	readMBI(java.io.DataInputStream in)	Decodes an MQTT Multi-Byte Integer from the given stream.
MQTTMessage	withCode(int value)
MQTTMessage	withKeepAliveInterval(int value)
MQTTMessage	withMessageId(int value)
MQTTMessage	withNames(java.lang.String... names)
MQTTMessage	withQOS(int... qos)
MQTTMessage	withSession(boolean value)
MQTTMessage	withType(byte type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

msgId

protected int msgId

duplicate

protected boolean duplicate

KEY_CONNACK

public static final java.lang.String KEY_CONNACK

See Also:

Constant Field Values

KEY_DISCONNECT

public static final java.lang.String KEY_DISCONNECT

See Also:

Constant Field Values

KEY_PING

public static final java.lang.String KEY_PING

See Also:

Constant Field Values

KEY_CONNECT

public static final java.lang.String KEY_CONNECT

See Also:

Constant Field Values

MQTT_VERSION_3_1_1

public static final int MQTT_VERSION_3_1_1

Mqtt Version 3.1.1

See Also:

Constant Field Values

code

protected int code

session

protected boolean session

data

protected int[] data

names

protected java.lang.String[] names

keepAliveInterval

protected int keepAliveInterval

Constructor Detail

MQTTMessage

public MQTTMessage()

Method Detail

withType

public MQTTMessage withType(byte type)

getHeader

public ByteBuffer getHeader()

encodeUTF8

protected void encodeUTF8(ByteBuffer buffer,
                          java.lang.String stringToEncode)

getType

public byte getType()

Returns:

the type of the message.

getVariableHeader

protected byte[] getVariableHeader()

getPayload

public byte[] getPayload()

Sub-classes should override this method to supply the payload bytes.

Returns:

The payload byte array

getMessageInfo

protected byte getMessageInfo()

Sub-classes should override this to encode the message info. Only the least-significant four bits will be used.

Returns:

The Message information byte

create

public static MQTTMessage create(byte type)

decodeUTF8

protected java.lang.String decodeUTF8(ByteBuffer input)

Decodes a UTF-8 string

Parameters:

input - The input stream from which to read the encoded string

Returns:

a decoded String from the DataInputStream

withNames

public MQTTMessage withNames(java.lang.String... names)

create

public static MQTTMessage create(byte type,
                                 byte info,
                                 byte[] variableHeader)

readMBI

protected static int readMBI(java.io.DataInputStream in)
                      throws java.io.IOException

Decodes an MQTT Multi-Byte Integer from the given stream.

Parameters:

in - the input stream

Returns:

long Value of Read

Throws:

java.io.IOException - if an exception occurs when reading the input stream

encodeMBI

protected static void encodeMBI(ByteBuffer buffer,
                                long number)

readFrom

public static MQTTMessage readFrom(java.io.DataInputStream in)

withCode

public MQTTMessage withCode(int value)

withQOS

public MQTTMessage withQOS(int... qos)

withKeepAliveInterval

public MQTTMessage withKeepAliveInterval(int value)

withSession

public MQTTMessage withSession(boolean value)

createChannelOpen

public static MQTTMessage createChannelOpen(java.lang.String topic)

createMessage

public MQTTMessage createMessage(java.lang.String content)

isMessageIdRequired

public boolean isMessageIdRequired()

Returns:

whether or not this message needs to include a message ID.

getMessageId

public int getMessageId()

Returns:

the MQTT message ID.

getMessageQOS

public int getMessageQOS()

withMessageId

public MQTTMessage withMessageId(int value)

getText

public java.lang.String getText()

getNames

public java.lang.String[] getNames()