org.eclipse.kura.cloud

Interface CloudClientListener

All Known Implementing Classes:

Cloudlet

@ConsumerType
public interface CloudClientListener

CloudClientListener is the interface to be implemented by applications that needs to be notified of events in the CloudClient. Arrived methods are invoked whenever a message is sent to a appTopic associated to the CloudClient. The Arrived method signatures are differentiated based on whether the incoming messages have been published to a data topic (by default accountName/#) or a control topic (by default $EDC/accountName/#).

Method Summary

Modifier and Type	Method and Description
void	onConnectionEstablished() Called when the CloudClient has successfully connected with the broker.
void	onConnectionLost() Called when the client has lost its connection with the broker.
void	onControlMessageArrived(java.lang.String deviceId, java.lang.String appTopic, KuraPayload msg, int qos, boolean retain) Called by the CloudClient when it receives a published control message from the broker.
void	onMessageArrived(java.lang.String deviceId, java.lang.String appTopic, KuraPayload msg, int qos, boolean retain) Called by the client when it receives a published data message from the broker.
void	onMessageConfirmed(int messageId, java.lang.String appTopic) Called by the CloudClient when a published message has been fully acknowledged by the broker, as appropriate for the quality of service.
void	onMessagePublished(int messageId, java.lang.String appTopic) Called by the CloudClient when a message has been transfered from the publishing queue to the underlying DataTransportService for publishing on the wire.

Method Detail

onControlMessageArrived

void onControlMessageArrived(java.lang.String deviceId,
                             java.lang.String appTopic,
                             KuraPayload msg,
                             int qos,
                             boolean retain)

Called by the CloudClient when it receives a published control message from the broker. If the message received has a binary payload that it has NOT been encoded using the the KuraPayload class, the received bytes will be set as the body field of a new KuraPaylaod instance which is passed to the callback Listener interface.

Parameters:

deviceId - The deviceId this message was addressed to.

appTopic - The appTopic the message arrived on.

msg - The KuraPayload that arrived.

qos - The Quality of Service that the message was received on.

retain - Whether the message was retained by the broker.

onMessageArrived

void onMessageArrived(java.lang.String deviceId,
                      java.lang.String appTopic,
                      KuraPayload msg,
                      int qos,
                      boolean retain)

Called by the client when it receives a published data message from the broker. If the message received has a binary payload that it has NOT been encoded using the the KuraPayload class, the received bytes will be set as the body field of a new KuraPaylaod instance which is passed to the callback Listener interface.

Parameters:

deviceId - The asset ID of the semanticTopic prefix the message arrived on.

appTopic - The appTopic the message arrived on.

msg - The KuraPayload that arrived.

qos - The Quality of Service that the message was received on.

retain - Whether the message was retained by the broker.

onConnectionLost

void onConnectionLost()

Called when the client has lost its connection with the broker. Depending on the DataService configuration, the client will attempt to reconnect and call the onConnectionEstablished() method upon a successful reconnect. This is only a notification, the callback handler should not attempt to handle the reconnect.
If the bundle using the client relies on subscriptions beyond the default ones, it is responsibility of the application to implement the onConnectionEstablished() callback method to restore the subscriptions it needs after a connection loss.

onConnectionEstablished

void onConnectionEstablished()

Called when the CloudClient has successfully connected with the broker.
If the bundle using the client relies on subscriptions beyond the default ones, it is responsibility of the application to implement the onConnectionEstablished() callback method to restore the subscriptions it needs after a connection loss.

onMessageConfirmed

void onMessageConfirmed(int messageId,
                        java.lang.String appTopic)

Called by the CloudClient when a published message has been fully acknowledged by the broker, as appropriate for the quality of service. The published method is not called for QoS 0 publications.

Parameters:

messageId - The message id of the published message

onMessagePublished

void onMessagePublished(int messageId,
                        java.lang.String appTopic)

Called by the CloudClient when a message has been transfered from the publishing queue to the underlying DataTransportService for publishing on the wire.