Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / 2.4.0 / javadocs / org / apache / storm / mqtt / common / MqttOptions.html
blob: 84ee526502d82bcca800bcdc0e7aaa45311e6fee [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MqttOptions (Storm 2.4.0 API)</title>
<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="MqttOptions (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":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/MqttOptions.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.Builder.html" title="class in org.apache.storm.mqtt.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/mqtt/common/MqttOptions.html" target="_top">Frames</a></li>
<li><a href="MqttOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.storm.mqtt.common</div>
<h2 title="Class MqttOptions" class="title">Class MqttOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.storm.mqtt.common.MqttOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MqttOptions</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block"><p>MQTT Configuration Options.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.storm.mqtt.common.MqttOptions">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.Builder.html" title="class in org.apache.storm.mqtt.common">MqttOptions.Builder</a></span></code>&nbsp;</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">&nbsp;</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/apache/storm/mqtt/common/MqttOptions.html#MqttOptions--">MqttOptions</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getConnectAttemptsMax--">getConnectAttemptsMax</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getPassword--">getPassword</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getQos--">getQos</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getReconnectAttemptsMax--">getReconnectAttemptsMax</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getReconnectBackOffMultiplier--">getReconnectBackOffMultiplier</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getReconnectDelay--">getReconnectDelay</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getReconnectDelayMax--">getReconnectDelayMax</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getTopics--">getTopics</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getUrl--">getUrl</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getUserName--">getUserName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getWillPayload--">getWillPayload</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getWillQos--">getWillQos</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getWillRetain--">getWillRetain</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#getWillTopic--">getWillTopic</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#isCleanConnection--">isCleanConnection</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setCleanConnection-boolean-">setCleanConnection</a></span>(boolean&nbsp;cleanConnection)</code>
<div class="block">Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setConnectAttemptsMax-long-">setConnectAttemptsMax</a></span>(long&nbsp;connectAttemptsMax)</code>
<div class="block">The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setPassword-java.lang.String-">setPassword</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>
<div class="block">The password for authenticated sessions.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setQos-int-">setQos</a></span>(int&nbsp;qos)</code>
<div class="block">Sets the quality of service to use for MQTT messages.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setReconnectAttemptsMax-long-">setReconnectAttemptsMax</a></span>(long&nbsp;reconnectAttemptsMax)</code>
<div class="block">The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setReconnectBackOffMultiplier-double-">setReconnectBackOffMultiplier</a></span>(double&nbsp;reconnectBackOffMultiplier)</code>
<div class="block">The Exponential backoff be used between reconnect attempts.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setReconnectDelay-long-">setReconnectDelay</a></span>(long&nbsp;reconnectDelay)</code>
<div class="block">How long to wait in ms before the first reconnect attempt.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setReconnectDelayMax-long-">setReconnectDelayMax</a></span>(long&nbsp;reconnectDelayMax)</code>
<div class="block">The maximum amount of time in ms to wait between reconnect attempts.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setTopics-java.util.List-">setTopics</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;topics)</code>
<div class="block">A list of MQTT topics to subscribe to.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setUrl-java.lang.String-">setUrl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;url)</code>
<div class="block">Sets the url for connecting to the MQTT broker, e.g.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setUserName-java.lang.String-">setUserName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName)</code>
<div class="block">The username for authenticated sessions.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setWillPayload-java.lang.String-">setWillPayload</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;willPayload)</code>
<div class="block">The Will message to send.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setWillQos-int-">setWillQos</a></span>(int&nbsp;qos)</code>
<div class="block">Sets the quality of service to use for the MQTT Will message.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setWillRetain-boolean-">setWillRetain</a></span>(boolean&nbsp;retain)</code>
<div class="block">Set to true if you want the Will message to be published with the retain option.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.html#setWillTopic-java.lang.String-">setWillTopic</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;willTopic)</code>
<div class="block">If set the server will publish the client&rsquo;s Will message to the specified topics if the client has an unexpected disconnection.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="MqttOptions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MqttOptions</h4>
<pre>public&nbsp;MqttOptions()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrl</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUrl()</pre>
</li>
</ul>
<a name="setUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUrl</h4>
<pre>public&nbsp;void&nbsp;setUrl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;url)</pre>
<div class="block"><p>Sets the url for connecting to the MQTT broker, e.g. <code>tcp://localhost:1883</code>.</p></div>
</li>
</ul>
<a name="getTopics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopics</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getTopics()</pre>
</li>
</ul>
<a name="setTopics-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopics</h4>
<pre>public&nbsp;void&nbsp;setTopics(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;topics)</pre>
<div class="block"><p>A list of MQTT topics to subscribe to.</p></div>
</li>
</ul>
<a name="isCleanConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCleanConnection</h4>
<pre>public&nbsp;boolean&nbsp;isCleanConnection()</pre>
</li>
</ul>
<a name="setCleanConnection-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCleanConnection</h4>
<pre>public&nbsp;void&nbsp;setCleanConnection(boolean&nbsp;cleanConnection)</pre>
<div class="block"><p>Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to false.</p></div>
</li>
</ul>
<a name="getWillTopic--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWillTopic</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getWillTopic()</pre>
</li>
</ul>
<a name="setWillTopic-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWillTopic</h4>
<pre>public&nbsp;void&nbsp;setWillTopic(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;willTopic)</pre>
<div class="block"><p>If set the server will publish the client&rsquo;s Will message to the specified topics if the client has an unexpected disconnection.</p></div>
</li>
</ul>
<a name="getWillPayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWillPayload</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getWillPayload()</pre>
</li>
</ul>
<a name="setWillPayload-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWillPayload</h4>
<pre>public&nbsp;void&nbsp;setWillPayload(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;willPayload)</pre>
<div class="block"><p>The Will message to send. Defaults to a zero length message.</p></div>
</li>
</ul>
<a name="getReconnectDelay--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReconnectDelay</h4>
<pre>public&nbsp;long&nbsp;getReconnectDelay()</pre>
</li>
</ul>
<a name="setReconnectDelay-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReconnectDelay</h4>
<pre>public&nbsp;void&nbsp;setReconnectDelay(long&nbsp;reconnectDelay)</pre>
<div class="block"><p>How long to wait in ms before the first reconnect attempt. Defaults to 10.</p></div>
</li>
</ul>
<a name="getReconnectDelayMax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReconnectDelayMax</h4>
<pre>public&nbsp;long&nbsp;getReconnectDelayMax()</pre>
</li>
</ul>
<a name="setReconnectDelayMax-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReconnectDelayMax</h4>
<pre>public&nbsp;void&nbsp;setReconnectDelayMax(long&nbsp;reconnectDelayMax)</pre>
<div class="block"><p>The maximum amount of time in ms to wait between reconnect attempts. Defaults to 30,000.</p></div>
</li>
</ul>
<a name="getReconnectBackOffMultiplier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReconnectBackOffMultiplier</h4>
<pre>public&nbsp;double&nbsp;getReconnectBackOffMultiplier()</pre>
</li>
</ul>
<a name="setReconnectBackOffMultiplier-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReconnectBackOffMultiplier</h4>
<pre>public&nbsp;void&nbsp;setReconnectBackOffMultiplier(double&nbsp;reconnectBackOffMultiplier)</pre>
<div class="block"><p>The Exponential backoff be used between reconnect attempts. Set to 1 to disable exponential backoff. Defaults to 2.</p></div>
</li>
</ul>
<a name="getReconnectAttemptsMax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReconnectAttemptsMax</h4>
<pre>public&nbsp;long&nbsp;getReconnectAttemptsMax()</pre>
</li>
</ul>
<a name="setReconnectAttemptsMax-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReconnectAttemptsMax</h4>
<pre>public&nbsp;void&nbsp;setReconnectAttemptsMax(long&nbsp;reconnectAttemptsMax)</pre>
<div class="block"><p>The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established. Set to -1 to use unlimited attempts. Defaults to -1.</p></div>
</li>
</ul>
<a name="getConnectAttemptsMax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectAttemptsMax</h4>
<pre>public&nbsp;long&nbsp;getConnectAttemptsMax()</pre>
</li>
</ul>
<a name="setConnectAttemptsMax-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnectAttemptsMax</h4>
<pre>public&nbsp;void&nbsp;setConnectAttemptsMax(long&nbsp;connectAttemptsMax)</pre>
<div class="block"><p>The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to -1.</p></div>
</li>
</ul>
<a name="getUserName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUserName()</pre>
</li>
</ul>
<a name="setUserName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserName</h4>
<pre>public&nbsp;void&nbsp;setUserName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName)</pre>
<div class="block"><p>The username for authenticated sessions.</p></div>
</li>
</ul>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPassword()</pre>
</li>
</ul>
<a name="setPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;setPassword(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</pre>
<div class="block"><p>The password for authenticated sessions.</p></div>
</li>
</ul>
<a name="getQos--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQos</h4>
<pre>public&nbsp;int&nbsp;getQos()</pre>
</li>
</ul>
<a name="setQos-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQos</h4>
<pre>public&nbsp;void&nbsp;setQos(int&nbsp;qos)</pre>
<div class="block"><p>Sets the quality of service to use for MQTT messages. Defaults to 1 (at least once).</p></div>
</li>
</ul>
<a name="getWillQos--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWillQos</h4>
<pre>public&nbsp;int&nbsp;getWillQos()</pre>
</li>
</ul>
<a name="setWillQos-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWillQos</h4>
<pre>public&nbsp;void&nbsp;setWillQos(int&nbsp;qos)</pre>
<div class="block"><p>Sets the quality of service to use for the MQTT Will message. Defaults to 1 (at least once).</p></div>
</li>
</ul>
<a name="getWillRetain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWillRetain</h4>
<pre>public&nbsp;boolean&nbsp;getWillRetain()</pre>
</li>
</ul>
<a name="setWillRetain-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setWillRetain</h4>
<pre>public&nbsp;void&nbsp;setWillRetain(boolean&nbsp;retain)</pre>
<div class="block"><p>Set to true if you want the Will message to be published with the retain option.</p></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>
<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/MqttOptions.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/storm/mqtt/common/MqttOptions.Builder.html" title="class in org.apache.storm.mqtt.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/mqtt/common/MqttOptions.html" target="_top">Frames</a></li>
<li><a href="MqttOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>