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

Class MqttIotHubConnection

java.lang.Object

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

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback

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

Field Summary

Fields

Modifier and Type	Field and Description
protected DeviceClientConfig	config
protected Object	MQTT_CONNECTION_LOCK The MQTT connection lock.
protected State	state

Constructor Summary

Constructors

Constructor and Description
MqttIotHubConnection(DeviceClientConfig config) Constructs an instance from the given DeviceClientConfig object.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	connectionLost(Throwable throwable) Event fired when the connection with the MQTT broker is lost.
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken iMqttDeliveryToken)
void	messageArrived(String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
void	open() Establishes a connection for the device and IoT Hub given in the client configuration.
Message	receiveMessage() Receives a message, if one exists.
IotHubStatusCode	sendEvent(Message message) Sends an event message.

Methods inherited from class java.lang.Object

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

Field Detail

MQTT_CONNECTION_LOCK

protected final Object MQTT_CONNECTION_LOCK

The MQTT connection lock.

config

protected final DeviceClientConfig config

state

protected State state

Constructor Detail

MqttIotHubConnection

public MqttIotHubConnection(DeviceClientConfig config)
                     throws IllegalArgumentException

Constructs an instance from the given DeviceClientConfig object.

Parameters:

config - the client configuration.

Throws:

IllegalArgumentException

Method Detail

open

public void open()
          throws IOException

Establishes a connection for the device and IoT Hub given in the client configuration. If the connection is already open, the function shall do nothing.

Throws:

IOException - if a connection could not to be established.

close

public void close()

Closes the connection. After the connection is closed, it is no longer usable. If the connection is already closed, the function shall do nothing.

sendEvent

public IotHubStatusCode sendEvent(Message message)
                           throws IllegalStateException

Sends an event message.

Parameters:

message - the event message.

Returns:

the status code from sending the event message.

Throws:

IllegalStateException - if the MqttIotHubConnection is not open

receiveMessage

public Message receiveMessage()
                       throws IllegalStateException

Receives a message, if one exists.

Returns:

the message received, or null if none exists.

Throws:

IllegalStateException - if the connection state is currently closed.

connectionLost

public void connectionLost(Throwable throwable)

Event fired when the connection with the MQTT broker is lost.

Specified by:

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

Parameters:

throwable - Reason for losing the connection.

messageArrived

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

Specified by:

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

deliveryComplete

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

Specified by:

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