com.microsoft.azure.sdk.iot.device

Interface CorrelatingMessageCallback

public interface CorrelatingMessageCallback

This interface has a number of call backs to notify when a message is in a specific part of the IotHubTransport lifecycle.

There is no default implementation of this interface and will be up to the developer to implement.

Method Summary

Modifier and Type	Method and Description
void	onRequestAcknowledged(Message message, java.lang.Object callbackContext, IotHubClientException e) Called when the message request has been sent and IoT hub has acknowledged the request.
void	onRequestQueued(Message message, java.lang.Object callbackContext) Called when the message has been queued to the transport.
void	onRequestSent(Message message, java.lang.Object callbackContext) Called when the message request has been sent by the transport.
void	onResponseAcknowledged(Message message, java.lang.Object callbackContext) Called when a response to the message has been sent by IoT hub and has been acknowledged by the transport.
void	onResponseReceived(Message message, java.lang.Object callbackContext, IotHubClientException e) Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport.

Method Detail

onRequestQueued

void onRequestQueued(Message message,
                     java.lang.Object callbackContext)

Called when the message has been queued to the transport.

Parameters:

message - The request message queued by the transport.

callbackContext - The context sent with the message.

onRequestSent

void onRequestSent(Message message,
                   java.lang.Object callbackContext)

Called when the message request has been sent by the transport.

Parameters:

message - The request message sent by the transport.

callbackContext - The context sent with the message.

onRequestAcknowledged

void onRequestAcknowledged(Message message,
                           java.lang.Object callbackContext,
                           IotHubClientException e)

Called when the message request has been sent and IoT hub has acknowledged the request.

Parameters:

message - The request message acknowledged by the service.

callbackContext - The context sent with the message.

e - The exception given by the transport. If there are no errors this will be null.

onResponseReceived

void onResponseReceived(Message message,
                        java.lang.Object callbackContext,
                        IotHubClientException e)

Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport.

Parameters:

message - The response message received by the transport.

callbackContext - The context sent with the message.

e - The exception given by the transport. If there are no errors this will be null.

onResponseAcknowledged

void onResponseAcknowledged(Message message,
                            java.lang.Object callbackContext)

Called when a response to the message has been sent by IoT hub and has been acknowledged by the transport.

Parameters:

message - The response message queued to the transport.

callbackContext - The context sent with the message.