Share via

CorrelatingMessageCallback Interface

  • Reference
Package:
com.microsoft.azure.sdk.iot.device

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, Object callbackContext, IotHubClientException e)

Called when the message request has been sent and IoT hub has acknowledged the request.
void onRequestQueued(Message message, Object callbackContext)

Called when the message has been queued to the transport.
void onRequestSent(Message message, Object callbackContext)

Called when the message request has been sent by the transport.
void onResponseAcknowledged(Message message, 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, 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 Details

onRequestAcknowledged

public void onRequestAcknowledged(Message message, 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 benull  

</code> . </p>

onRequestQueued

public void onRequestQueued(Message message, 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

public void onRequestSent(Message message, 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.

onResponseAcknowledged

public void onResponseAcknowledged(Message message, 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.

onResponseReceived

public void onResponseReceived(Message message, 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 benull  

</code> . </p>

Applies to