| <!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>MqttUnsubscribe</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="MqttUnsubscribe"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/MqttUnsubscribe.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/internal/wire/MqttUnsubAck.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/paho/client/mqttv3/internal/wire/MqttUnsubscribe.html" target="_top">Frames</a></li> |
| <li><a href="MqttUnsubscribe.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="#fields.inherited.from.class.org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage">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>Field | </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.internal.wire</div> |
| <h2 title="Class MqttUnsubscribe" class="title">Class MqttUnsubscribe</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MqttUnsubscribe</span> |
| extends <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttWireMessage</a></pre> |
| <div class="block">An on-the-wire representation of an MQTT UNSUBSCRIBE message.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.paho.client.mqttv3.internal.wire.<a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttWireMessage</a></h3> |
| <code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_CONNACK">MESSAGE_TYPE_CONNACK</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_CONNECT">MESSAGE_TYPE_CONNECT</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_DISCONNECT">MESSAGE_TYPE_DISCONNECT</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PINGREQ">MESSAGE_TYPE_PINGREQ</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PINGRESP">MESSAGE_TYPE_PINGRESP</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PUBACK">MESSAGE_TYPE_PUBACK</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PUBCOMP">MESSAGE_TYPE_PUBCOMP</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PUBLISH">MESSAGE_TYPE_PUBLISH</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PUBREC">MESSAGE_TYPE_PUBREC</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_PUBREL">MESSAGE_TYPE_PUBREL</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_SUBACK">MESSAGE_TYPE_SUBACK</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_SUBSCRIBE">MESSAGE_TYPE_SUBSCRIBE</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_UNSUBACK">MESSAGE_TYPE_UNSUBACK</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#MESSAGE_TYPE_UNSUBSCRIBE">MESSAGE_TYPE_UNSUBSCRIBE</a></code></li> |
| </ul> |
| </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/internal/wire/MqttUnsubscribe.html#MqttUnsubscribe-byte-byte:A-">MqttUnsubscribe</a></span>(byte info, |
| byte[] data)</code> |
| <div class="block">Constructor for an on the wire MQTT un-subscribe message</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttUnsubscribe.html#MqttUnsubscribe-java.lang.String:A-">MqttUnsubscribe</a></span>(java.lang.String[] names)</code> |
| <div class="block">Constructs an MqttUnsubscribe</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>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttUnsubscribe.html#getPayload--">getPayload</a></span>()</code> |
| <div class="block">Sub-classes should override this method to supply the payload bytes.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttUnsubscribe.html#isRetryable--">isRetryable</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttUnsubscribe.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.paho.client.mqttv3.internal.wire.<a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttWireMessage</a></h3> |
| <code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#createWireMessage-byte:A-">createWireMessage</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#createWireMessage-org.eclipse.paho.client.mqttv3.MqttPersistable-">createWireMessage</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#getHeader--">getHeader</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#getKey--">getKey</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#getMessageId--">getMessageId</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#getType--">getType</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#isMessageIdRequired--">isMessageIdRequired</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#setDuplicate-boolean-">setDuplicate</a>, <a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#setMessageId-int-">setMessageId</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MqttUnsubscribe-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MqttUnsubscribe</h4> |
| <pre>public MqttUnsubscribe(java.lang.String[] names)</pre> |
| <div class="block">Constructs an MqttUnsubscribe</div> |
| </li> |
| </ul> |
| <a name="MqttUnsubscribe-byte-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MqttUnsubscribe</h4> |
| <pre>public MqttUnsubscribe(byte info, |
| byte[] data) |
| throws java.io.IOException</pre> |
| <div class="block">Constructor for an on the wire MQTT un-subscribe message</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - </dd> |
| <dd><code>data</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></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="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#toString--">toString</a></code> in class <code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttWireMessage</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>string representation of this un-subscribe packet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPayload--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPayload</h4> |
| <pre>public byte[] getPayload() |
| throws <a href="../../../../../../../org/eclipse/paho/client/mqttv3/MqttException.html" title="class in org.eclipse.paho.client.mqttv3">MqttException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#getPayload--">MqttWireMessage</a></code></span></div> |
| <div class="block">Sub-classes should override this method to supply the payload bytes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#getPayload--">getPayload</a></code> in class <code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttWireMessage</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/MqttException.html" title="class in org.eclipse.paho.client.mqttv3">MqttException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRetryable--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isRetryable</h4> |
| <pre>public boolean isRetryable()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html#isRetryable--">isRetryable</a></code> in class <code><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttWireMessage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <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/MqttUnsubscribe.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/internal/wire/MqttUnsubAck.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttWireMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/paho/client/mqttv3/internal/wire/MqttUnsubscribe.html" target="_top">Frames</a></li> |
| <li><a href="MqttUnsubscribe.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="#fields.inherited.from.class.org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage">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>Field | </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> |
