org.eclipse.paho.android.service

Class DatabaseMessageStore

java.lang.Object

org.eclipse.paho.android.service.DatabaseMessageStore

All Implemented Interfaces:

MessageStore

public class DatabaseMessageStore
extends java.lang.Object
implements MessageStore

Implementation of the MessageStore interface, using a SQLite database

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.paho.android.service.MessageStore

MessageStore.StoredMessage

Constructor Summary

Constructors

Constructor and Description
DatabaseMessageStore(MqttService service, Context context) Constructor - create a DatabaseMessageStore to store arrived MQTT message

Method Summary

Methods

Modifier and Type	Method and Description
void	clearArrivedMessages(java.lang.String clientHandle) Delete all messages (optionally for a specific client)
boolean	discardArrived(java.lang.String clientHandle, java.lang.String id) Delete an MQTT message.
java.util.Iterator<MessageStore.StoredMessage>	getAllArrivedMessages(java.lang.String clientHandle) Get an iterator over all messages stored (optionally for a specific client)
java.lang.String	storeArrived(java.lang.String clientHandle, java.lang.String topic, org.eclipse.paho.client.mqttv3.MqttMessage message) Store an MQTT message

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseMessageStore

public DatabaseMessageStore(MqttService service,
                    Context context)

Constructor - create a DatabaseMessageStore to store arrived MQTT message

Parameters:

service - our parent MqttService

context - a context to use for android calls

Method Detail

storeArrived

public java.lang.String storeArrived(java.lang.String clientHandle,
                            java.lang.String topic,
                            org.eclipse.paho.client.mqttv3.MqttMessage message)

Store an MQTT message

Specified by:

storeArrived in interface MessageStore

Parameters:

clientHandle - identifier for the client storing the message

topic - The topic on which the message was published

message - the arrived MQTT message

Returns:

an identifier for the message, so that it can be removed when appropriate

discardArrived

public boolean discardArrived(java.lang.String clientHandle,
                     java.lang.String id)

Delete an MQTT message.

Specified by:

discardArrived in interface MessageStore

Parameters:

clientHandle - identifier for the client which stored the message

id - the identifying string returned when the message was stored

Returns:

true if the message was found and deleted

getAllArrivedMessages

public java.util.Iterator<MessageStore.StoredMessage> getAllArrivedMessages(java.lang.String clientHandle)

Get an iterator over all messages stored (optionally for a specific client)

Specified by:

getAllArrivedMessages in interface MessageStore

Parameters:

clientHandle - identifier for the client.
If null, all messages are retrieved

Returns:

iterator of all the arrived MQTT messages

clearArrivedMessages

public void clearArrivedMessages(java.lang.String clientHandle)

Delete all messages (optionally for a specific client)

Specified by:

clearArrivedMessages in interface MessageStore

Parameters:

clientHandle - identifier for the client.
If null, all messages are deleted