org.eclipse.paho.android.service

Interface MessageStore

All Known Implementing Classes:

DatabaseMessageStore

public interface MessageStore

Mechanism for persisting messages until we know they have been received

• A Service should store messages as they arrive via storeArrived(String, String, MqttMessage).
• When a message has been passed to the consuming entity, discardArrived(String, String) should be called.
• To recover messages which have not been definitely passed to the consumer, getAllArrivedMessages(String) is used.
• When a clean session is started clearArrivedMessages(String) is used.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageStore.StoredMessage External representation of a stored message

Method Summary

Methods

Modifier and Type	Method and Description
void	clearArrivedMessages(java.lang.String clientHandle) Discard stored messages, usually for a specific client
boolean	discardArrived(java.lang.String clientHandle, java.lang.String id) Discard a message - called when we are certain that an arrived message has reached the application.
java.util.Iterator<MessageStore.StoredMessage>	getAllArrivedMessages(java.lang.String clientHandle) Get all the stored messages, usually for a specific client
java.lang.String	storeArrived(java.lang.String clientHandle, java.lang.String Topic, org.eclipse.paho.client.mqttv3.MqttMessage message) Store a message and return an identifier for it

Method Detail

storeArrived

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

Store a message and return an identifier for it

Parameters:

clientHandle - identifier for the client

message - message to be stored

Returns:

a unique identifier for it

discardArrived

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

Discard a message - called when we are certain that an arrived message has reached the application.

Parameters:

clientHandle - identifier for the client

id - id of message to be discarded

getAllArrivedMessages

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

Get all the stored messages, usually for a specific client

Parameters:

clientHandle - identifier for the client - if null, then messages for all clients are returned

clearArrivedMessages

void clearArrivedMessages(java.lang.String clientHandle)

Discard stored messages, usually for a specific client

Parameters:

clientHandle - identifier for the client - if null, then messages for all clients are discarded