blob: ab9619327641965db165177bf8f4913cb0d1d59e [file] [log] [blame]
<!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>MqttDeliveryTokenAndroid</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="MqttDeliveryTokenAndroid";
}
//-->
</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/MqttDeliveryTokenAndroid.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/MqttConnection.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/MqttService.html" title="class 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/MqttDeliveryTokenAndroid.html" target="_top">Frames</a></li>
<li><a href="MqttDeliveryTokenAndroid.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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="Class MqttDeliveryTokenAndroid" class="title">Class MqttDeliveryTokenAndroid</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html" title="class in org.eclipse.paho.android.service">org.eclipse.paho.android.service.MqttTokenAndroid</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.paho.android.service.MqttDeliveryTokenAndroid</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken, org.eclipse.paho.client.mqttv3.IMqttToken</dd>
</dl>
<hr>
<br>
<pre> class <span class="strong">MqttDeliveryTokenAndroid</span>
extends <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html" title="class in org.eclipse.paho.android.service">MqttTokenAndroid</a>
implements org.eclipse.paho.client.mqttv3.IMqttDeliveryToken</pre>
<div class="block"><p>
Implementation of the IMqttDeliveryToken interface for use from within the
MqttAndroidClient implementation</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttDeliveryTokenAndroid.html#MqttDeliveryTokenAndroid(org.eclipse.paho.android.service.MqttAndroidClient, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener, org.eclipse.paho.client.mqttv3.MqttMessage)">MqttDeliveryTokenAndroid</a></strong>(<a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html" title="class in org.eclipse.paho.android.service">MqttAndroidClient</a>&nbsp;client,
java.lang.Object&nbsp;userContext,
org.eclipse.paho.client.mqttv3.IMqttActionListener&nbsp;listener,
org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message)</code>&nbsp;</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">&nbsp;</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>org.eclipse.paho.client.mqttv3.MqttMessage</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttDeliveryTokenAndroid.html#getMessage()">getMessage</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttDeliveryTokenAndroid.html#notifyDelivery(org.eclipse.paho.client.mqttv3.MqttMessage)">notifyDelivery</a></strong>(org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;delivered)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttDeliveryTokenAndroid.html#setMessage(org.eclipse.paho.client.mqttv3.MqttMessage)">setMessage</a></strong>(org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.paho.android.service.MqttTokenAndroid">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.paho.android.service.<a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html" title="class in org.eclipse.paho.android.service">MqttTokenAndroid</a></h3>
<code><a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#getActionCallback()">getActionCallback</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#getClient()">getClient</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#getException()">getException</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#getMessageId()">getMessageId</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#getTopics()">getTopics</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#getUserContext()">getUserContext</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#isComplete()">isComplete</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#notifyComplete()">notifyComplete</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#notifyFailure(java.lang.Throwable)">notifyFailure</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#setActionCallback(org.eclipse.paho.client.mqttv3.IMqttActionListener)">setActionCallback</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#setComplete(boolean)">setComplete</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#setDelegate(org.eclipse.paho.client.mqttv3.IMqttToken)">setDelegate</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#setException(org.eclipse.paho.client.mqttv3.MqttException)">setException</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#setUserContext(java.lang.Object)">setUserContext</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#waitForCompletion()">waitForCompletion</a>, <a href="../../../../../org/eclipse/paho/android/service/MqttTokenAndroid.html#waitForCompletion(long)">waitForCompletion</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.paho.client.mqttv3.IMqttToken">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.paho.client.mqttv3.IMqttToken</h3>
<code>getActionCallback, getClient, getException, getMessageId, getTopics, getUserContext, isComplete, setActionCallback, setUserContext, waitForCompletion, waitForCompletion</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MqttDeliveryTokenAndroid(org.eclipse.paho.android.service.MqttAndroidClient, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener, org.eclipse.paho.client.mqttv3.MqttMessage)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MqttDeliveryTokenAndroid</h4>
<pre>MqttDeliveryTokenAndroid(<a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html" title="class in org.eclipse.paho.android.service">MqttAndroidClient</a>&nbsp;client,
java.lang.Object&nbsp;userContext,
org.eclipse.paho.client.mqttv3.IMqttActionListener&nbsp;listener,
org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre>public&nbsp;org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;getMessage()
throws org.eclipse.paho.client.mqttv3.MqttException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getMessage</code>&nbsp;in interface&nbsp;<code>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>IMqttDeliveryToken.getMessage()</code></dd></dl>
</li>
</ul>
<a name="setMessage(org.eclipse.paho.client.mqttv3.MqttMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessage</h4>
<pre>void&nbsp;setMessage(org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message)</pre>
</li>
</ul>
<a name="notifyDelivery(org.eclipse.paho.client.mqttv3.MqttMessage)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>notifyDelivery</h4>
<pre>void&nbsp;notifyDelivery(org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;delivered)</pre>
</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/MqttDeliveryTokenAndroid.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/MqttConnection.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/MqttService.html" title="class 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/MqttDeliveryTokenAndroid.html" target="_top">Frames</a></li>
<li><a href="MqttDeliveryTokenAndroid.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>