org.eclipse.paho.client.mqttv3.internal.wire
Class MqttConnect

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

public class MqttConnect
extends MqttWireMessage

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

Field Summary

static String

KEY

Fields inherited from class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage

duplicate, MESSAGE_TYPE_CONNACK, MESSAGE_TYPE_CONNECT, MESSAGE_TYPE_DISCONNECT, MESSAGE_TYPE_PINGREQ, MESSAGE_TYPE_PINGRESP, MESSAGE_TYPE_PUBACK, MESSAGE_TYPE_PUBCOMP, MESSAGE_TYPE_PUBLISH, MESSAGE_TYPE_PUBREC, MESSAGE_TYPE_PUBREL, MESSAGE_TYPE_SUBACK, MESSAGE_TYPE_SUBSCRIBE, MESSAGE_TYPE_UNSUBACK, MESSAGE_TYPE_UNSUBSCRIBE, msgId, STRING_ENCODING

Constructor Summary

MqttConnect(byte info, byte[] data)
Constructor for an on the wire MQTT connect message

MqttConnect(String clientId, boolean cleanSession, int keepAliveInterval, String userName, char[] password, MqttMessage willMessage, String willDestination)

Method Summary

String	getKey() Returns a key associated with the message.
protected byte	getMessageInfo() Sub-classes should override this to encode the message info.
byte[]	getPayload() Sub-classes should override this method to supply the payload bytes.
protected byte[]	getVariableHeader()
boolean	isCleanSession()
boolean	isMessageIdRequired() Returns whether or not this message needs to include a message ID.
String	toString()

Methods inherited from class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage

createWireMessage, createWireMessage, decodeUTF8, encodeMBI, encodeMessageId, encodeUTF8, getHeader, getMessageId, getType, isRetryable, readMBI, setDuplicate, setMessageId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KEY

public static String KEY

Constructor Detail

MqttConnect

public MqttConnect(byte info,
                   byte[] data)
            throws IOException,
                   MqttException

Constructor for an on the wire MQTT connect message

Parameters:

info -

data -

Throws:

IOException

MqttException

MqttConnect

public MqttConnect(String clientId,
                   boolean cleanSession,
                   int keepAliveInterval,
                   String userName,
                   char[] password,
                   MqttMessage willMessage,
                   String willDestination)

Method Detail

toString

public String toString()

Overrides:

toString in class MqttWireMessage

getMessageInfo

protected byte getMessageInfo()

Description copied from class: MqttWireMessage

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

Specified by:

getMessageInfo in class MqttWireMessage

isCleanSession

public boolean isCleanSession()

getVariableHeader

protected byte[] getVariableHeader()
                            throws MqttException

Specified by:

getVariableHeader in class MqttWireMessage

Throws:

MqttException

getPayload

public byte[] getPayload()
                  throws MqttException

Description copied from class: MqttWireMessage

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

Overrides:

getPayload in class MqttWireMessage

Throws:

MqttException

isMessageIdRequired

public boolean isMessageIdRequired()

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

Overrides:

isMessageIdRequired in class MqttWireMessage

getKey

public String getKey()

Description copied from class: MqttWireMessage

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

Overrides:

getKey in class MqttWireMessage

Returns:

key a key associated with the message