new/paho/files/android-javadoc/org/eclipse/paho/android/service/MqttConnection.html - gerrit/www.eclipse.org/paho - Git at Google

 <!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>MqttConnection</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="MqttConnection";
     }
 //-->
 </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/MqttConnection.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/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../../../org/eclipse/paho/android/service/MqttDeliveryTokenAndroid.html" title="class in org.eclipse.paho.android.service"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/eclipse/paho/android/service/MqttConnection.html" target="_top">Frames</a></li>
 <li><a href="MqttConnection.html" target="_top">No Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_detail">Method</a></li>
 </ul>
 </div>
 <a name="skip-navbar_top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.eclipse.paho.android.service</div>
 <h2 title="Class MqttConnection" class="title">Class MqttConnection</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>org.eclipse.paho.android.service.MqttConnection</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.MqttCallback</dd>
 </dl>
 <hr>
 <br>
 <pre> class <span class="strong">MqttConnection</span>
 extends java.lang.Object
 implements org.eclipse.paho.client.mqttv3.MqttCallback</pre>
 <div class="block"><p>
  MqttConnection holds a MqttAsyncClient {host,port,clientId} instance to perform
  MQTT operations to MQTT broker.
  </p>
  <p>
  Most of the major API here is intended to implement the most general forms of
  the methods in IMqttAsyncClient, with slight adjustments for the Android
  environment<br>
  These adjustments usually consist of adding two parameters to each method :-
  <ul>
  <li>invocationContext - a string passed from the application to identify the
  context of the operation (mainly included for support of the javascript API
  implementation)</li>
  <li>activityToken - a string passed from the Activity to relate back to a
  callback method or other context-specific data</li>
  </ul>
  </p>
  <p>
  Operations are very much asynchronous, so success and failure are notified by
  packing the relevant data into Intent objects which are broadcast back to the
  Activity via the MqttService.callbackToActivity() method.
  </p></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor_summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#MqttConnection(org.eclipse.paho.android.service.MqttService, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence, java.lang.String)">MqttConnection</a></strong>(<a href="../../../../../org/eclipse/paho/android/service/MqttService.html" title="class in org.eclipse.paho.android.service">MqttService</a>&nbsp;service,
               java.lang.String&nbsp;serverURI,
               java.lang.String&nbsp;clientId,
               org.eclipse.paho.client.mqttv3.MqttClientPersistence&nbsp;persistence,
               java.lang.String&nbsp;clientHandle)</code>
 <div class="block">Constructor - create an MqttConnection to communicate with MQTT server</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">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#close()">close</a></strong>()</code>
 <div class="block">Close connection from 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/MqttConnection.html#connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.String, java.lang.String)">connect</a></strong>(org.eclipse.paho.client.mqttv3.MqttConnectOptions&nbsp;options,
        java.lang.String&nbsp;invocationContext,
        java.lang.String&nbsp;activityToken)</code>
 <div class="block">Connect to the server specified when we were instantiated</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/MqttConnection.html#connectionLost(java.lang.Throwable)">connectionLost</a></strong>(java.lang.Throwable&nbsp;why)</code>
 <div class="block">Callback for connectionLost</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/MqttConnection.html#deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken)">deliveryComplete</a></strong>(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken&nbsp;messageToken)</code>
 <div class="block">Callback to indicate a message has been delivered (the exact meaning of
  "has been delivered" is dependent on the QOS value)</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#disconnect(long, java.lang.String, java.lang.String)">disconnect</a></strong>(long&nbsp;quiesceTimeout,
           java.lang.String&nbsp;invocationContext,
           java.lang.String&nbsp;activityToken)</code>
 <div class="block">Disconnect from the server</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#disconnect(java.lang.String, java.lang.String)">disconnect</a></strong>(java.lang.String&nbsp;invocationContext,
           java.lang.String&nbsp;activityToken)</code>
 <div class="block">Disconnect from 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/MqttConnection.html#getPendingDeliveryTokens()">getPendingDeliveryTokens</a></strong>()</code>
 <div class="block">Get tokens for all outstanding deliveries for a client</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#isConnected()">isConnected</a></strong>()</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#messageArrived(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)">messageArrived</a></strong>(java.lang.String&nbsp;topic,
               org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message)</code>
 <div class="block">Callback when a message is received</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#offline()">offline</a></strong>()</code>
 <div class="block">Receive notification that we are offline<br>
  if cleanSession is true, we need to regard this as a disconnection</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/MqttConnection.html#publish(java.lang.String, byte[], int, boolean, java.lang.String, java.lang.String)">publish</a></strong>(java.lang.String&nbsp;topic,
        byte[]&nbsp;payload,
        int&nbsp;qos,
        boolean&nbsp;retained,
        java.lang.String&nbsp;invocationContext,
        java.lang.String&nbsp;activityToken)</code>
 <div class="block">Publish a message on a topic</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/MqttConnection.html#publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.String, java.lang.String)">publish</a></strong>(java.lang.String&nbsp;topic,
        org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message,
        java.lang.String&nbsp;invocationContext,
        java.lang.String&nbsp;activityToken)</code>
 <div class="block">Publish a message on a topic</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#reconnect()">reconnect</a></strong>()</code>
 <div class="block">Reconnect<br>
  Only appropriate if cleanSession is false and we were connected
  Declare as synchronized to avoid multiple calls to this method to send connect
  multiple times</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#setConnectingState(boolean)">setConnectingState</a></strong>(boolean&nbsp;isConnecting)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#subscribe(java.lang.String[], int[], java.lang.String, java.lang.String)">subscribe</a></strong>(java.lang.String[]&nbsp;topic,
          int[]&nbsp;qos,
          java.lang.String&nbsp;invocationContext,
          java.lang.String&nbsp;activityToken)</code>
 <div class="block">Subscribe to one or more topics</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/MqttConnection.html#subscribe(java.lang.String, int, java.lang.String, java.lang.String)">subscribe</a></strong>(java.lang.String&nbsp;topic,
          int&nbsp;qos,
          java.lang.String&nbsp;invocationContext,
          java.lang.String&nbsp;activityToken)</code>
 <div class="block">Subscribe to a topic</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#unsubscribe(java.lang.String[], java.lang.String, java.lang.String)">unsubscribe</a></strong>(java.lang.String[]&nbsp;topic,
            java.lang.String&nbsp;invocationContext,
            java.lang.String&nbsp;activityToken)</code>
 <div class="block">Unsubscribe from one or more topics</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>(package private) void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttConnection.html#unsubscribe(java.lang.String, java.lang.String, java.lang.String)">unsubscribe</a></strong>(java.lang.String&nbsp;topic,
            java.lang.String&nbsp;invocationContext,
            java.lang.String&nbsp;activityToken)</code>
 <div class="block">Unsubscribe from a topic</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&nbsp;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">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor_detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="MqttConnection(org.eclipse.paho.android.service.MqttService, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>MqttConnection</h4>
 <pre>MqttConnection(<a href="../../../../../org/eclipse/paho/android/service/MqttService.html" title="class in org.eclipse.paho.android.service">MqttService</a>&nbsp;service,
               java.lang.String&nbsp;serverURI,
               java.lang.String&nbsp;clientId,
               org.eclipse.paho.client.mqttv3.MqttClientPersistence&nbsp;persistence,
               java.lang.String&nbsp;clientHandle)</pre>
 <div class="block">Constructor - create an MqttConnection to communicate with MQTT server</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>service</code> - our "parent" service - we make callbacks to it</dd><dd><code>serverURI</code> - the URI of the MQTT server to which we will connect</dd><dd><code>clientId</code> - the name by which we will identify ourselves to the MQTT
             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>clientHandle</code> - the "handle" by which the activity will identify us</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="connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>connect</h4>
 <pre>public&nbsp;void&nbsp;connect(org.eclipse.paho.client.mqttv3.MqttConnectOptions&nbsp;options,
            java.lang.String&nbsp;invocationContext,
            java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Connect to the server specified when we were instantiated</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - timeout, etc</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary identifier to be passed back to the Activity</dd></dl>
 </li>
 </ul>
 <a name="close()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre>void&nbsp;close()</pre>
 <div class="block">Close connection from the server</div>
 </li>
 </ul>
 <a name="disconnect(long, java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>disconnect</h4>
 <pre>void&nbsp;disconnect(long&nbsp;quiesceTimeout,
               java.lang.String&nbsp;invocationContext,
               java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Disconnect from the server</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>quiesceTimeout</code> - in milliseconds</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary string to be passed back to the activity</dd></dl>
 </li>
 </ul>
 <a name="disconnect(java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>disconnect</h4>
 <pre>void&nbsp;disconnect(java.lang.String&nbsp;invocationContext,
               java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Disconnect from the server</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary string to be passed back to the activity</dd></dl>
 </li>
 </ul>
 <a name="isConnected()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isConnected</h4>
 <pre>public&nbsp;boolean&nbsp;isConnected()</pre>
 <dl><dt><span class="strong">Returns:</span></dt><dd>true if we are connected to an MQTT server</dd></dl>
 </li>
 </ul>
 <a name="publish(java.lang.String, byte[], int, boolean, java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>publish</h4>
 <pre>public&nbsp;org.eclipse.paho.client.mqttv3.IMqttDeliveryToken&nbsp;publish(java.lang.String&nbsp;topic,
                                                         byte[]&nbsp;payload,
                                                         int&nbsp;qos,
                                                         boolean&nbsp;retained,
                                                         java.lang.String&nbsp;invocationContext,
                                                         java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Publish a message on a topic</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic on which to publish - represented as a string, not
             an MqttTopic object</dd><dd><code>payload</code> - the content of the message to publish</dd><dd><code>qos</code> - the quality of service requested</dd><dd><code>retained</code> - whether the MQTT server should retain this message</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary string to be passed back to the activity</dd>
 <dt><span class="strong">Returns:</span></dt><dd>token for tracking the operation</dd></dl>
 </li>
 </ul>
 <a name="publish(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>publish</h4>
 <pre>public&nbsp;org.eclipse.paho.client.mqttv3.IMqttDeliveryToken&nbsp;publish(java.lang.String&nbsp;topic,
                                                         org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message,
                                                         java.lang.String&nbsp;invocationContext,
                                                         java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Publish a message on a topic</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic on which to publish - represented as a string, not
             an MqttTopic object</dd><dd><code>message</code> - the message to publish</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary string to be passed back to the activity</dd>
 <dt><span class="strong">Returns:</span></dt><dd>token for tracking the operation</dd></dl>
 </li>
 </ul>
 <a name="subscribe(java.lang.String, int, java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>subscribe</h4>
 <pre>public&nbsp;void&nbsp;subscribe(java.lang.String&nbsp;topic,
              int&nbsp;qos,
              java.lang.String&nbsp;invocationContext,
              java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Subscribe to a topic</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - a possibly wildcarded topic name</dd><dd><code>qos</code> - requested quality of service for the topic</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary identifier to be passed back to the Activity</dd></dl>
 </li>
 </ul>
 <a name="subscribe(java.lang.String[], int[], java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>subscribe</h4>
 <pre>public&nbsp;void&nbsp;subscribe(java.lang.String[]&nbsp;topic,
              int[]&nbsp;qos,
              java.lang.String&nbsp;invocationContext,
              java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Subscribe to one or more topics</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - a list of possibly wildcarded topic names</dd><dd><code>qos</code> - requested quality of service for each topic</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary identifier to be passed back to the Activity</dd></dl>
 </li>
 </ul>
 <a name="unsubscribe(java.lang.String, java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>unsubscribe</h4>
 <pre>void&nbsp;unsubscribe(java.lang.String&nbsp;topic,
                java.lang.String&nbsp;invocationContext,
                java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Unsubscribe from a topic</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - a possibly wildcarded topic name</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary identifier to be passed back to the Activity</dd></dl>
 </li>
 </ul>
 <a name="unsubscribe(java.lang.String[], java.lang.String, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>unsubscribe</h4>
 <pre>void&nbsp;unsubscribe(java.lang.String[]&nbsp;topic,
                java.lang.String&nbsp;invocationContext,
                java.lang.String&nbsp;activityToken)</pre>
 <div class="block">Unsubscribe from one or more topics</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - a list of possibly wildcarded topic names</dd><dd><code>invocationContext</code> - arbitrary data to be passed back to the application</dd><dd><code>activityToken</code> - arbitrary identifier to be passed back to the Activity</dd></dl>
 </li>
 </ul>
 <a name="getPendingDeliveryTokens()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPendingDeliveryTokens</h4>
 <pre>public&nbsp;org.eclipse.paho.client.mqttv3.IMqttDeliveryToken[]&nbsp;getPendingDeliveryTokens()</pre>
 <div class="block">Get tokens for all outstanding deliveries for a client</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>an array (possibly empty) of tokens</dd></dl>
 </li>
 </ul>
 <a name="connectionLost(java.lang.Throwable)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>connectionLost</h4>
 <pre>public&nbsp;void&nbsp;connectionLost(java.lang.Throwable&nbsp;why)</pre>
 <div class="block">Callback for connectionLost</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code>connectionLost</code>&nbsp;in interface&nbsp;<code>org.eclipse.paho.client.mqttv3.MqttCallback</code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>why</code> - the exeception causing the break in communications</dd></dl>
 </li>
 </ul>
 <a name="deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>deliveryComplete</h4>
 <pre>public&nbsp;void&nbsp;deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken&nbsp;messageToken)</pre>
 <div class="block">Callback to indicate a message has been delivered (the exact meaning of
  "has been delivered" is dependent on the QOS value)</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code>deliveryComplete</code>&nbsp;in interface&nbsp;<code>org.eclipse.paho.client.mqttv3.MqttCallback</code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>messageToken</code> - the messge token provided when the message was originally sent</dd></dl>
 </li>
 </ul>
 <a name="messageArrived(java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>messageArrived</h4>
 <pre>public&nbsp;void&nbsp;messageArrived(java.lang.String&nbsp;topic,
                   org.eclipse.paho.client.mqttv3.MqttMessage&nbsp;message)
                     throws java.lang.Exception</pre>
 <div class="block">Callback when a message is received</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code>messageArrived</code>&nbsp;in interface&nbsp;<code>org.eclipse.paho.client.mqttv3.MqttCallback</code></dd>
 <dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - the topic on which the message was received</dd><dd><code>message</code> - the message itself</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code>java.lang.Exception</code></dd></dl>
 </li>
 </ul>
 <a name="offline()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>offline</h4>
 <pre>void&nbsp;offline()</pre>
 <div class="block">Receive notification that we are offline<br>
  if cleanSession is true, we need to regard this as a disconnection</div>
 </li>
 </ul>
 <a name="reconnect()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>reconnect</h4>
 <pre>void&nbsp;reconnect()</pre>
 <div class="block">Reconnect<br>
  Only appropriate if cleanSession is false and we were connected
  Declare as synchronized to avoid multiple calls to this method to send connect
  multiple times</div>
 </li>
 </ul>
 <a name="setConnectingState(boolean)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>setConnectingState</h4>
 <pre>void&nbsp;setConnectingState(boolean&nbsp;isConnecting)</pre>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>isConnecting</code> - </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/MqttConnection.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/MqttAndroidClient.Ack.html" title="enum in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../../../org/eclipse/paho/android/service/MqttDeliveryTokenAndroid.html" title="class in org.eclipse.paho.android.service"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/eclipse/paho/android/service/MqttConnection.html" target="_top">Frames</a></li>
 <li><a href="MqttConnection.html" target="_top">No Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_detail">Method</a></li>
 </ul>
 </div>
 <a name="skip-navbar_bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>