com.microsoft.azure.sdk.iot.provisioning.device.transport.mqtt

Class MqttConnection

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.device.transport.mqtt.MqttConnection

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback

public class MqttConnection
extends Object
implements org.eclipse.paho.client.mqttv3.MqttCallback

Constructor Summary

Constructors

Constructor and Description
MqttConnection(String hostname, String clientId, String userName, String password, SSLContext sslContext, MqttListener listener, boolean useWebSockets) Constructor to create MqttAsync Client with Paho

Method Summary

Modifier and Type	Method and Description
void	connect() Connects to the MQTT broker
void	connectionLost(Throwable throwable) Event fired when the connection is lost on the MQTT broker
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken iMqttDeliveryToken) Event fired when the message arrived on the MQTT broker.
void	disconnect() Disconnects from the MQTT broker
String	getConnectionId()
String	getHostName()
boolean	isMqttConnected() Return whether the MQTT broker is connected to the endpoint
void	messageArrived(String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage) Event fired when the message arrived on the MQTT broker.
void	publishMessage(MqttMessage message) Sends a PUBLISH message to the MQTT broker
void	publishMessage(String topic, MqttQos qos, byte[] message) Sends a PUBLISH message to the MQTT broker
void	subscribe(String topic, MqttQos qos) Send the SUBSCRIBE message to the MQTT broker
void	unsubscribe(String topic) Send the UNSUBSCRIBE message to the MQTT broker

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttConnection

public MqttConnection(String hostname,
                      String clientId,
                      String userName,
                      String password,
                      SSLContext sslContext,
                      MqttListener listener,
                      boolean useWebSockets)
               throws IOException

Constructor to create MqttAsync Client with Paho

Parameters:

hostname - Uri to connect to

clientId - Client Id to connect to

userName - Username

password - password

sslContext - SSLContext for the connection

listener - Mqtt listener

useWebSockets - true to use Mqtt over web sockets

Throws:

IOException - is thrown if any of the parameters are null or empty or client cannot be instantiated

Method Detail

isMqttConnected

public boolean isMqttConnected()

Return whether the MQTT broker is connected to the endpoint

Returns:

true if connected using Mqtt

connect

public void connect()
             throws IOException

Connects to the MQTT broker

Throws:

IOException - if there is a Mqtt exception.

disconnect

public void disconnect()
                throws IOException

Disconnects from the MQTT broker

Throws:

IOException - if there is a Mqtt exception.

publishMessage

public void publishMessage(String topic,
                           MqttQos qos,
                           byte[] message)
                    throws IOException

Sends a PUBLISH message to the MQTT broker

Parameters:

topic - The topic of the message

qos - The QOS of the message

message - The message to be sent

Throws:

IOException - if there is a Mqtt exception.

publishMessage

public void publishMessage(MqttMessage message)
                    throws IOException

Sends a PUBLISH message to the MQTT broker

Parameters:

message - The message to be sent

Throws:

IOException - if there is a Mqtt exception.

subscribe

public void subscribe(String topic,
                      MqttQos qos)
               throws IOException

Send the SUBSCRIBE message to the MQTT broker

Parameters:

topic - The topic of the message

qos - The QOS of the message

Throws:

IOException - if there is a Mqtt exception.

unsubscribe

public void unsubscribe(String topic)
                 throws IOException

Send the UNSUBSCRIBE message to the MQTT broker

Parameters:

topic - Name of the Topic to unsubscribe.

Throws:

IOException - if there is a Mqtt exception.

messageArrived

public void messageArrived(String topic,
                           org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)

Event fired when the message arrived on the MQTT broker.

Specified by:

messageArrived in interface org.eclipse.paho.client.mqttv3.MqttCallback

Parameters:

topic - the topic on which message arrived.

mqttMessage - the message arrived on the Mqtt broker.

deliveryComplete

public void deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken iMqttDeliveryToken)

Event fired when the message arrived on the MQTT broker.

Specified by:

deliveryComplete in interface org.eclipse.paho.client.mqttv3.MqttCallback

Parameters:

iMqttDeliveryToken - the MqttDeliveryToken for which the message was successfully sent.

connectionLost

public void connectionLost(Throwable throwable)

Event fired when the connection is lost on the MQTT broker

Specified by:

connectionLost in interface org.eclipse.paho.client.mqttv3.MqttCallback

Parameters:

throwable - the disconnection reason.

getConnectionId

public String getConnectionId()

getHostName

public String getHostName()