| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!-- NewPage --> | |
| <html lang="en"> | |
| <head> | |
| <!-- Generated by javadoc (version 1.7.0_13) on Wed Apr 23 18:07:53 CST 2014 --> | |
| <title>MessageStore</title> | |
| <meta name="date" content="2014-04-23"> | |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> | |
| </head> | |
| <body> | |
| <script type="text/javascript"><!-- | |
| if (location.href.indexOf('is-external=true') == -1) { | |
| parent.document.title="MessageStore"; | |
| } | |
| //--> | |
| </script> | |
| <noscript> | |
| <div>JavaScript is disabled on your browser.</div> | |
| </noscript> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <div class="topNav"><a name="navbar_top"> | |
| <!-- --> | |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/MessageStore.html">Use</a></li> | |
| <li><a href="package-tree.html">Tree</a></li> | |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> | |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> | |
| <li><a href="../../../../../help-doc.html">Help</a></li> | |
| </ul> | |
| </div> | |
| <div class="subNav"> | |
| <ul class="navList"> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/DatabaseMessageStore.html" title="class in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service"><span class="strong">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/eclipse/paho/android/service/MessageStore.html" target="_top">Frames</a></li> | |
| <li><a href="MessageStore.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_top"> | |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> | |
| </ul> | |
| <div> | |
| <script type="text/javascript"><!-- | |
| allClassesLink = document.getElementById("allclasses_navbar_top"); | |
| if(window==top) { | |
| allClassesLink.style.display = "block"; | |
| } | |
| else { | |
| allClassesLink.style.display = "none"; | |
| } | |
| //--> | |
| </script> | |
| </div> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li><a href="#nested_class_summary">Nested</a> | </li> | |
| <li>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method_summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method_detail">Method</a></li> | |
| </ul> | |
| </div> | |
| <a name="skip-navbar_top"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <div class="header"> | |
| <div class="subTitle">org.eclipse.paho.android.service</div> | |
| <h2 title="Interface MessageStore" class="title">Interface MessageStore</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Known Implementing Classes:</dt> | |
| <dd><a href="../../../../../org/eclipse/paho/android/service/DatabaseMessageStore.html" title="class in org.eclipse.paho.android.service">DatabaseMessageStore</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="strong">MessageStore</span></pre> | |
| <div class="block"><p> | |
| Mechanism for persisting messages until we know they have been received | |
| </p> | |
| <ul> | |
| <li>A Service should store messages as they arrive via | |
| <a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#storeArrived(java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)"><code>storeArrived(String, String, MqttMessage)</code></a>. | |
| <li>When a message has been passed to the consuming entity, | |
| <a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#discardArrived(java.lang.String, java.lang.String)"><code>discardArrived(String, String)</code></a> should be called. | |
| <li>To recover messages which have not been definitely passed to the | |
| consumer, <a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#getAllArrivedMessages(java.lang.String)"><code>getAllArrivedMessages(String)</code></a> is used. | |
| <li>When a clean session is started <a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#clearArrivedMessages(java.lang.String)"><code>clearArrivedMessages(String)</code></a> is | |
| used. | |
| </ul></div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="nested_class_summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested Class Summary</h3> | |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> | |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Interface and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>static interface </code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service">MessageStore.StoredMessage</a></strong></code> | |
| <div class="block">External representation of a stored message</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method_summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Summary</h3> | |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> | |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Method and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#clearArrivedMessages(java.lang.String)">clearArrivedMessages</a></strong>(java.lang.String clientHandle)</code> | |
| <div class="block">Discard stored messages, usually for a specific client</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#discardArrived(java.lang.String, java.lang.String)">discardArrived</a></strong>(java.lang.String clientHandle, | |
| java.lang.String id)</code> | |
| <div class="block">Discard a message - called when we are certain that an arrived message | |
| has reached the application.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/eclipse/paho/android/service/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service">MessageStore.StoredMessage</a>></code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#getAllArrivedMessages(java.lang.String)">getAllArrivedMessages</a></strong>(java.lang.String clientHandle)</code> | |
| <div class="block">Get all the stored messages, usually for a specific client</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>java.lang.String</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MessageStore.html#storeArrived(java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)">storeArrived</a></strong>(java.lang.String clientHandle, | |
| java.lang.String Topic, | |
| org.eclipse.paho.client.mqttv3.MqttMessage message)</code> | |
| <div class="block">Store a message and return an identifier for it</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method_detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="storeArrived(java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>storeArrived</h4> | |
| <pre>java.lang.String storeArrived(java.lang.String clientHandle, | |
| java.lang.String Topic, | |
| org.eclipse.paho.client.mqttv3.MqttMessage message)</pre> | |
| <div class="block">Store a message and return an identifier for it</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifier for the client</dd><dd><code>message</code> - message to be stored</dd> | |
| <dt><span class="strong">Returns:</span></dt><dd>a unique identifier for it</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="discardArrived(java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>discardArrived</h4> | |
| <pre>boolean discardArrived(java.lang.String clientHandle, | |
| java.lang.String id)</pre> | |
| <div class="block">Discard a message - called when we are certain that an arrived message | |
| has reached the application.</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifier for the client</dd><dd><code>id</code> - id of message to be discarded</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="getAllArrivedMessages(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getAllArrivedMessages</h4> | |
| <pre>java.util.Iterator<<a href="../../../../../org/eclipse/paho/android/service/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service">MessageStore.StoredMessage</a>> getAllArrivedMessages(java.lang.String clientHandle)</pre> | |
| <div class="block">Get all the stored messages, usually for a specific client</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifier for the client - if null, then messages for all | |
| clients are returned</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="clearArrivedMessages(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>clearArrivedMessages</h4> | |
| <pre>void clearArrivedMessages(java.lang.String clientHandle)</pre> | |
| <div class="block">Discard stored messages, usually for a specific client</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifier for the client - if null, then messages for all | |
| clients are discarded</dd></dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <div class="bottomNav"><a name="navbar_bottom"> | |
| <!-- --> | |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/MessageStore.html">Use</a></li> | |
| <li><a href="package-tree.html">Tree</a></li> | |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> | |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> | |
| <li><a href="../../../../../help-doc.html">Help</a></li> | |
| </ul> | |
| </div> | |
| <div class="subNav"> | |
| <ul class="navList"> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/DatabaseMessageStore.html" title="class in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service"><span class="strong">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/eclipse/paho/android/service/MessageStore.html" target="_top">Frames</a></li> | |
| <li><a href="MessageStore.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_bottom"> | |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> | |
| </ul> | |
| <div> | |
| <script type="text/javascript"><!-- | |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); | |
| if(window==top) { | |
| allClassesLink.style.display = "block"; | |
| } | |
| else { | |
| allClassesLink.style.display = "none"; | |
| } | |
| //--> | |
| </script> | |
| </div> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li><a href="#nested_class_summary">Nested</a> | </li> | |
| <li>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method_summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method_detail">Method</a></li> | |
| </ul> | |
| </div> | |
| <a name="skip-navbar_bottom"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| </body> | |
| </html> |