<!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>MqttAndroidClient</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="MqttAndroidClient"; | |
} | |
//--> | |
</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/MqttAndroidClient.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/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li> | |
<li><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum 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/MqttAndroidClient.html" target="_top">Frames</a></li> | |
<li><a href="MqttAndroidClient.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><a href="#field_summary">Field</a> | </li> | |
<li><a href="#constructor_summary">Constr</a> | </li> | |
<li><a href="#method_summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li><a href="#field_detail">Field</a> | </li> | |
<li><a href="#constructor_detail">Constr</a> | </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 MqttAndroidClient" class="title">Class MqttAndroidClient</h2> | |
</div> | |
<div class="contentContainer"> | |
<ul class="inheritance"> | |
<li>java.lang.Object</li> | |
<li> | |
<ul class="inheritance"> | |
<li>BroadcastReceiver</li> | |
<li> | |
<ul class="inheritance"> | |
<li>org.eclipse.paho.android.service.MqttAndroidClient</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.IMqttAsyncClient</dd> | |
</dl> | |
<hr> | |
<br> | |
<pre>public class <span class="strong">MqttAndroidClient</span> | |
extends BroadcastReceiver | |
implements org.eclipse.paho.client.mqttv3.IMqttAsyncClient</pre> | |
<div class="block">Enables an android application to communicate with an MQTT server using non-blocking methods. | |
<p> | |
Implementation of the MQTT asynchronous client interface <code>IMqttAsyncClient</code> , using the MQTT | |
android service to actually interface with MQTT server. It provides android applications a simple programming interface to all features of the MQTT version 3.1 | |
specification including: | |
<ul> | |
<li>connect | |
<li>publish | |
<li>subscribe | |
<li>unsubscribe | |
<li>disconnect | |
</ul> | |
</p></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">Class and Description</th> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>static class </code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service">MqttAndroidClient.Ack</a></strong></code> | |
<div class="block">The Acknowledgment mode for messages received from <code>MqttCallback.messageArrived(String, MqttMessage)</code></div> | |
</td> | |
</tr> | |
</table> | |
</li> | |
</ul> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<ul class="blockList"> | |
<li class="blockList"><a name="field_summary"> | |
<!-- --> | |
</a> | |
<h3>Field Summary</h3> | |
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> | |
<caption><span>Fields</span><span class="tabEnd"> </span></caption> | |
<tr> | |
<th class="colFirst" scope="col">Modifier and Type</th> | |
<th class="colLast" scope="col">Field and Description</th> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>(package private) Context</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#myContext">myContext</a></strong></code> </td> | |
</tr> | |
</table> | |
</li> | |
</ul> | |
<!-- ======== 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"> </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/MqttAndroidClient.html#MqttAndroidClient(Context, java.lang.String, java.lang.String)">MqttAndroidClient</a></strong>(Context context, | |
java.lang.String serverURI, | |
java.lang.String clientId)</code> | |
<div class="block">Constructor - create an MqttAndroidClient that can be used to communicate with an MQTT server on android</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colOne"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#MqttAndroidClient(Context, java.lang.String, java.lang.String, org.eclipse.paho.android.service.MqttAndroidClient.Ack)">MqttAndroidClient</a></strong>(Context ctx, | |
java.lang.String serverURI, | |
java.lang.String clientId, | |
<a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service">MqttAndroidClient.Ack</a> ackType)</code> | |
<div class="block">Constructor - create an MqttAndroidClient that can be used to communicate with an MQTT server on android</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colOne"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#MqttAndroidClient(Context, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence)">MqttAndroidClient</a></strong>(Context ctx, | |
java.lang.String serverURI, | |
java.lang.String clientId, | |
org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence)</code> | |
<div class="block">Constructor - create an MqttAndroidClient that can be used to communicate with an MQTT server on android</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colOne"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#MqttAndroidClient(Context, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence, org.eclipse.paho.android.service.MqttAndroidClient.Ack)">MqttAndroidClient</a></strong>(Context context, | |
java.lang.String serverURI, | |
java.lang.String clientId, | |
org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence, | |
<a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service">MqttAndroidClient.Ack</a> ackType)</code> | |
<div class="block">constructor</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>boolean</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#acknowledgeMessage(java.lang.String)">acknowledgeMessage</a></strong>(java.lang.String messageId)</code> | |
<div class="block">Acknowledges a message received on the <code>MqttCallback.messageArrived(String, MqttMessage)</code></div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#close()">close</a></strong>()</code> | |
<div class="block">Close the client | |
Releases all resource associated with the client.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect()">connect</a></strong>()</code> | |
<div class="block">Connects to an MQTT server using the default options.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions)">connect</a></strong>(org.eclipse.paho.client.mqttv3.MqttConnectOptions options)</code> | |
<div class="block">Connects to an MQTT server using the provided connect options.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">connect</a></strong>(org.eclipse.paho.client.mqttv3.MqttConnectOptions options, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Connects to an MQTT server using the specified options.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect(java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">connect</a></strong>(java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Connects to an MQTT server using the default options.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect()">disconnect</a></strong>()</code> | |
<div class="block">Disconnects from the server.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect(long)">disconnect</a></strong>(long quiesceTimeout)</code> | |
<div class="block">Disconnects from the server.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect(long, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">disconnect</a></strong>(long quiesceTimeout, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Disconnects from the server.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect(java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">disconnect</a></strong>(java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Disconnects from the server.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnectForcibly()">disconnectForcibly</a></strong>()</code> </td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnectForcibly(long)">disconnectForcibly</a></strong>(long disconnectTimeout)</code> </td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnectForcibly(long, long)">disconnectForcibly</a></strong>(long quiesceTimeout, | |
long disconnectTimeout)</code> </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/MqttAndroidClient.html#getClientId()">getClientId</a></strong>()</code> | |
<div class="block">Returns the client ID used by this client.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken[]</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#getPendingDeliveryTokens()">getPendingDeliveryTokens</a></strong>()</code> | |
<div class="block">Returns the delivery tokens for any outstanding publish operations.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.MqttProtocolVersion</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#getProtocolVersion()">getProtocolVersion</a></strong>()</code> </td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>java.lang.String</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#getServerURI()">getServerURI</a></strong>()</code> | |
<div class="block">Returns the URI address of the server used by this client.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>javax.net.ssl.SSLSocketFactory</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#getSSLSocketFactory(java.io.InputStream, java.lang.String)">getSSLSocketFactory</a></strong>(java.io.InputStream keyStore, | |
java.lang.String password)</code> | |
<div class="block">Get the SSLSocketFactory using SSL key store and password</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>boolean</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#isConnected()">isConnected</a></strong>()</code> | |
<div class="block">Determines if this client is currently connected to the server.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#onReceive(Context, Intent)">onReceive</a></strong>(Context context, | |
Intent intent)</code> | |
<div class="block"> | |
Process incoming Intent objects representing the results of operations | |
and asynchronous activities such as message received</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, byte[], int, boolean)">publish</a></strong>(java.lang.String topic, | |
byte[] payload, | |
int qos, | |
boolean retained)</code> | |
<div class="block">Publishes a message to a topic on the server.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, byte[], int, boolean, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">publish</a></strong>(java.lang.String topic, | |
byte[] payload, | |
int qos, | |
boolean retained, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Publishes a message to a topic on the server.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)">publish</a></strong>(java.lang.String topic, | |
org.eclipse.paho.client.mqttv3.MqttMessage message)</code> | |
<div class="block">Publishes a message to a topic on the server.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttDeliveryToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">publish</a></strong>(java.lang.String topic, | |
org.eclipse.paho.client.mqttv3.MqttMessage message, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Publishes a message to a topic on the server.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#registerResources(Context)">registerResources</a></strong>(Context context)</code> | |
<div class="block">Register receiver to receiver intent from MqttService.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#setCallback(org.eclipse.paho.client.mqttv3.MqttCallback)">setCallback</a></strong>(org.eclipse.paho.client.mqttv3.MqttCallback callback)</code> | |
<div class="block">Sets a callback listener to use for events that happen asynchronously.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#setProtocolVersion(org.eclipse.paho.client.mqttv3.MqttProtocolVersion)">setProtocolVersion</a></strong>(org.eclipse.paho.client.mqttv3.MqttProtocolVersion version)</code> </td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#setTraceCallback(org.eclipse.paho.android.service.MqttTraceHandler)">setTraceCallback</a></strong>(<a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a> traceCallback)</code> | |
<div class="block">identify the callback to be invoked when making tracing calls back into | |
the Activity</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#setTraceEnabled(boolean)">setTraceEnabled</a></strong>(boolean traceEnabled)</code> | |
<div class="block">turn tracing on and off</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String[], int[])">subscribe</a></strong>(java.lang.String[] topic, | |
int[] qos)</code> | |
<div class="block">Subscribe to multiple topics, each of which may include wildcards.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String[], int[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">subscribe</a></strong>(java.lang.String[] topic, | |
int[] qos, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Subscribes to multiple topics, each of which may include wildcards.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String, int)">subscribe</a></strong>(java.lang.String topic, | |
int qos)</code> | |
<div class="block">Subscribe to a topic, which may include wildcards.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String, int, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">subscribe</a></strong>(java.lang.String topic, | |
int qos, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Subscribe to a topic, which may include wildcards.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>void</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unregisterResources()">unregisterResources</a></strong>()</code> | |
<div class="block">Unregister receiver which receives intent from MqttService avoids IntentReceiver | |
leaks.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String)">unsubscribe</a></strong>(java.lang.String topic)</code> | |
<div class="block">Requests the server unsubscribe the client from a topic.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String[])">unsubscribe</a></strong>(java.lang.String[] topic)</code> | |
<div class="block">Requests the server unsubscribe the client from one or more topics.</div> | |
</td> | |
</tr> | |
<tr class="altColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">unsubscribe</a></strong>(java.lang.String[] topic, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Requests the server unsubscribe the client from one or more topics.</div> | |
</td> | |
</tr> | |
<tr class="rowColor"> | |
<td class="colFirst"><code>org.eclipse.paho.client.mqttv3.IMqttToken</code></td> | |
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)">unsubscribe</a></strong>(java.lang.String topic, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback)</code> | |
<div class="block">Requests the server unsubscribe the client from a topics.</div> | |
</td> | |
</tr> | |
</table> | |
<ul class="blockList"> | |
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> | |
<!-- --> | |
</a> | |
<h3>Methods inherited from class java.lang.Object</h3> | |
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> | |
</ul> | |
</li> | |
</ul> | |
</li> | |
</ul> | |
</div> | |
<div class="details"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<!-- ============ FIELD DETAIL =========== --> | |
<ul class="blockList"> | |
<li class="blockList"><a name="field_detail"> | |
<!-- --> | |
</a> | |
<h3>Field Detail</h3> | |
<a name="myContext"> | |
<!-- --> | |
</a> | |
<ul class="blockListLast"> | |
<li class="blockList"> | |
<h4>myContext</h4> | |
<pre>Context myContext</pre> | |
</li> | |
</ul> | |
</li> | |
</ul> | |
<!-- ========= CONSTRUCTOR DETAIL ======== --> | |
<ul class="blockList"> | |
<li class="blockList"><a name="constructor_detail"> | |
<!-- --> | |
</a> | |
<h3>Constructor Detail</h3> | |
<a name="MqttAndroidClient(Context, java.lang.String, java.lang.String)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>MqttAndroidClient</h4> | |
<pre>public MqttAndroidClient(Context context, | |
java.lang.String serverURI, | |
java.lang.String clientId)</pre> | |
<div class="block">Constructor - create an MqttAndroidClient that can be used to communicate with an MQTT server on android</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - object used to pass context to the callback.</dd><dd><code>serverURI</code> - specifies the protocol, host name and port to be used to | |
connect to an MQTT server</dd><dd><code>clientId</code> - specifies the name by which this connection should be | |
identified to the server</dd></dl> | |
</li> | |
</ul> | |
<a name="MqttAndroidClient(Context, java.lang.String, java.lang.String, org.eclipse.paho.android.service.MqttAndroidClient.Ack)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>MqttAndroidClient</h4> | |
<pre>public MqttAndroidClient(Context ctx, | |
java.lang.String serverURI, | |
java.lang.String clientId, | |
<a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service">MqttAndroidClient.Ack</a> ackType)</pre> | |
<div class="block">Constructor - create an MqttAndroidClient that can be used to communicate with an MQTT server on android</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctx</code> - Application's context</dd><dd><code>serverURI</code> - specifies the protocol, host name and port to be used to connect to an MQTT server</dd><dd><code>clientId</code> - specifies the name by which this connection should be identified to the server</dd><dd><code>ackType</code> - how the application wishes to acknowledge a message has been processed</dd></dl> | |
</li> | |
</ul> | |
<a name="MqttAndroidClient(Context, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>MqttAndroidClient</h4> | |
<pre>public MqttAndroidClient(Context ctx, | |
java.lang.String serverURI, | |
java.lang.String clientId, | |
org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence)</pre> | |
<div class="block">Constructor - create an MqttAndroidClient that can be used to communicate with an MQTT server on android</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctx</code> - Application's context</dd><dd><code>serverURI</code> - specifies the protocol, host name and port to be used to connect to an MQTT server</dd><dd><code>clientId</code> - specifies the name by which this connection should be identified to the server</dd><dd><code>persistence</code> - The object to use to store persisted data</dd></dl> | |
</li> | |
</ul> | |
<a name="MqttAndroidClient(Context, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence, org.eclipse.paho.android.service.MqttAndroidClient.Ack)"> | |
<!-- --> | |
</a> | |
<ul class="blockListLast"> | |
<li class="blockList"> | |
<h4>MqttAndroidClient</h4> | |
<pre>public MqttAndroidClient(Context context, | |
java.lang.String serverURI, | |
java.lang.String clientId, | |
org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence, | |
<a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service">MqttAndroidClient.Ack</a> ackType)</pre> | |
<div class="block">constructor</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - used to pass context to the callback.</dd><dd><code>serverURI</code> - specifies the protocol, host name and port to be used to | |
connect to an MQTT server</dd><dd><code>clientId</code> - specifies the name by which this connection should be | |
identified to the server</dd><dd><code>persistence</code> - the persistence class to use to store in-flight message. If null then the | |
default persistence mechanism is used</dd><dd><code>ackType</code> - how the application wishes to acknowledge a message has been processed.</dd></dl> | |
</li> | |
</ul> | |
</li> | |
</ul> | |
<!-- ============ METHOD DETAIL ========== --> | |
<ul class="blockList"> | |
<li class="blockList"><a name="method_detail"> | |
<!-- --> | |
</a> | |
<h3>Method Detail</h3> | |
<a name="isConnected()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>isConnected</h4> | |
<pre>public boolean isConnected()</pre> | |
<div class="block">Determines if this client is currently connected to the server.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>isConnected</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if connected, <code>false</code> otherwise.</dd></dl> | |
</li> | |
</ul> | |
<a name="getClientId()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getClientId</h4> | |
<pre>public java.lang.String getClientId()</pre> | |
<div class="block">Returns the client ID used by this client. | |
<p>All clients connected to the | |
same server or server farm must have a unique ID. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>getClientId</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Returns:</span></dt><dd>the client ID used by this client.</dd></dl> | |
</li> | |
</ul> | |
<a name="getServerURI()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getServerURI</h4> | |
<pre>public java.lang.String getServerURI()</pre> | |
<div class="block">Returns the URI address of the server used by this client. | |
<p>The format of the returned String is the same as that used on the constructor.</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>getServerURI</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Returns:</span></dt><dd>the server's address, as a URI String.</dd></dl> | |
</li> | |
</ul> | |
<a name="close()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>close</h4> | |
<pre>public void close()</pre> | |
<div class="block">Close the client | |
Releases all resource associated with the client. After the client has | |
been closed it cannot be reused. For instance attempts to connect will fail.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>close</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if the client is not disconnected.</dd></dl> | |
</li> | |
</ul> | |
<a name="connect()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>connect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken connect() | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Connects to an MQTT server using the default options. | |
<p>The default options are specified in <code>MqttConnectOptions</code> class. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>connect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the connect to complete. The token | |
will be passed to the callback methods if a callback is set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for any connected problems</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>connect(MqttConnectOptions, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>connect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions options) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Connects to an MQTT server using the provided connect options. | |
<p>The connection will be established using the options specified in the | |
<code>MqttConnectOptions</code> parameter. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>connect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - a set of connection parameters that override the defaults.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the connect to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for any connected problems</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>connect(MqttConnectOptions, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="connect(java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>connect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken connect(java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Connects to an MQTT server using the default options. | |
<p>The default options are specified in <code>MqttConnectOptions</code> class. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>connect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when the connect completes. Use | |
null if not required.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the connect to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for any connected problems</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>connect(MqttConnectOptions, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>connect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions options, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Connects to an MQTT server using the specified options. | |
<p>The server to connect to is specified on the constructor. | |
It is recommended to call <a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#setCallback(org.eclipse.paho.client.mqttv3.MqttCallback)"><code>setCallback(MqttCallback)</code></a> prior to | |
connecting in order that messages destined for the client can be accepted | |
as soon as the client is connected. | |
</p> | |
<p>The method returns control before the connect completes. Completion can | |
be tracked by: | |
<ul> | |
<li>Waiting on the returned token <code>IMqttToken.waitForCompletion()</code> or</li> | |
<li>Passing in a callback <code>IMqttActionListener</code></li> | |
</ul> | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>connect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - a set of connection parameters that override the defaults.</dd><dd><code>userContext</code> - optional object for used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when the connect completes. Use | |
null if not required.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the connect to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for any connected problems, including communication errors</dd></dl> | |
</li> | |
</ul> | |
<a name="disconnect()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken disconnect() | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Disconnects from the server. | |
<p>An attempt is made to quiesce the client allowing outstanding | |
work to complete before disconnecting. It will wait | |
for a maximum of 30 seconds for work to quiesce before disconnecting. | |
This method must not be called from inside <code>MqttCallback</code> methods. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for disconnect to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for problems encountered while disconnecting</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect(long, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>disconnect(long, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="disconnect(long)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken disconnect(long quiesceTimeout) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Disconnects from the server. | |
<p>An attempt is made to quiesce the client allowing outstanding | |
work to complete before disconnecting. It will wait | |
for a maximum of the specified quiesce time for work to complete before disconnecting. | |
This method must not be called from inside <code>MqttCallback</code> methods. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>quiesceTimeout</code> - the amount of time in milliseconds to allow for | |
existing work to finish before disconnecting. A value of zero or less | |
means the client will not quiesce.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for disconnect to complete. The token | |
will be passed to the callback methods if a callback is set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for problems encountered while disconnecting</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect(long, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>disconnect(long, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="disconnect(java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken disconnect(java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Disconnects from the server. | |
<p>An attempt is made to quiesce the client allowing outstanding | |
work to complete before disconnecting. It will wait | |
for a maximum of 30 seconds for work to quiesce before disconnecting. | |
This method must not be called from inside <code>MqttCallback</code> methods. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when the disconnect completes. Use | |
null if not required.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the disconnect to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for problems encountered while disconnecting</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#disconnect(long, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>disconnect(long, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="disconnect(long, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnect</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken disconnect(long quiesceTimeout, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Disconnects from the server. | |
<p> | |
The client will wait for <code>MqttCallback</code> methods to | |
complete. It will then wait for up to the quiesce timeout to allow for | |
work which has already been initiated to complete. For instance when a QoS 2 | |
message has started flowing to the server but the QoS 2 flow has not completed.It | |
prevents new messages being accepted and does not send any messages that have | |
been accepted but not yet started delivery across the network to the server. When | |
work has completed or after the quiesce timeout, the client will disconnect from | |
the server. If the cleanSession flag was set to false and is set to false the | |
next time a connection is made QoS 1 and 2 messages that | |
were not previously delivered will be delivered.</p> | |
<p>This method must not be called from inside <code>MqttCallback</code> methods.</p> | |
<p>The method returns control before the disconnect completes. Completion can | |
be tracked by: | |
<ul> | |
<li>Waiting on the returned token <code>IMqttToken.waitForCompletion()</code> or</li> | |
<li>Passing in a callback <code>IMqttActionListener</code></li> | |
</ul> | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnect</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>quiesceTimeout</code> - the amount of time in milliseconds to allow for | |
existing work to finish before disconnecting. A value of zero or less | |
means the client will not quiesce.</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when the disconnect completes. Use | |
null if not required.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the connect to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for problems encountered while disconnecting</dd></dl> | |
</li> | |
</ul> | |
<a name="publish(java.lang.String, byte[], int, boolean)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>publish</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken publish(java.lang.String topic, | |
byte[] payload, | |
int qos, | |
boolean retained) | |
throws org.eclipse.paho.client.mqttv3.MqttException, | |
org.eclipse.paho.client.mqttv3.MqttPersistenceException</pre> | |
<div class="block">Publishes a message to a topic on the server. | |
<p>A convenience method, which will | |
create a new <code>MqttMessage</code> object with a byte array payload and the | |
specified QoS, and then publish it. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>publish</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - to deliver the message to, for example "finance/stock/ibm".</dd><dd><code>payload</code> - the byte array to use as the payload</dd><dd><code>qos</code> - the Quality of Service to deliver the message at. Valid values are 0, 1 or 2.</dd><dd><code>retained</code> - whether or not this message should be retained by the server.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the publish to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttPersistenceException</code> - when a problem occurs storing the message</dd> | |
<dd><code>java.lang.IllegalArgumentException</code> - if value of QoS is not 0, 1 or 2.</dd> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for other errors encountered while publishing the message. | |
For instance if too many messages are being processed.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>publish(String, MqttMessage, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>publish</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken publish(java.lang.String topic, | |
org.eclipse.paho.client.mqttv3.MqttMessage message) | |
throws org.eclipse.paho.client.mqttv3.MqttException, | |
org.eclipse.paho.client.mqttv3.MqttPersistenceException</pre> | |
<div class="block">Publishes a message to a topic on the server. | |
Takes an <code>MqttMessage</code> message and delivers it to the server at the | |
requested quality of service.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>publish</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - to deliver the message to, for example "finance/stock/ibm".</dd><dd><code>message</code> - to deliver to the server</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the publish to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttPersistenceException</code> - when a problem occurs storing the message</dd> | |
<dd><code>java.lang.IllegalArgumentException</code> - if value of QoS is not 0, 1 or 2.</dd> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for other errors encountered while publishing the message. | |
For instance client not connected.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>publish(String, MqttMessage, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="publish(java.lang.String, byte[], int, boolean, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>publish</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken publish(java.lang.String topic, | |
byte[] payload, | |
int qos, | |
boolean retained, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException, | |
org.eclipse.paho.client.mqttv3.MqttPersistenceException</pre> | |
<div class="block">Publishes a message to a topic on the server. | |
<p>A convenience method, which will | |
create a new <code>MqttMessage</code> object with a byte array payload and the | |
specified QoS, and then publish it. | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>publish</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - to deliver the message to, for example "finance/stock/ibm".</dd><dd><code>payload</code> - the byte array to use as the payload</dd><dd><code>qos</code> - the Quality of Service to deliver the message at. Valid values are 0, 1 or 2.</dd><dd><code>retained</code> - whether or not this message should be retained by the server.</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when message delivery | |
hsa completed to the requested quality of service</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the publish to complete. The token | |
will be passed to any callback that has been set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttPersistenceException</code> - when a problem occurs storing the message</dd> | |
<dd><code>java.lang.IllegalArgumentException</code> - if value of QoS is not 0, 1 or 2.</dd> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for other errors encountered while publishing the message. | |
For instance client not connected.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>publish(String, MqttMessage, Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>publish</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken publish(java.lang.String topic, | |
org.eclipse.paho.client.mqttv3.MqttMessage message, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException, | |
org.eclipse.paho.client.mqttv3.MqttPersistenceException</pre> | |
<div class="block">Publishes a message to a topic on the server. | |
<p> | |
Once this method has returned cleanly, the message has been accepted for publication by the | |
client and will be delivered on a background thread. | |
In the event the connection fails or the client stops. Messages will be delivered to the | |
requested quality of service once the connection is re-established to the server on condition that: | |
<ul> | |
<li>The connection is re-established with the same clientID | |
<li>The original connection was made with (@link MqttConnectOptions#setCleanSession(boolean)} | |
set to false | |
<li>The connection is re-established with (@link MqttConnectOptions#setCleanSession(boolean)} | |
set to false | |
<li>Depending when the failure occurs QoS 0 messages may not be delivered. | |
</ul> | |
</p> | |
<p>When building an application, | |
the design of the topic tree should take into account the following principles | |
of topic name syntax and semantics:</p> | |
<ul> | |
<li>A topic must be at least one character long.</li> | |
<li>Topic names are case sensitive. For example, <em>ACCOUNTS</em> and <em>Accounts</em> are | |
two different topics.</li> | |
<li>Topic names can include the space character. For example, <em>Accounts | |
payable</em> is a valid topic.</li> | |
<li>A leading "/" creates a distinct topic. For example, <em>/finance</em> is | |
different from <em>finance</em>. <em>/finance</em> matches "+/+" and "/+", but | |
not "+".</li> | |
<li>Do not include the null character (Unicode <samp class="codeph">\x0000</samp>) in | |
any topic.</li> | |
</ul> | |
<p>The following principles apply to the construction and content of a topic | |
tree:</p> | |
<ul> | |
<li>The length is limited to 64k but within that there are no limits to the | |
number of levels in a topic tree.</li> | |
<li>There can be any number of root nodes; that is, there can be any number | |
of topic trees.</li> | |
</ul> | |
</p> | |
<p>The method returns control before the publish completes. Completion can | |
be tracked by: | |
<ul> | |
<li>Setting an <code>IMqttAsyncClient.setCallback(MqttCallback)</code> where the | |
<code>MqttCallback.deliveryComplete(IMqttDeliveryToken)</code> | |
method will be called.</li> | |
<li>Waiting on the returned token <code>MqttToken.waitForCompletion()</code> or</li> | |
<li>Passing in a callback <code>IMqttActionListener</code> to this method</li> | |
</ul> | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>publish</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - to deliver the message to, for example "finance/stock/ibm".</dd><dd><code>message</code> - to deliver to the server</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when message delivery | |
has completed to the requested quality of service</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the publish to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttPersistenceException</code> - when a problem occurs storing the message</dd> | |
<dd><code>java.lang.IllegalArgumentException</code> - if value of QoS is not 0, 1 or 2.</dd> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for other errors encountered while publishing the message. | |
For instance client not connected.</dd><dt><span class="strong">See Also:</span></dt><dd><code>MqttMessage</code></dd></dl> | |
</li> | |
</ul> | |
<a name="subscribe(java.lang.String, int)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>subscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken subscribe(java.lang.String topic, | |
int qos) | |
throws org.eclipse.paho.client.mqttv3.MqttException, | |
org.eclipse.paho.client.mqttv3.MqttSecurityException</pre> | |
<div class="block">Subscribe to a topic, which may include wildcards.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>subscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic to subscribe to, which can include wildcards.</dd><dd><code>qos</code> - the maximum quality of service at which to subscribe. Messages | |
published at a lower quality of service will be received at the published | |
QoS. Messages published at a higher quality of service will be received using | |
the QoS specified on the subscribe.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the subscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttSecurityException</code> - for security related problems</dd> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for non security related problems</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String[], int[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>subscribe(String[], int[], Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="subscribe(java.lang.String[], int[])"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>subscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken subscribe(java.lang.String[] topic, | |
int[] qos) | |
throws org.eclipse.paho.client.mqttv3.MqttException, | |
org.eclipse.paho.client.mqttv3.MqttSecurityException</pre> | |
<div class="block">Subscribe to multiple topics, each of which may include wildcards. | |
<p>Provides an optimized way to subscribe to multiple topics compared to | |
subscribing to each one individually.</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>subscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - one or more topics to subscribe to, which can include wildcards</dd><dd><code>qos</code> - the maximum quality of service at which to subscribe. Messages | |
published at a lower quality of service will be received at the published | |
QoS. Messages published at a higher quality of service will be received using | |
the QoS specified on the subscribe.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the subscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttSecurityException</code> - for security related problems</dd> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - for non security related problems</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String[], int[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>subscribe(String[], int[], Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="subscribe(java.lang.String, int, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>subscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken subscribe(java.lang.String topic, | |
int qos, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Subscribe to a topic, which may include wildcards.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>subscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic to subscribe to, which can include wildcards.</dd><dd><code>qos</code> - the maximum quality of service at which to subscribe. Messages | |
published at a lower quality of service will be received at the published | |
QoS. Messages published at a higher quality of service will be received using | |
the QoS specified on the subscribe.</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when subscribe | |
has completed</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the subscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if there was an error registering the subscription.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#subscribe(java.lang.String[], int[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>subscribe(String[], int[], Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="subscribe(java.lang.String[], int[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>subscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken subscribe(java.lang.String[] topic, | |
int[] qos, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Subscribes to multiple topics, each of which may include wildcards. | |
<p>Provides an optimized way to subscribe to multiple topics compared to | |
subscribing to each one individually.</p> | |
<p>The <a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#setCallback(org.eclipse.paho.client.mqttv3.MqttCallback)"><code>setCallback(MqttCallback)</code></a> method | |
should be called before this method, otherwise any received messages | |
will be discarded. | |
</p> | |
<p> | |
If (@link MqttConnectOptions#setCleanSession(boolean)} was set to true | |
when when connecting to the server then the subscription remains in place | |
until either: | |
<ul> | |
<li>The client disconnects</li> | |
<li>An unsubscribe method is called to un-subscribe the topic</li> | |
</li> | |
</p> | |
<p> | |
If (@link MqttConnectOptions#setCleanSession(boolean)} was set to false | |
when connecting to the server then the subscription remains in place | |
until either: | |
<ul> | |
<li>An unsubscribe method is called to unsubscribe the topic</li> | |
<li>The next time the client connects with cleanSession set to true</ul> | |
</li> | |
With cleanSession set to false the MQTT server will store messages on | |
behalf of the client when the client is not connected. The next time the | |
client connects with the <bold>same client ID</bold> the server will | |
deliver the stored messages to the client. | |
</p> | |
<p>The "topic filter" string used when subscribing | |
may contain special characters, which allow you to subscribe to multiple topics | |
at once.</p> | |
<p>The topic level separator is used to introduce structure into the topic, and | |
can therefore be specified within the topic for that purpose. The multi-level | |
wildcard and single-level wildcard can be used for subscriptions, but they | |
cannot be used within a topic by the publisher of a message. | |
<dl> | |
<dt>Topic level separator</dt> | |
<dd>The forward slash (/) is used to separate each level within | |
a topic tree and provide a hierarchical structure to the topic space. The | |
use of the topic level separator is significant when the two wildcard characters | |
are encountered in topics specified by subscribers.</dd> | |
<dt>Multi-level wildcard</dt> | |
<dd><p>The number sign (#) is a wildcard character that matches | |
any number of levels within a topic. For example, if you subscribe to | |
<span><span class="filepath">finance/stock/ibm/#</span></span>, you receive | |
messages on these topics: | |
<pre> finance/stock/ibm<br /> finance/stock/ibm/closingprice<br /> finance/stock/ibm/currentprice</pre> | |
</p> | |
<p>The multi-level wildcard | |
can represent zero or more levels. Therefore, <em>finance/#</em> can also match | |
the singular <em>finance</em>, where <em>#</em> represents zero levels. The topic | |
level separator is meaningless in this context, because there are no levels | |
to separate.</p> | |
<p>The <span>multi-level</span> wildcard can | |
be specified only on its own or next to the topic level separator character. | |
Therefore, <em>#</em> and <em>finance/#</em> are both valid, but <em>finance#</em> is | |
not valid. <span>The multi-level wildcard must be the last character | |
used within the topic tree. For example, <em>finance/#</em> is valid but | |
<em>finance/#/closingprice</em> is not valid.</span></p></dd> | |
<dt>Single-level wildcard</dt> | |
<dd><p>The plus sign (+) is a wildcard character that matches only one topic | |
level. For example, <em>finance/stock/+</em> matches | |
<em>finance/stock/ibm</em> and <em>finance/stock/xyz</em>, | |
but not <em>finance/stock/ibm/closingprice</em>. Also, because the single-level | |
wildcard matches only a single level, <em>finance/+</em> does not match <em>finance</em>.</p> | |
<p>Use | |
the single-level wildcard at any level in the topic tree, and in conjunction | |
with the multilevel wildcard. Specify the single-level wildcard next to the | |
topic level separator, except when it is specified on its own. Therefore, | |
<em>+</em> and <em>finance/+</em> are both valid, but <em>finance+</em> is | |
not valid. <span>The single-level wildcard can be used at the end of the | |
topic tree or within the topic tree. | |
For example, <em>finance/+</em> and <em>finance/+/ibm</em> are both valid.</span></p> | |
</dd> | |
</dl> | |
</p> | |
<p>The method returns control before the subscribe completes. Completion can | |
be tracked by: | |
<ul> | |
<li>Waiting on the supplied token <code>MqttToken.waitForCompletion()</code> or</li> | |
<li>Passing in a callback <code>IMqttActionListener</code> to this method</li> | |
</ul> | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>subscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - one or more topics to subscribe to, which can include wildcards</dd><dd><code>qos</code> - the maximum quality of service to subscribe each topic at.Messages | |
published at a lower quality of service will be received at the published | |
QoS. Messages published at a higher quality of service will be received using | |
the QoS specified on the subscribe.</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when subscribe | |
has completed</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the subscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if there was an error registering the subscription.</dd> | |
<dd><code>java.lang.IllegalArgumentException</code> - if the two supplied arrays are not the same size.</dd></dl> | |
</li> | |
</ul> | |
<a name="unsubscribe(java.lang.String)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>unsubscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken unsubscribe(java.lang.String topic) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Requests the server unsubscribe the client from a topic.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>unsubscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic to unsubscribe from. It must match a topic | |
specified on an earlier subscribe.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the unsubscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if there was an error unregistering the subscription.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>unsubscribe(String[], Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="unsubscribe(java.lang.String[])"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>unsubscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken unsubscribe(java.lang.String[] topic) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Requests the server unsubscribe the client from one or more topics.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>unsubscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - one or more topics to unsubscribe from. Each topic | |
must match one specified on an earlier subscribe.</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the unsubscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if there was an error unregistering the subscription.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>unsubscribe(String[], Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="unsubscribe(java.lang.String, java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>unsubscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken unsubscribe(java.lang.String topic, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Requests the server unsubscribe the client from a topics.</div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>unsubscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic to unsubscribe from. It must match a topic | |
specified on an earlier subscribe.</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when unsubscribe | |
has completed</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the unsubscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if there was an error unregistering the subscription.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.html#unsubscribe(java.lang.String[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"><code>unsubscribe(String[], Object, IMqttActionListener)</code></a></dd></dl> | |
</li> | |
</ul> | |
<a name="unsubscribe(java.lang.String[], java.lang.Object, org.eclipse.paho.client.mqttv3.IMqttActionListener)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>unsubscribe</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttToken unsubscribe(java.lang.String[] topic, | |
java.lang.Object userContext, | |
org.eclipse.paho.client.mqttv3.IMqttActionListener callback) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<div class="block">Requests the server unsubscribe the client from one or more topics. | |
<p> | |
Unsubcribing is the opposite of subscribing. When the server receives the | |
unsubscribe request it looks to see if it can find a matching subscription for the | |
client and then removes it. After this point the server will send no more | |
messages to the client for this subscription. | |
</p> | |
<p>The topic(s) specified on the unsubscribe must match the topic(s) | |
specified in the original subscribe request for the unsubscribe to succeed | |
</p> | |
<p>The method returns control before the unsubscribe completes. Completion can | |
be tracked by: | |
<ul> | |
<li>Waiting on the returned token <code>MqttToken.waitForCompletion()</code> or</li> | |
<li>Passing in a callback <code>IMqttActionListener</code> to this method</li> | |
</ul> | |
</p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>unsubscribe</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - one or more topics to unsubscribe from. Each topic | |
must match one specified on an earlier subscribe.</dd><dd><code>userContext</code> - optional object used to pass context to the callback. Use | |
null if not required.</dd><dd><code>callback</code> - optional listener that will be notified when unsubscribe | |
has completed</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>token used to track and wait for the unsubscribe to complete. The token | |
will be passed to callback methods if set.</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code> - if there was an error unregistering the subscription.</dd></dl> | |
</li> | |
</ul> | |
<a name="getPendingDeliveryTokens()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getPendingDeliveryTokens</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken[] getPendingDeliveryTokens()</pre> | |
<div class="block">Returns the delivery tokens for any outstanding publish operations. | |
<p>If a client has been restarted and there are messages that were in the | |
process of being delivered when the client stopped this method | |
returns a token for each in-flight message enabling the delivery to be tracked | |
Alternately the <code>MqttCallback.deliveryComplete(IMqttDeliveryToken)</code> | |
callback can be used to track the delivery of outstanding messages. | |
</p> | |
<p>If a client connects with cleanSession true then there will be no | |
delivery tokens as the cleanSession option deletes all earlier state. | |
For state to be remembered the client must connect with cleanSession | |
set to false</P></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>getPendingDeliveryTokens</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Returns:</span></dt><dd>zero or more delivery tokens</dd></dl> | |
</li> | |
</ul> | |
<a name="setCallback(org.eclipse.paho.client.mqttv3.MqttCallback)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>setCallback</h4> | |
<pre>public void setCallback(org.eclipse.paho.client.mqttv3.MqttCallback callback)</pre> | |
<div class="block">Sets a callback listener to use for events that happen asynchronously. | |
<p>There are a number of events that the listener will be notified about. | |
These include: | |
<ul> | |
<li>A new message has arrived and is ready to be processed</li> | |
<li>The connection to the server has been lost</li> | |
<li>Delivery of a message to the server has completed</li> | |
</ul> | |
</p> | |
<p>Other events that track the progress of an individual operation such | |
as connect and subscribe can be tracked using the <code>MqttToken</code> returned from | |
each non-blocking method or using setting a <code>IMqttActionListener</code> on the | |
non-blocking method.<p></div> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>setCallback</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Parameters:</span></dt><dd><code>callback</code> - which will be invoked for certain asynchronous events</dd><dt><span class="strong">See Also:</span></dt><dd><code>MqttCallback</code></dd></dl> | |
</li> | |
</ul> | |
<a name="setTraceCallback(org.eclipse.paho.android.service.MqttTraceHandler)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>setTraceCallback</h4> | |
<pre>public void setTraceCallback(<a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a> traceCallback)</pre> | |
<div class="block">identify the callback to be invoked when making tracing calls back into | |
the Activity</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>traceCallback</code> - handler</dd></dl> | |
</li> | |
</ul> | |
<a name="setTraceEnabled(boolean)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>setTraceEnabled</h4> | |
<pre>public void setTraceEnabled(boolean traceEnabled)</pre> | |
<div class="block">turn tracing on and off</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>traceEnabled</code> - set <code>true</code> to enable trace, otherwise, set <code>false</code> to disable trace</dd></dl> | |
</li> | |
</ul> | |
<a name="onReceive(Context, Intent)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>onReceive</h4> | |
<pre>public void onReceive(Context context, | |
Intent intent)</pre> | |
<div class="block"><p> | |
Process incoming Intent objects representing the results of operations | |
and asynchronous activities such as message received | |
</p> | |
<p> | |
<strong>Note:</strong> This is only a public method because the Android | |
APIs require such.<br> | |
This method should not be explicitly invoked. | |
</p></div> | |
</li> | |
</ul> | |
<a name="acknowledgeMessage(java.lang.String)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>acknowledgeMessage</h4> | |
<pre>public boolean acknowledgeMessage(java.lang.String messageId)</pre> | |
<div class="block">Acknowledges a message received on the <code>MqttCallback.messageArrived(String, MqttMessage)</code></div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messageId</code> - the messageId received from the MqttMessage (To access this field you need to cast <code>MqttMessage</code> to <a href="../../../../../org/eclipse/paho/android/service/ParcelableMqttMessage.html" title="class in org.eclipse.paho.android.service"><code>ParcelableMqttMessage</code></a>)</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>whether or not the message was successfully acknowledged</dd></dl> | |
</li> | |
</ul> | |
<a name="getSSLSocketFactory(java.io.InputStream, java.lang.String)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getSSLSocketFactory</h4> | |
<pre>public javax.net.ssl.SSLSocketFactory getSSLSocketFactory(java.io.InputStream keyStore, | |
java.lang.String password) | |
throws org.eclipse.paho.client.mqttv3.MqttSecurityException</pre> | |
<div class="block">Get the SSLSocketFactory using SSL key store and password | |
<p>A convenience method, which will help user to create a SSLSocketFactory object</p></div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyStore</code> - the SSL key store which is generated by some SSL key tool, such as keytool in Java JDK</dd><dd><code>password</code> - the password of the key store which is set when the key store is generated</dd> | |
<dt><span class="strong">Returns:</span></dt><dd>SSLSocketFactory used to connect to the server with SSL authentication</dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttSecurityException</code> - if there was any error when getting the SSLSocketFactory</dd></dl> | |
</li> | |
</ul> | |
<a name="disconnectForcibly()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnectForcibly</h4> | |
<pre>public void disconnectForcibly() | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnectForcibly</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd></dl> | |
</li> | |
</ul> | |
<a name="disconnectForcibly(long)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnectForcibly</h4> | |
<pre>public void disconnectForcibly(long disconnectTimeout) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnectForcibly</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd></dl> | |
</li> | |
</ul> | |
<a name="disconnectForcibly(long, long)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>disconnectForcibly</h4> | |
<pre>public void disconnectForcibly(long quiesceTimeout, | |
long disconnectTimeout) | |
throws org.eclipse.paho.client.mqttv3.MqttException</pre> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>disconnectForcibly</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
<dt><span class="strong">Throws:</span></dt> | |
<dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd></dl> | |
</li> | |
</ul> | |
<a name="getProtocolVersion()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>getProtocolVersion</h4> | |
<pre>public org.eclipse.paho.client.mqttv3.MqttProtocolVersion getProtocolVersion()</pre> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>getProtocolVersion</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="setProtocolVersion(org.eclipse.paho.client.mqttv3.MqttProtocolVersion)"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>setProtocolVersion</h4> | |
<pre>public void setProtocolVersion(org.eclipse.paho.client.mqttv3.MqttProtocolVersion version)</pre> | |
<dl> | |
<dt><strong>Specified by:</strong></dt> | |
<dd><code>setProtocolVersion</code> in interface <code>org.eclipse.paho.client.mqttv3.IMqttAsyncClient</code></dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="unregisterResources()"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>unregisterResources</h4> | |
<pre>public void unregisterResources()</pre> | |
<div class="block">Unregister receiver which receives intent from MqttService avoids IntentReceiver | |
leaks.</div> | |
</li> | |
</ul> | |
<a name="registerResources(Context)"> | |
<!-- --> | |
</a> | |
<ul class="blockListLast"> | |
<li class="blockList"> | |
<h4>registerResources</h4> | |
<pre>public void registerResources(Context context)</pre> | |
<div class="block">Register receiver to receiver intent from MqttService. Call this method when activity | |
is hidden and become to show again.</div> | |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - - Current activity context.</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/MqttAndroidClient.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/MessageStore.StoredMessage.html" title="interface in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li> | |
<li><a href="../../../../../org/eclipse/paho/android/service/MqttAndroidClient.Ack.html" title="enum 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/MqttAndroidClient.html" target="_top">Frames</a></li> | |
<li><a href="MqttAndroidClient.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><a href="#field_summary">Field</a> | </li> | |
<li><a href="#constructor_summary">Constr</a> | </li> | |
<li><a href="#method_summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li><a href="#field_detail">Field</a> | </li> | |
<li><a href="#constructor_detail">Constr</a> | </li> | |
<li><a href="#method_detail">Method</a></li> | |
</ul> | |
</div> | |
<a name="skip-navbar_bottom"> | |
<!-- --> | |
</a></div> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
</body> | |
</html> |