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

Interface IotHubListener

All Known Implementing Classes:

IotHubTransport

public interface IotHubListener

Callback interface for communicating connection and message status updates from individual protocol clients (mqtt, https, amqps) to the transport layer that handles queueing of messages and connecting/reconnecting/disconnecting

Method Summary

Modifier and Type	Method and Description
void	onConnectionEstablished(java.lang.String connectionId) Callback to be fired when the connection has been successfully established
void	onConnectionLost(TransportException e, java.lang.String connectionId) Callback to be fired when connection has been lost
void	onMessageReceived(IotHubTransportMessage transportMessage, TransportException e) Callback to be fired when a transport message has been received.
void	onMessageSent(Message message, java.lang.String deviceId, TransportException e) Callback to be fired when a message that the transport client sent has been acknowledged by Iot Hub
void	onMultiplexedDeviceSessionEstablished(java.lang.String connectionId, java.lang.String deviceId) Callback to be fired when the multiplexed connection establishes a new device session.
void	onMultiplexedDeviceSessionLost(TransportException e, java.lang.String connectionId, java.lang.String deviceId, boolean shouldReconnect) Callback to be fired when the multiplexed connection loses a device session.
void	onMultiplexedDeviceSessionRegistrationFailed(java.lang.String connectionId, java.lang.String deviceId, java.lang.Exception e) Callback to be fired when the multiplexed connection fails to register a device session.

Method Detail

onMessageSent

void onMessageSent(Message message,
                   java.lang.String deviceId,
                   TransportException e)

Callback to be fired when a message that the transport client sent has been acknowledged by Iot Hub

Parameters:

message - The message that was acknowledged

deviceId - The device that the message was sent from

e - Null if the message was successfully acknowledged. Otherwise, this exception communicates if the message should be resent at all

onMessageReceived

void onMessageReceived(IotHubTransportMessage transportMessage,
                       TransportException e)

Callback to be fired when a transport message has been received.

Parameters:

transportMessage - The message that was received. May be null if e is not null

e - the exception that was encountered while receiving messages. May be null if transportMessage is not null

onConnectionLost

void onConnectionLost(TransportException e,
                      java.lang.String connectionId)

Callback to be fired when connection has been lost

Parameters:

e - the cause of the connection loss

connectionId - the id of the connection this update is relevant to

onConnectionEstablished

void onConnectionEstablished(java.lang.String connectionId)

Callback to be fired when the connection has been successfully established

Parameters:

connectionId - the id of the connection this update is relevant to

onMultiplexedDeviceSessionEstablished

void onMultiplexedDeviceSessionEstablished(java.lang.String connectionId,
                                           java.lang.String deviceId)

Callback to be fired when the multiplexed connection establishes a new device session.

Parameters:

connectionId - the Id of the connection, used to identify which of possible many reconnection attempts this event belongs to.

deviceId - the Id of the device that the session belongs to

onMultiplexedDeviceSessionLost

void onMultiplexedDeviceSessionLost(TransportException e,
                                    java.lang.String connectionId,
                                    java.lang.String deviceId,
                                    boolean shouldReconnect)

Callback to be fired when the multiplexed connection loses a device session.

Parameters:

e - The exception that caused the connection to be lost.

connectionId - the Id of the connection, used to identify which of possible many reconnection attempts this event belongs to.

deviceId - the Id of the device that the session belongs to

shouldReconnect - false if the disconnect was desired by the users, and true if it is the consequence of an issue where the SDK should retry.

onMultiplexedDeviceSessionRegistrationFailed

void onMultiplexedDeviceSessionRegistrationFailed(java.lang.String connectionId,
                                                  java.lang.String deviceId,
                                                  java.lang.Exception e)

Callback to be fired when the multiplexed connection fails to register a device session.

Parameters:

connectionId - the Id of the connection, used to identify which of possible many reconnection attempts this event belongs to.

deviceId - the Id of the device that the session belongs to

e - the throwable that explains why the registration failed.