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:

IotHubTransportConnection

public class MqttIotHubConnection
extends java.lang.Object
implements IotHubTransportConnection

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
java.lang.String	getConnectionId() Gives the UUID associated with this connection instance.
void	onMessageArrived(int messageId)
void	open() Establishes a connection for the device and IoT Hub given in the client configuration.
IotHubStatusCode	sendMessage(Message message) Sends an event message.
boolean	sendMessageResult(IotHubTransportMessage message, IotHubMessageResult result) Sends an ACK to the service for the provided message
void	setListener(IotHubListener listener) Sets a listener into the Transport Connection object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttIotHubConnection

public MqttIotHubConnection(ClientConfiguration config)
                     throws TransportException

Constructs an instance from the given ClientConfiguration object.

Parameters:

config - the client configuration.

Throws:

TransportException - if the mqtt connection configuration cannot be constructed.

Method Detail

open

public void open()
          throws TransportException

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.

Specified by:

open in interface IotHubTransportConnection

Throws:

TransportException - 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.

Specified by:

close in interface IotHubTransportConnection

setListener

public void setListener(IotHubListener listener)
                 throws java.lang.IllegalArgumentException

Description copied from interface: IotHubTransportConnection

Sets a listener into the Transport Connection object. This listener updates the Transport layer of connection status updates, message arrivals, and message acknowledgements

Specified by:

setListener in interface IotHubTransportConnection

Parameters:

listener - the listener for connection status updates, message arrivals, and message acknowledgements

Throws:

java.lang.IllegalArgumentException

sendMessage

public IotHubStatusCode sendMessage(Message message)
                             throws TransportException

Sends an event message.

Specified by:

sendMessage in interface IotHubTransportConnection

Parameters:

message - the event message.

Returns:

the status code from sending the event message.

Throws:

TransportException - if the MqttIotHubConnection is not open

sendMessageResult

public boolean sendMessageResult(IotHubTransportMessage message,
                                 IotHubMessageResult result)
                          throws TransportException

Sends an ACK to the service for the provided message

Specified by:

sendMessageResult in interface IotHubTransportConnection

Parameters:

message - the message to acknowledge to the service

result - Ignored. The only ack that can be sent in MQTT is COMPLETE

Returns:

true if the ACK was sent successfully and false otherwise

Throws:

TransportException - if the ACK could not be sent successfully

getConnectionId

public java.lang.String getConnectionId()

Description copied from interface: IotHubTransportConnection

Gives the UUID associated with this connection instance. This string is used in conjunction with the callbacks with connection status updates to ensure that all connection status updates are relevant to this connection object

Specified by:

getConnectionId in interface IotHubTransportConnection

Returns:

the UUID associated with this connection instance

onMessageArrived

public void onMessageArrived(int messageId)