org.eclipse.paho.client.mqttv3

Interface IMqttMessageListener

public interface IMqttMessageListener

Implementers of this interface will be notified when a message arrives.

Method Summary

Modifier and Type	Method and Description
void	messageArrived(java.lang.String topic, MqttMessage message) This method is called when a message arrives from the server.

Method Detail

messageArrived

void messageArrived(java.lang.String topic,
                    MqttMessage message)
             throws java.lang.Exception

This method is called when a message arrives from the server.

This method is invoked synchronously by the MQTT client. An acknowledgment is not sent back to the server until this method returns cleanly.

If an implementation of this method throws an Exception, then the client will be shut down. When the client is next re-connected, any QoS 1 or 2 messages will be redelivered by the server.

Any additional messages which arrive while an implementation of this method is running, will build up in memory, and will then back up on the network.

If an application needs to persist data, then it should ensure the data is persisted prior to returning from this method, as after returning from this method, the message is considered to have been delivered, and will not be reproducible.

It is possible to send a new message within an implementation of this callback (for example, a response to this message), but the implementation must not disconnect the client, as it will be impossible to send an acknowledgment for the message being processed, and a deadlock will occur.

Parameters:

topic - name of the topic on the message was published to

message - the actual message.

Throws:

java.lang.Exception - if a terminal error has occurred, and the client should be shut down.