| <!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>MqttService</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="MqttService"; | |
| } | |
| //--> | |
| </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/MqttService.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/MqttDeliveryTokenAndroid.html" title="class in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/MqttServiceBinder.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/MqttService.html" target="_top">Frames</a></li> | |
| <li><a href="MqttService.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>Nested | </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 MqttService" class="title">Class MqttService</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li>java.lang.Object</li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>Service</li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>org.eclipse.paho.android.service.MqttService</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Implemented Interfaces:</dt> | |
| <dd><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public class <span class="strong">MqttService</span> | |
| extends Service | |
| implements <a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a></pre> | |
| <div class="block"><p> | |
| The android service which interfaces with an MQTT client implementation | |
| </p> | |
| <p> | |
| The main API of MqttService is intended to pretty much mirror the | |
| IMqttAsyncClient with appropriate 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> | |
| To support multiple client connections, the bulk of the MQTT work is | |
| delegated to MqttConnection objects. These are identified by "client | |
| handle" strings, which is how the Activity, and the higher-level APIs refer | |
| to them. | |
| </p> | |
| <p> | |
| Activities using this service are expected to start it and bind to it using | |
| the BIND_AUTO_CREATE flag. The life cycle of this service is based on this | |
| approach. | |
| </p> | |
| <p> | |
| Operations are highly asynchronous - in most cases results are returned to | |
| the Activity by broadcasting one (or occasionally more) appropriate Intents, | |
| which the Activity is expected to register a listener for.<br> | |
| The Intents have an Action of | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_TO_ACTIVITY"><code>MqttServiceConstants.CALLBACK_TO_ACTIVITY</code></a> which allows the Activity to | |
| register a listener with an appropriate IntentFilter.<br> | |
| Further data is provided by "Extra Data" in the Intent, as follows :- | |
| <table border="1"> | |
| <tr> | |
| <th align="left">Name</th> | |
| <th align="left">Data Type</th> | |
| <th align="left">Value</th> | |
| <th align="left">Operations used for</th> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_CLIENT_HANDLE"><code>MqttServiceConstants.CALLBACK_CLIENT_HANDLE</code></a></td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The clientHandle identifying the client which | |
| initiated this operation</td> | |
| <td align="left" valign="top">All operations</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"><a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_STATUS"><code>MqttServiceConstants.CALLBACK_STATUS</code></a></td> | |
| <td align="left" valign="top">Serializable</td> | |
| <td align="left" valign="top">An <a href="../../../../../org/eclipse/paho/android/service/Status.html" title="enum in org.eclipse.paho.android.service"><code>Status</code></a> value indicating success or | |
| otherwise of the operation</td>; | |
| <td align="left" valign="top">All operations</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_ACTIVITY_TOKEN"><code>MqttServiceConstants.CALLBACK_ACTIVITY_TOKEN</code></a></td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">the activityToken passed into the operation</td> | |
| <td align="left" valign="top">All operations</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_INVOCATION_CONTEXT"><code>MqttServiceConstants.CALLBACK_INVOCATION_CONTEXT</code></a></td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">the invocationContext passed into the operation | |
| </td> | |
| <td align="left" valign="top">All operations</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"><a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_ACTION"><code>MqttServiceConstants.CALLBACK_ACTION</code></a></td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">one of | |
| <table> | |
| <tr> | |
| <td align="left" valign="top"> <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#SEND_ACTION"><code>MqttServiceConstants.SEND_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#UNSUBSCRIBE_ACTION"><code>MqttServiceConstants.UNSUBSCRIBE_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#SUBSCRIBE_ACTION"><code>MqttServiceConstants.SUBSCRIBE_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#DISCONNECT_ACTION"><code>MqttServiceConstants.DISCONNECT_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CONNECT_ACTION"><code>MqttServiceConstants.CONNECT_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#MESSAGE_ARRIVED_ACTION"><code>MqttServiceConstants.MESSAGE_ARRIVED_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#MESSAGE_DELIVERED_ACTION"><code>MqttServiceConstants.MESSAGE_DELIVERED_ACTION</code></a></td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#ON_CONNECTION_LOST_ACTION"><code>MqttServiceConstants.ON_CONNECTION_LOST_ACTION</code></a></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td align="left" valign="top">All operations</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_ERROR_MESSAGE"><code>MqttServiceConstants.CALLBACK_ERROR_MESSAGE</code></a> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">A suitable error message (taken from the | |
| relevant exception where possible)</td> | |
| <td align="left" valign="top">All failing operations</td> | |
| </tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_ERROR_NUMBER"><code>MqttServiceConstants.CALLBACK_ERROR_NUMBER</code></a> | |
| <td align="left" valign="top">int</td> | |
| <td align="left" valign="top">A suitable error code (taken from the relevant | |
| exception where possible)</td> | |
| <td align="left" valign="top">All failing operations</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_EXCEPTION_STACK"><code>MqttServiceConstants.CALLBACK_EXCEPTION_STACK</code></a></td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The stacktrace of the failing call</td> | |
| <td align="left" valign="top">The Connection Lost event</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_MESSAGE_ID"><code>MqttServiceConstants.CALLBACK_MESSAGE_ID</code></a></td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The identifier for the message in the message | |
| store, used by the Activity to acknowledge the arrival of the message, so | |
| that the service may remove it from the store</td> | |
| <td align="left" valign="top">The Message Arrived event</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_DESTINATION_NAME"><code>MqttServiceConstants.CALLBACK_DESTINATION_NAME</code></a> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The topic on which the message was received</td> | |
| <td align="left" valign="top">The Message Arrived event</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top"> | |
| <a href="../../../../../org/eclipse/paho/android/service/MqttServiceConstants.html#CALLBACK_MESSAGE_PARCEL"><code>MqttServiceConstants.CALLBACK_MESSAGE_PARCEL</code></a></td> | |
| <td align="left" valign="top">Parcelable</td> | |
| <td align="left" valign="top">The new message encapsulated in Android | |
| Parcelable format as a <a href="../../../../../org/eclipse/paho/android/service/ParcelableMqttMessage.html" title="class in org.eclipse.paho.android.service"><code>ParcelableMqttMessage</code></a></td> | |
| <td align="left" valign="top">The Message Arrived event</td> | |
| </tr> | |
| </table > | |
| </p></div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- =========== 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) <a href="../../../../../org/eclipse/paho/android/service/MessageStore.html" title="interface in org.eclipse.paho.android.service">MessageStore</a></code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#messageStore">messageStore</a></strong></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>(package private) static java.lang.String</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#TAG">TAG</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/MqttService.html#MqttService()">MqttService</a></strong>()</code> </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><a href="../../../../../org/eclipse/paho/android/service/Status.html" title="enum in org.eclipse.paho.android.service">Status</a></code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#acknowledgeMessageArrival(java.lang.String, java.lang.String)">acknowledgeMessageArrival</a></strong>(java.lang.String clientHandle, | |
| java.lang.String id)</code> | |
| <div class="block">Called by the Activity when a message has been passed back to the | |
| application</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/MqttService.html#callbackToActivity(java.lang.String, org.eclipse.paho.android.service.Status, Bundle)">callbackToActivity</a></strong>(java.lang.String clientHandle, | |
| <a href="../../../../../org/eclipse/paho/android/service/Status.html" title="enum in org.eclipse.paho.android.service">Status</a> status, | |
| Bundle dataBundle)</code> | |
| <div class="block">pass data back to the Activity, by building a suitable Intent object and | |
| broadcasting it</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/MqttService.html#close(java.lang.String)">close</a></strong>(java.lang.String clientHandle)</code> | |
| <div class="block">Close connection from a particular client</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/MqttService.html#connect(java.lang.String, org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.String, java.lang.String)">connect</a></strong>(java.lang.String clientHandle, | |
| org.eclipse.paho.client.mqttv3.MqttConnectOptions connectOptions, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Connect to the MQTT server specified by a particular client</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/MqttService.html#disconnect(java.lang.String, long, java.lang.String, java.lang.String)">disconnect</a></strong>(java.lang.String clientHandle, | |
| long quiesceTimeout, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Disconnect 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/MqttService.html#disconnect(java.lang.String, java.lang.String, java.lang.String)">disconnect</a></strong>(java.lang.String clientHandle, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Disconnect from the server</div> | |
| </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/MqttService.html#getClient(java.lang.String, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence)">getClient</a></strong>(java.lang.String serverURI, | |
| java.lang.String clientId, | |
| java.lang.String contextId, | |
| org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence)</code> | |
| <div class="block">Get an MqttConnection object to represent a connection to a 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/MqttService.html#getPendingDeliveryTokens(java.lang.String)">getPendingDeliveryTokens</a></strong>(java.lang.String clientHandle)</code> | |
| <div class="block">Get tokens for all outstanding deliveries for a client</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/MqttService.html#isConnected(java.lang.String)">isConnected</a></strong>(java.lang.String clientHandle)</code> | |
| <div class="block">Get the status of a specific client</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#isOnline()">isOnline</a></strong>()</code> </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#isTraceEnabled()">isTraceEnabled</a></strong>()</code> | |
| <div class="block">Check whether trace is on or off.</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/MqttService.html#notifyClientsOffline()">notifyClientsOffline</a></strong>()</code> | |
| <div class="block">Notify clients we're offline</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>IBinder</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#onBind(Intent)">onBind</a></strong>(Intent intent)</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/MqttService.html#onCreate()">onCreate</a></strong>()</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/MqttService.html#onDestroy()">onDestroy</a></strong>()</code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#onStartCommand(Intent, int, int)">onStartCommand</a></strong>(Intent intent, | |
| int flags, | |
| int startId)</code> </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/MqttService.html#publish(java.lang.String, java.lang.String, byte[], int, boolean, java.lang.String, java.lang.String)">publish</a></strong>(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| byte[] payload, | |
| int qos, | |
| boolean retained, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Publish a message to 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/MqttService.html#publish(java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttMessage, java.lang.String, java.lang.String)">publish</a></strong>(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| org.eclipse.paho.client.mqttv3.MqttMessage message, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Publish a message 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/MqttService.html#reconnect()">reconnect</a></strong>()</code> | |
| <div class="block">Request all clients to reconnect if appropriate</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/MqttService.html#setTraceCallbackId(java.lang.String)">setTraceCallbackId</a></strong>(java.lang.String traceCallbackId)</code> | |
| <div class="block">Identify the callbackId to be passed 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/MqttService.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>void</code></td> | |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/paho/android/service/MqttService.html#subscribe(java.lang.String, java.lang.String[], int[], java.lang.String, java.lang.String)">subscribe</a></strong>(java.lang.String clientHandle, | |
| java.lang.String[] topic, | |
| int[] qos, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Subscribe to one or more topics</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/MqttService.html#subscribe(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String)">subscribe</a></strong>(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| int qos, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Subscribe to a topic</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/MqttService.html#traceDebug(java.lang.String, java.lang.String)">traceDebug</a></strong>(java.lang.String tag, | |
| java.lang.String message)</code> | |
| <div class="block">Trace debugging information</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/MqttService.html#traceError(java.lang.String, java.lang.String)">traceError</a></strong>(java.lang.String tag, | |
| java.lang.String message)</code> | |
| <div class="block">Trace error information</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/MqttService.html#traceException(java.lang.String, java.lang.String, java.lang.Exception)">traceException</a></strong>(java.lang.String tag, | |
| java.lang.String message, | |
| java.lang.Exception e)</code> | |
| <div class="block">trace exceptions</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/MqttService.html#unsubscribe(java.lang.String, java.lang.String[], java.lang.String, java.lang.String)">unsubscribe</a></strong>(java.lang.String clientHandle, | |
| java.lang.String[] topic, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</code> | |
| <div class="block">Unsubscribe from 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/MqttService.html#unsubscribe(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">unsubscribe</a></strong>(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| java.lang.String invocationContext, | |
| java.lang.String 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 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="TAG"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>TAG</h4> | |
| <pre>static final java.lang.String TAG</pre> | |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.paho.android.service.MqttService.TAG">Constant Field Values</a></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="messageStore"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>messageStore</h4> | |
| <pre><a href="../../../../../org/eclipse/paho/android/service/MessageStore.html" title="interface in org.eclipse.paho.android.service">MessageStore</a> messageStore</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor_detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="MqttService()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>MqttService</h4> | |
| <pre>public MqttService()</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method_detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="callbackToActivity(java.lang.String, org.eclipse.paho.android.service.Status, Bundle)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>callbackToActivity</h4> | |
| <pre>void callbackToActivity(java.lang.String clientHandle, | |
| <a href="../../../../../org/eclipse/paho/android/service/Status.html" title="enum in org.eclipse.paho.android.service">Status</a> status, | |
| Bundle dataBundle)</pre> | |
| <div class="block">pass data back to the Activity, by building a suitable Intent object and | |
| broadcasting it</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - source of the data</dd><dd><code>status</code> - OK or Error</dd><dd><code>dataBundle</code> - the data to be passed</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="getClient(java.lang.String, java.lang.String, java.lang.String, org.eclipse.paho.client.mqttv3.MqttClientPersistence)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getClient</h4> | |
| <pre>public java.lang.String getClient(java.lang.String serverURI, | |
| java.lang.String clientId, | |
| java.lang.String contextId, | |
| org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence)</pre> | |
| <div class="block">Get an MqttConnection object to represent a connection to a server</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><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>contextId</code> - specifies the app conext info to make a difference between apps</dd> | |
| <dt><span class="strong">Returns:</span></dt><dd>a string to be used by the Activity as a "handle" for this | |
| MqttConnection</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="connect(java.lang.String, org.eclipse.paho.client.mqttv3.MqttConnectOptions, java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>connect</h4> | |
| <pre>public void connect(java.lang.String clientHandle, | |
| org.eclipse.paho.client.mqttv3.MqttConnectOptions connectOptions, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken) | |
| throws org.eclipse.paho.client.mqttv3.MqttSecurityException, | |
| org.eclipse.paho.client.mqttv3.MqttException</pre> | |
| <div class="block">Connect to the MQTT server specified by a particular client</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd><dd><code>connectOptions</code> - the MQTT connection options to be used</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> | |
| <dt><span class="strong">Throws:</span></dt> | |
| <dd><code>org.eclipse.paho.client.mqttv3.MqttSecurityException</code></dd> | |
| <dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="reconnect()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>reconnect</h4> | |
| <pre>void reconnect()</pre> | |
| <div class="block">Request all clients to reconnect if appropriate</div> | |
| </li> | |
| </ul> | |
| <a name="close(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>close</h4> | |
| <pre>public void close(java.lang.String clientHandle)</pre> | |
| <div class="block">Close connection from a particular client</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="disconnect(java.lang.String, java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>disconnect</h4> | |
| <pre>public void disconnect(java.lang.String clientHandle, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</pre> | |
| <div class="block">Disconnect from the server</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</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="disconnect(java.lang.String, long, java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>disconnect</h4> | |
| <pre>public void disconnect(java.lang.String clientHandle, | |
| long quiesceTimeout, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</pre> | |
| <div class="block">Disconnect from the server</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd><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 identifier to be passed back to the Activity</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="isConnected(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isConnected</h4> | |
| <pre>public boolean isConnected(java.lang.String clientHandle)</pre> | |
| <div class="block">Get the status of a specific client</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd> | |
| <dt><span class="strong">Returns:</span></dt><dd>true if the specified client is connected to an MQTT server</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="publish(java.lang.String, java.lang.String, byte[], int, boolean, java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>publish</h4> | |
| <pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken publish(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| byte[] payload, | |
| int qos, | |
| boolean retained, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken) | |
| throws org.eclipse.paho.client.mqttv3.MqttPersistenceException, | |
| org.eclipse.paho.client.mqttv3.MqttException</pre> | |
| <div class="block">Publish a message to a topic</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd><dd><code>topic</code> - the topic to which to publish</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 identifier to be passed back to the Activity</dd> | |
| <dt><span class="strong">Returns:</span></dt><dd>token for tracking the operation</dd> | |
| <dt><span class="strong">Throws:</span></dt> | |
| <dd><code>org.eclipse.paho.client.mqttv3.MqttPersistenceException</code></dd> | |
| <dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="publish(java.lang.String, 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 org.eclipse.paho.client.mqttv3.IMqttDeliveryToken publish(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| org.eclipse.paho.client.mqttv3.MqttMessage message, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken) | |
| throws org.eclipse.paho.client.mqttv3.MqttPersistenceException, | |
| org.eclipse.paho.client.mqttv3.MqttException</pre> | |
| <div class="block">Publish a message to a topic</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd><dd><code>topic</code> - the topic to which to publish</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 identifier to be passed back to the Activity</dd> | |
| <dt><span class="strong">Returns:</span></dt><dd>token for tracking the operation</dd> | |
| <dt><span class="strong">Throws:</span></dt> | |
| <dd><code>org.eclipse.paho.client.mqttv3.MqttPersistenceException</code></dd> | |
| <dd><code>org.eclipse.paho.client.mqttv3.MqttException</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="subscribe(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>subscribe</h4> | |
| <pre>public void subscribe(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| int qos, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</pre> | |
| <div class="block">Subscribe to a topic</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd><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, java.lang.String[], int[], java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>subscribe</h4> | |
| <pre>public void subscribe(java.lang.String clientHandle, | |
| java.lang.String[] topic, | |
| int[] qos, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</pre> | |
| <div class="block">Subscribe to one or more topics</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection to use</dd><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, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>unsubscribe</h4> | |
| <pre>public void unsubscribe(java.lang.String clientHandle, | |
| java.lang.String topic, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</pre> | |
| <div class="block">Unsubscribe from a topic</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection</dd><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, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>unsubscribe</h4> | |
| <pre>public void unsubscribe(java.lang.String clientHandle, | |
| java.lang.String[] topic, | |
| java.lang.String invocationContext, | |
| java.lang.String activityToken)</pre> | |
| <div class="block">Unsubscribe from one or more topics</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection</dd><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(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getPendingDeliveryTokens</h4> | |
| <pre>public org.eclipse.paho.client.mqttv3.IMqttDeliveryToken[] getPendingDeliveryTokens(java.lang.String clientHandle)</pre> | |
| <div class="block">Get tokens for all outstanding deliveries for a client</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifies the MqttConnection</dd> | |
| <dt><span class="strong">Returns:</span></dt><dd>an array (possibly empty) of tokens</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="acknowledgeMessageArrival(java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>acknowledgeMessageArrival</h4> | |
| <pre>public <a href="../../../../../org/eclipse/paho/android/service/Status.html" title="enum in org.eclipse.paho.android.service">Status</a> acknowledgeMessageArrival(java.lang.String clientHandle, | |
| java.lang.String id)</pre> | |
| <div class="block">Called by the Activity when a message has been passed back to the | |
| application</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clientHandle</code> - identifier for the client which received the message</dd><dd><code>id</code> - identifier for the MQTT message</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="onCreate()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>onCreate</h4> | |
| <pre>public void onCreate()</pre> | |
| <dl><dt><span class="strong">See Also:</span></dt><dd><code>android.app.Service#onCreate()</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="onDestroy()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>onDestroy</h4> | |
| <pre>public void onDestroy()</pre> | |
| <dl><dt><span class="strong">See Also:</span></dt><dd><code>android.app.Service#onDestroy()</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="onBind(Intent)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>onBind</h4> | |
| <pre>public IBinder onBind(Intent intent)</pre> | |
| <dl><dt><span class="strong">See Also:</span></dt><dd><code>android.app.Service#onBind(Intent)</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="onStartCommand(Intent, int, int)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>onStartCommand</h4> | |
| <pre>public int onStartCommand(Intent intent, | |
| int flags, | |
| int startId)</pre> | |
| <dl><dt><span class="strong">See Also:</span></dt><dd><code>android.app.Service#onStartCommand(Intent,int,int)</code></dd></dl> | |
| </li> | |
| </ul> | |
| <a name="setTraceCallbackId(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setTraceCallbackId</h4> | |
| <pre>public void setTraceCallbackId(java.lang.String traceCallbackId)</pre> | |
| <div class="block">Identify the callbackId to be passed when making tracing calls back into | |
| the Activity</div> | |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>traceCallbackId</code> - identifier to the callback into the Activity</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 turn on tracing, <code>false</code> to turn off tracing</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="isTraceEnabled()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isTraceEnabled</h4> | |
| <pre>public boolean isTraceEnabled()</pre> | |
| <div class="block">Check whether trace is on or off.</div> | |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the state of trace</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="traceDebug(java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>traceDebug</h4> | |
| <pre>public void traceDebug(java.lang.String tag, | |
| java.lang.String message)</pre> | |
| <div class="block">Trace debugging information</div> | |
| <dl> | |
| <dt><strong>Specified by:</strong></dt> | |
| <dd><code><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html#traceDebug(java.lang.String, java.lang.String)">traceDebug</a></code> in interface <code><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a></code></dd> | |
| <dt><span class="strong">Parameters:</span></dt><dd><code>tag</code> - identifier for the source of the trace</dd><dd><code>message</code> - the text to be traced</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="traceError(java.lang.String, java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>traceError</h4> | |
| <pre>public void traceError(java.lang.String tag, | |
| java.lang.String message)</pre> | |
| <div class="block">Trace error information</div> | |
| <dl> | |
| <dt><strong>Specified by:</strong></dt> | |
| <dd><code><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html#traceError(java.lang.String, java.lang.String)">traceError</a></code> in interface <code><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a></code></dd> | |
| <dt><span class="strong">Parameters:</span></dt><dd><code>tag</code> - identifier for the source of the trace</dd><dd><code>message</code> - the text to be traced</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="traceException(java.lang.String, java.lang.String, java.lang.Exception)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>traceException</h4> | |
| <pre>public void traceException(java.lang.String tag, | |
| java.lang.String message, | |
| java.lang.Exception e)</pre> | |
| <div class="block">trace exceptions</div> | |
| <dl> | |
| <dt><strong>Specified by:</strong></dt> | |
| <dd><code><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html#traceException(java.lang.String, java.lang.String, java.lang.Exception)">traceException</a></code> in interface <code><a href="../../../../../org/eclipse/paho/android/service/MqttTraceHandler.html" title="interface in org.eclipse.paho.android.service">MqttTraceHandler</a></code></dd> | |
| <dt><span class="strong">Parameters:</span></dt><dd><code>tag</code> - identifier for the source of the trace</dd><dd><code>message</code> - the text to be traced</dd><dd><code>e</code> - the exception</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="isOnline()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isOnline</h4> | |
| <pre>public boolean isOnline()</pre> | |
| <dl><dt><span class="strong">Returns:</span></dt><dd>whether the android service can be regarded as online</dd></dl> | |
| </li> | |
| </ul> | |
| <a name="notifyClientsOffline()"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>notifyClientsOffline</h4> | |
| <pre>public void notifyClientsOffline()</pre> | |
| <div class="block">Notify clients we're offline</div> | |
| </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/MqttService.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/MqttDeliveryTokenAndroid.html" title="class in org.eclipse.paho.android.service"><span class="strong">Prev Class</span></a></li> | |
| <li><a href="../../../../../org/eclipse/paho/android/service/MqttServiceBinder.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/MqttService.html" target="_top">Frames</a></li> | |
| <li><a href="MqttService.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>Nested | </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> |