| <!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 (1.8.0_101) on Thu Sep 01 13:59:14 BST 2016 --> |
| <title>MqttException</title> |
| <meta name="date" content="2016-09-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MqttException"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MqttException.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/client/mqttv3/MqttDeliveryToken.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/paho/client/mqttv3/MqttException.html" target="_top">Frames</a></li> |
| <li><a href="MqttException.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.client.mqttv3</div> |
| <h2 title="Class MqttException" class="title">Class MqttException</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Throwable</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Exception</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.paho.client.mqttv3.MqttException</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttPersistenceException.html" title="class in org.eclipse.paho.client.mqttv3">MqttPersistenceException</a>, <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttSecurityException.html" title="class in org.eclipse.paho.client.mqttv3">MqttSecurityException</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MqttException</span> |
| extends java.lang.Exception</pre> |
| <div class="block">Thrown if an error occurs communicating with the server.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.eclipse.paho.client.mqttv3.MqttException">Serialized Form</a></dd> |
| </dl> |
| </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="memberSummary" 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>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_BROKER_UNAVAILABLE">REASON_CODE_BROKER_UNAVAILABLE</a></span></code> |
| <div class="block">The broker was not available to handle the request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_ALREADY_DISCONNECTED">REASON_CODE_CLIENT_ALREADY_DISCONNECTED</a></span></code> |
| <div class="block">The client is already disconnected.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_CLOSED">REASON_CODE_CLIENT_CLOSED</a></span></code> |
| <div class="block">The client is closed - no operations are permitted on the client in this |
| state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_CONNECTED">REASON_CODE_CLIENT_CONNECTED</a></span></code> |
| <div class="block">The client is already connected.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_DISCONNECT_PROHIBITED">REASON_CODE_CLIENT_DISCONNECT_PROHIBITED</a></span></code> |
| <div class="block">Thrown when an attempt to call <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttClient.html#disconnect--"><code>MqttClient.disconnect()</code></a> has been |
| made from within a method on <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttCallback.html" title="interface in org.eclipse.paho.client.mqttv3"><code>MqttCallback</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_DISCONNECTING">REASON_CODE_CLIENT_DISCONNECTING</a></span></code> |
| <div class="block">The client is currently disconnecting and cannot accept any new work.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_EXCEPTION">REASON_CODE_CLIENT_EXCEPTION</a></span></code> |
| <div class="block">Client encountered an exception.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_NOT_CONNECTED">REASON_CODE_CLIENT_NOT_CONNECTED</a></span></code> |
| <div class="block">The client is not connected to the server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CLIENT_TIMEOUT">REASON_CODE_CLIENT_TIMEOUT</a></span></code> |
| <div class="block">Client timed out while waiting for a response from the server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CONNECT_IN_PROGRESS">REASON_CODE_CONNECT_IN_PROGRESS</a></span></code> |
| <div class="block">A connect operation in already in progress, only one connect can happen |
| at a time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_CONNECTION_LOST">REASON_CODE_CONNECTION_LOST</a></span></code> |
| <div class="block">The client has been unexpectedly disconnected from the server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_DISCONNECTED_BUFFER_FULL">REASON_CODE_DISCONNECTED_BUFFER_FULL</a></span></code> |
| <div class="block">The Client has attempted to publish a message whilst in the 'resting' / offline |
| state with Disconnected Publishing enabled, however the buffer is full and |
| deleteOldestMessages is disabled, therefore no more messages can be published |
| until the client reconnects, or the application deletes buffered message |
| manually.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_FAILED_AUTHENTICATION">REASON_CODE_FAILED_AUTHENTICATION</a></span></code> |
| <div class="block">Authentication with the server has failed, due to a bad user name or password.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_INVALID_CLIENT_ID">REASON_CODE_INVALID_CLIENT_ID</a></span></code> |
| <div class="block">The server has rejected the supplied client ID</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_INVALID_MESSAGE">REASON_CODE_INVALID_MESSAGE</a></span></code> |
| <div class="block">Protocol error: the message was not recognized as a valid MQTT packet.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_INVALID_PROTOCOL_VERSION">REASON_CODE_INVALID_PROTOCOL_VERSION</a></span></code> |
| <div class="block">The protocol version requested is not supported by the server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_MAX_INFLIGHT">REASON_CODE_MAX_INFLIGHT</a></span></code> |
| <div class="block">A request has been made to send a message but the maximum number of inflight |
| messages has already been reached.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_NO_MESSAGE_IDS_AVAILABLE">REASON_CODE_NO_MESSAGE_IDS_AVAILABLE</a></span></code> |
| <div class="block">Internal error, caused by no new message IDs being available.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_NOT_AUTHORIZED">REASON_CODE_NOT_AUTHORIZED</a></span></code> |
| <div class="block">Not authorized to perform the requested operation</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_SERVER_CONNECT_ERROR">REASON_CODE_SERVER_CONNECT_ERROR</a></span></code> |
| <div class="block">Unable to connect to server</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_SOCKET_FACTORY_MISMATCH">REASON_CODE_SOCKET_FACTORY_MISMATCH</a></span></code> |
| <div class="block">Server URI and supplied <code>SocketFactory</code> do not match.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_SSL_CONFIG_ERROR">REASON_CODE_SSL_CONFIG_ERROR</a></span></code> |
| <div class="block">SSL configuration error.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_SUBSCRIBE_FAILED">REASON_CODE_SUBSCRIBE_FAILED</a></span></code> |
| <div class="block">Error from subscribe - returned from the server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_TOKEN_INUSE">REASON_CODE_TOKEN_INUSE</a></span></code> |
| <div class="block">A request has been made to use a token that is already associated with |
| another action.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_UNEXPECTED_ERROR">REASON_CODE_UNEXPECTED_ERROR</a></span></code> |
| <div class="block">An unexpected error has occurred.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#REASON_CODE_WRITE_TIMEOUT">REASON_CODE_WRITE_TIMEOUT</a></span></code> |
| <div class="block">Client timed out while waiting to write messages to the server.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#MqttException-int-">MqttException</a></span>(int reasonCode)</code> |
| <div class="block">Constructs a new <code>MqttException</code> with the specified code |
| as the underlying reason.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#MqttException-int-java.lang.Throwable-">MqttException</a></span>(int reason, |
| java.lang.Throwable cause)</code> |
| <div class="block">Constructs a new <code>MqttException</code> with the specified |
| <code>Throwable</code> as the underlying reason.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#MqttException-java.lang.Throwable-">MqttException</a></span>(java.lang.Throwable cause)</code> |
| <div class="block">Constructs a new <code>MqttException</code> with the specified |
| <code>Throwable</code> as the underlying reason.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.Throwable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#getCause--">getCause</a></span>()</code> |
| <div class="block">Returns the underlying cause of this exception, if available.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#getMessage--">getMessage</a></span>()</code> |
| <div class="block">Returns the detail message for this exception.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#getReasonCode--">getReasonCode</a></span>()</code> |
| <div class="block">Returns the reason code for this exception.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#toString--">toString</a></span>()</code> |
| <div class="block">Returns a <code>String</code> representation of this exception.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Throwable</h3> |
| <code>addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li> |
| </ul> |
| <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>equals, getClass, hashCode, notify, notifyAll, 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="REASON_CODE_CLIENT_EXCEPTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_EXCEPTION</h4> |
| <pre>public static final short REASON_CODE_CLIENT_EXCEPTION</pre> |
| <div class="block">Client encountered an exception. Use the <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#getCause--"><code>getCause()</code></a> |
| method to get the underlying reason.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_EXCEPTION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_INVALID_PROTOCOL_VERSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_INVALID_PROTOCOL_VERSION</h4> |
| <pre>public static final short REASON_CODE_INVALID_PROTOCOL_VERSION</pre> |
| <div class="block">The protocol version requested is not supported by the server.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_INVALID_PROTOCOL_VERSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_INVALID_CLIENT_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_INVALID_CLIENT_ID</h4> |
| <pre>public static final short REASON_CODE_INVALID_CLIENT_ID</pre> |
| <div class="block">The server has rejected the supplied client ID</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_INVALID_CLIENT_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_BROKER_UNAVAILABLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_BROKER_UNAVAILABLE</h4> |
| <pre>public static final short REASON_CODE_BROKER_UNAVAILABLE</pre> |
| <div class="block">The broker was not available to handle the request.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_BROKER_UNAVAILABLE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_FAILED_AUTHENTICATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_FAILED_AUTHENTICATION</h4> |
| <pre>public static final short REASON_CODE_FAILED_AUTHENTICATION</pre> |
| <div class="block">Authentication with the server has failed, due to a bad user name or password.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_FAILED_AUTHENTICATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_NOT_AUTHORIZED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_NOT_AUTHORIZED</h4> |
| <pre>public static final short REASON_CODE_NOT_AUTHORIZED</pre> |
| <div class="block">Not authorized to perform the requested operation</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_NOT_AUTHORIZED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_UNEXPECTED_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_UNEXPECTED_ERROR</h4> |
| <pre>public static final short REASON_CODE_UNEXPECTED_ERROR</pre> |
| <div class="block">An unexpected error has occurred.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_UNEXPECTED_ERROR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_SUBSCRIBE_FAILED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_SUBSCRIBE_FAILED</h4> |
| <pre>public static final short REASON_CODE_SUBSCRIBE_FAILED</pre> |
| <div class="block">Error from subscribe - returned from the server.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_SUBSCRIBE_FAILED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_TIMEOUT</h4> |
| <pre>public static final short REASON_CODE_CLIENT_TIMEOUT</pre> |
| <div class="block">Client timed out while waiting for a response from the server. |
| The server is no longer responding to keep-alive messages.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_TIMEOUT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_NO_MESSAGE_IDS_AVAILABLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_NO_MESSAGE_IDS_AVAILABLE</h4> |
| <pre>public static final short REASON_CODE_NO_MESSAGE_IDS_AVAILABLE</pre> |
| <div class="block">Internal error, caused by no new message IDs being available.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_NO_MESSAGE_IDS_AVAILABLE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_WRITE_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_WRITE_TIMEOUT</h4> |
| <pre>public static final short REASON_CODE_WRITE_TIMEOUT</pre> |
| <div class="block">Client timed out while waiting to write messages to the server.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_WRITE_TIMEOUT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_CONNECTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_CONNECTED</h4> |
| <pre>public static final short REASON_CODE_CLIENT_CONNECTED</pre> |
| <div class="block">The client is already connected.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_CONNECTED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_ALREADY_DISCONNECTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_ALREADY_DISCONNECTED</h4> |
| <pre>public static final short REASON_CODE_CLIENT_ALREADY_DISCONNECTED</pre> |
| <div class="block">The client is already disconnected.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_ALREADY_DISCONNECTED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_DISCONNECTING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_DISCONNECTING</h4> |
| <pre>public static final short REASON_CODE_CLIENT_DISCONNECTING</pre> |
| <div class="block">The client is currently disconnecting and cannot accept any new work. |
| This can occur when waiting on a token, and then disconnecting the client. |
| If the message delivery does not complete within the quiesce timeout |
| period, then the waiting token will be notified with an exception.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_DISCONNECTING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_SERVER_CONNECT_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_SERVER_CONNECT_ERROR</h4> |
| <pre>public static final short REASON_CODE_SERVER_CONNECT_ERROR</pre> |
| <div class="block">Unable to connect to server</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_SERVER_CONNECT_ERROR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_NOT_CONNECTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_NOT_CONNECTED</h4> |
| <pre>public static final short REASON_CODE_CLIENT_NOT_CONNECTED</pre> |
| <div class="block">The client is not connected to the server. The <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttClient.html#connect--"><code>MqttClient.connect()</code></a> |
| or <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttClient.html#connect-org.eclipse.paho.client.mqttv3.MqttConnectOptions-"><code>MqttClient.connect(MqttConnectOptions)</code></a> method must be called |
| first. It is also possible that the connection was lost - see |
| <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttClient.html#setCallback-org.eclipse.paho.client.mqttv3.MqttCallback-"><code>MqttClient.setCallback(MqttCallback)</code></a> for a way to track lost |
| connections.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_NOT_CONNECTED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_SOCKET_FACTORY_MISMATCH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_SOCKET_FACTORY_MISMATCH</h4> |
| <pre>public static final short REASON_CODE_SOCKET_FACTORY_MISMATCH</pre> |
| <div class="block">Server URI and supplied <code>SocketFactory</code> do not match. |
| URIs beginning <code>tcp://</code> must use a <code>javax.net.SocketFactory</code>, |
| and URIs beginning <code>ssl://</code> must use a <code>javax.net.ssl.SSLSocketFactory</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_SOCKET_FACTORY_MISMATCH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_SSL_CONFIG_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_SSL_CONFIG_ERROR</h4> |
| <pre>public static final short REASON_CODE_SSL_CONFIG_ERROR</pre> |
| <div class="block">SSL configuration error.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_SSL_CONFIG_ERROR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_DISCONNECT_PROHIBITED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_DISCONNECT_PROHIBITED</h4> |
| <pre>public static final short REASON_CODE_CLIENT_DISCONNECT_PROHIBITED</pre> |
| <div class="block">Thrown when an attempt to call <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttClient.html#disconnect--"><code>MqttClient.disconnect()</code></a> has been |
| made from within a method on <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttCallback.html" title="interface in org.eclipse.paho.client.mqttv3"><code>MqttCallback</code></a>. These methods are invoked |
| by the client's thread, and must not be used to control disconnection.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttCallback.html#messageArrived-java.lang.String-org.eclipse.paho.client.mqttv3.MqttMessage-"><code>MqttCallback.messageArrived(String, MqttMessage)</code></a>, |
| <a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_DISCONNECT_PROHIBITED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_INVALID_MESSAGE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_INVALID_MESSAGE</h4> |
| <pre>public static final short REASON_CODE_INVALID_MESSAGE</pre> |
| <div class="block">Protocol error: the message was not recognized as a valid MQTT packet. |
| Possible reasons for this include connecting to a non-MQTT server, or |
| connecting to an SSL server port when the client isn't using SSL.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_INVALID_MESSAGE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CONNECTION_LOST"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CONNECTION_LOST</h4> |
| <pre>public static final short REASON_CODE_CONNECTION_LOST</pre> |
| <div class="block">The client has been unexpectedly disconnected from the server. The <a href="../../../../../org/eclipse/paho/client/mqttv3/MqttException.html#getCause--"><code>cause</code></a> |
| will provide more details.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CONNECTION_LOST">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CONNECT_IN_PROGRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CONNECT_IN_PROGRESS</h4> |
| <pre>public static final short REASON_CODE_CONNECT_IN_PROGRESS</pre> |
| <div class="block">A connect operation in already in progress, only one connect can happen |
| at a time.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CONNECT_IN_PROGRESS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_CLIENT_CLOSED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_CLIENT_CLOSED</h4> |
| <pre>public static final short REASON_CODE_CLIENT_CLOSED</pre> |
| <div class="block">The client is closed - no operations are permitted on the client in this |
| state. New up a new client to continue.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_CLIENT_CLOSED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_TOKEN_INUSE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_TOKEN_INUSE</h4> |
| <pre>public static final short REASON_CODE_TOKEN_INUSE</pre> |
| <div class="block">A request has been made to use a token that is already associated with |
| another action. If the action is complete the reset() can ve called on the |
| token to allow it to be reused.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_TOKEN_INUSE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_MAX_INFLIGHT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REASON_CODE_MAX_INFLIGHT</h4> |
| <pre>public static final short REASON_CODE_MAX_INFLIGHT</pre> |
| <div class="block">A request has been made to send a message but the maximum number of inflight |
| messages has already been reached. Once one or more messages have been moved |
| then new messages can be sent.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_MAX_INFLIGHT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="REASON_CODE_DISCONNECTED_BUFFER_FULL"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>REASON_CODE_DISCONNECTED_BUFFER_FULL</h4> |
| <pre>public static final short REASON_CODE_DISCONNECTED_BUFFER_FULL</pre> |
| <div class="block">The Client has attempted to publish a message whilst in the 'resting' / offline |
| state with Disconnected Publishing enabled, however the buffer is full and |
| deleteOldestMessages is disabled, therefore no more messages can be published |
| until the client reconnects, or the application deletes buffered message |
| manually.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttException.REASON_CODE_DISCONNECTED_BUFFER_FULL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MqttException-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MqttException</h4> |
| <pre>public MqttException(int reasonCode)</pre> |
| <div class="block">Constructs a new <code>MqttException</code> with the specified code |
| as the underlying reason.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reasonCode</code> - the reason code for the exception.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MqttException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MqttException</h4> |
| <pre>public MqttException(java.lang.Throwable cause)</pre> |
| <div class="block">Constructs a new <code>MqttException</code> with the specified |
| <code>Throwable</code> as the underlying reason.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - the underlying cause of the exception.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MqttException-int-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MqttException</h4> |
| <pre>public MqttException(int reason, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Constructs a new <code>MqttException</code> with the specified |
| <code>Throwable</code> as the underlying reason.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reason</code> - the reason code for the exception.</dd> |
| <dd><code>cause</code> - the underlying cause of the exception.</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="getReasonCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReasonCode</h4> |
| <pre>public int getReasonCode()</pre> |
| <div class="block">Returns the reason code for this exception.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the code representing the reason for this exception.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCause--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCause</h4> |
| <pre>public java.lang.Throwable getCause()</pre> |
| <div class="block">Returns the underlying cause of this exception, if available.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getCause</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Throwable that was the root cause of this exception, |
| which may be <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessage</h4> |
| <pre>public java.lang.String getMessage()</pre> |
| <div class="block">Returns the detail message for this exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getMessage</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the detail message, which may be <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <div class="block">Returns a <code>String</code> representation of this exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> representation of this exception.</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MqttException.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/client/mqttv3/MqttDeliveryToken.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/paho/client/mqttv3/MqttException.html" target="_top">Frames</a></li> |
| <li><a href="MqttException.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> |