
public class MqttConnect
extends MqttWireMessage

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

Field Summary

Fields
Modifier and Type	Field	Description
`public final static byte`	`USER_DEFINED_PAIR_IDENTIFIER`
`public static String`	`KEY`
`private String`	`clientId`
`private MqttMessage`	`willMessage`
`private String`	`userName`
`private Array<char>`	`password`
`private int`	`keepAliveInterval`
`private String`	`willDestination`

Constructor Summary

Constructors
Constructor	Description
`MqttConnect(byte info, Array<byte> data)`	Constructor for an on the wire MQTT connect message
`MqttConnect(String clientId, boolean cleanSession, int keepAliveInterval, String userName, Array<char> password, MqttMessage willMessage, String willDestination, String protocolName, int protocolLevel, List<UserProperty> userProperties)`

Method Summary

Modifier and Type	Method	Description
`String`	`getClientId()`
`MqttMessage`	`getWillMessage()`
`String`	`getUserName()`
`Array<char>`	`getPassword()`
`int`	`getKeepAliveInterval()`
`String`	`getWillDestination()`
`String`	`toString()`
`boolean`	`isCleanSession()`
`Array<byte>`	`getPayload()`	Sub-classes should override this method to supply the payload bytes.
`boolean`	`isMessageIdRequired()`	Returns whether or not this message needs to include a message ID.
`String`	`getKey()`	Returns a key associated with the message.

Methods inherited from class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
createWireMessage, createWireMessage, getHeader, getMessageId, getToken, getType, isRetryable, packetName, setDuplicate, setMessageId, setToken
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MqttConnect
```
MqttConnect(byte info, Array<byte> data)
```
Constructor for an on the wire MQTT connect message

MqttConnect

MqttConnect(String clientId, boolean cleanSession, int keepAliveInterval, String userName, Array<char> password, MqttMessage willMessage, String willDestination, String protocolName, int protocolLevel, List<UserProperty> userProperties)

Method Detail
- getClientId
```
 String getClientId()
```
- getWillMessage
```
 MqttMessage getWillMessage()
```
- getUserName
```
 String getUserName()
```
- getPassword
```
 Array<char> getPassword()
```
- getKeepAliveInterval
```
 int getKeepAliveInterval()
```
- getWillDestination
```
 String getWillDestination()
```
- toString
```
 String toString()
```
- isCleanSession
```
 boolean isCleanSession()
```
- getPayload
```
 Array<byte> getPayload()
```
  Sub-classes should override this method to supply the payload bytes.
- isMessageIdRequired
```
 boolean isMessageIdRequired()
```
  Returns whether or not this message needs to include a 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

Class MqttConnect

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MqttConnect

MqttConnect

Method Detail

getClientId

getWillMessage

getUserName

getPassword

getKeepAliveInterval

getWillDestination

toString

isCleanSession

getPayload

isMessageIdRequired

getKey