Google Git
Sign in
eclipse / gerrit / www.eclipse.org / paho / b0d1f1dc4e00e95ae1282c5465b8ac347079ffc3 / . / files / javadoc / org / eclipse / paho / client / mqttv3 / MqttConnectOptions.html
blob: d84c097851a379c0d02754d0050dcc44f183c26a [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 (1.8.0_101) on Thu Sep 01 13:59:14 BST 2016 -->
<title>MqttConnectOptions</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="MqttConnectOptions";
}
}
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};
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/MqttConnectOptions.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/MqttClientPersistence.html" title="interface in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttDeliveryToken.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/paho/client/mqttv3/MqttConnectOptions.html" target="_top">Frames</a></li>
<li><a href="MqttConnectOptions.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.paho.client.mqttv3</div>
<h2 title="Class MqttConnectOptions" class="title">Class MqttConnectOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.paho.client.mqttv3.MqttConnectOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">MqttConnectOptions</span>
extends java.lang.Object</pre>
<div class="block">Holds the set of options that control how the client connects to a server.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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 boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#CLEAN_SESSION_DEFAULT">CLEAN_SESSION_DEFAULT</a></span></code>
<div class="block">The default clean session setting if one is not specified</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#CONNECTION_TIMEOUT_DEFAULT">CONNECTION_TIMEOUT_DEFAULT</a></span></code>
<div class="block">The default connection timeout in seconds if one is not specified</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#KEEP_ALIVE_INTERVAL_DEFAULT">KEEP_ALIVE_INTERVAL_DEFAULT</a></span></code>
<div class="block">The default keep alive interval in seconds if one is not specified</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#MAX_INFLIGHT_DEFAULT">MAX_INFLIGHT_DEFAULT</a></span></code>
<div class="block">The default max inflight if one is not specified</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#MQTT_VERSION_3_1">MQTT_VERSION_3_1</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#MQTT_VERSION_3_1_1">MQTT_VERSION_3_1_1</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#MQTT_VERSION_DEFAULT">MQTT_VERSION_DEFAULT</a></span></code>
<div class="block">The default MqttVersion is 3.1.1 first, dropping back to 3.1 if that fails</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">&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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#MqttConnectOptions--">MqttConnectOptions</a></span>()</code>
<div class="block">Constructs a new <code>MqttConnectOptions</code> object using the
default values.</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">&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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getConnectionTimeout--">getConnectionTimeout</a></span>()</code>
<div class="block">Returns the connection timeout value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Properties</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getDebug--">getDebug</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getKeepAliveInterval--">getKeepAliveInterval</a></span>()</code>
<div class="block">Returns the "keep alive" interval.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getMaxInflight--">getMaxInflight</a></span>()</code>
<div class="block">Returns the "max inflight".</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getMqttVersion--">getMqttVersion</a></span>()</code>
<div class="block">Returns the MQTT version.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>char[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getPassword--">getPassword</a></span>()</code>
<div class="block">Returns the password to use for the connection.</div>
</td>
</tr>
<tr id="i6" 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/MqttConnectOptions.html#getServerURIs--">getServerURIs</a></span>()</code>
<div class="block">Return a list of serverURIs the client may connect to</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>javax.net.SocketFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getSocketFactory--">getSocketFactory</a></span>()</code>
<div class="block">Returns the socket factory that will be used when connecting, or
<code>null</code> if one has not been set.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Properties</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getSSLProperties--">getSSLProperties</a></span>()</code>
<div class="block">Returns the SSL properties for the connection.</div>
</td>
</tr>
<tr id="i9" 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/MqttConnectOptions.html#getUserName--">getUserName</a></span>()</code>
<div class="block">Returns the user name to use for the connection.</div>
</td>
</tr>
<tr id="i10" 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/MqttConnectOptions.html#getWillDestination--">getWillDestination</a></span>()</code>
<div class="block">Returns the topic to be used for last will and testament (LWT).</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html" title="class in org.eclipse.paho.client.mqttv3">MqttMessage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#getWillMessage--">getWillMessage</a></span>()</code>
<div class="block">Returns the message to be sent as last will and testament (LWT).</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#isAutomaticReconnect--">isAutomaticReconnect</a></span>()</code>
<div class="block">Returns whether the client will automatically attempt to reconnect to the
server if the connection is lost</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#isCleanSession--">isCleanSession</a></span>()</code>
<div class="block">Returns whether the client and server should remember state for the client across reconnects.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setAutomaticReconnect-boolean-">setAutomaticReconnect</a></span>(boolean&nbsp;automaticReconnect)</code>
<div class="block">Sets whether the client will automatically attempt to reconnect to the
server if the connection is lost.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setCleanSession-boolean-">setCleanSession</a></span>(boolean&nbsp;cleanSession)</code>
<div class="block">Sets whether the client and server should remember state across restarts and reconnects.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setConnectionTimeout-int-">setConnectionTimeout</a></span>(int&nbsp;connectionTimeout)</code>
<div class="block">Sets the connection timeout value.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setKeepAliveInterval-int-">setKeepAliveInterval</a></span>(int&nbsp;keepAliveInterval)</code>
<div class="block">Sets the "keep alive" interval.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setMaxInflight-int-">setMaxInflight</a></span>(int&nbsp;maxInflight)</code>
<div class="block">Sets the "max inflight".</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setMqttVersion-int-">setMqttVersion</a></span>(int&nbsp;MqttVersion)</code>
<div class="block">Sets the MQTT version.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setPassword-char:A-">setPassword</a></span>(char[]&nbsp;password)</code>
<div class="block">Sets the password to use for the connection.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setServerURIs-java.lang.String:A-">setServerURIs</a></span>(java.lang.String[]&nbsp;array)</code>
<div class="block">Set a list of one or more serverURIs the client may connect to.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setSocketFactory-javax.net.SocketFactory-">setSocketFactory</a></span>(javax.net.SocketFactory&nbsp;socketFactory)</code>
<div class="block">Sets the <code>SocketFactory</code> to use.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setSSLProperties-java.util.Properties-">setSSLProperties</a></span>(java.util.Properties&nbsp;props)</code>
<div class="block">Sets the SSL properties for the connection.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setUserName-java.lang.String-">setUserName</a></span>(java.lang.String&nbsp;userName)</code>
<div class="block">Sets the user name to use for the connection.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setWill-org.eclipse.paho.client.mqttv3.MqttTopic-byte:A-int-boolean-">setWill</a></span>(<a href="../../../../../org/eclipse/paho/client/mqttv3/MqttTopic.html" title="class in org.eclipse.paho.client.mqttv3">MqttTopic</a>&nbsp;topic,
byte[]&nbsp;payload,
int&nbsp;qos,
boolean&nbsp;retained)</code>
<div class="block">Sets the "Last Will and Testament" (LWT) for the connection.</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/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setWill-java.lang.String-byte:A-int-boolean-">setWill</a></span>(java.lang.String&nbsp;topic,
byte[]&nbsp;payload,
int&nbsp;qos,
boolean&nbsp;retained)</code>
<div class="block">Sets the "Last Will and Testament" (LWT) for the connection.</div>
</td>
</tr>
<tr id="i27" 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/MqttConnectOptions.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>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="KEEP_ALIVE_INTERVAL_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEEP_ALIVE_INTERVAL_DEFAULT</h4>
<pre>public static final&nbsp;int KEEP_ALIVE_INTERVAL_DEFAULT</pre>
<div class="block">The default keep alive interval in seconds if one is not specified</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.KEEP_ALIVE_INTERVAL_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CONNECTION_TIMEOUT_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONNECTION_TIMEOUT_DEFAULT</h4>
<pre>public static final&nbsp;int CONNECTION_TIMEOUT_DEFAULT</pre>
<div class="block">The default connection timeout in seconds if one is not specified</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.CONNECTION_TIMEOUT_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MAX_INFLIGHT_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_INFLIGHT_DEFAULT</h4>
<pre>public static final&nbsp;int MAX_INFLIGHT_DEFAULT</pre>
<div class="block">The default max inflight if one is not specified</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.MAX_INFLIGHT_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLEAN_SESSION_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLEAN_SESSION_DEFAULT</h4>
<pre>public static final&nbsp;boolean CLEAN_SESSION_DEFAULT</pre>
<div class="block">The default clean session setting if one is not specified</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.CLEAN_SESSION_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MQTT_VERSION_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MQTT_VERSION_DEFAULT</h4>
<pre>public static final&nbsp;int MQTT_VERSION_DEFAULT</pre>
<div class="block">The default MqttVersion is 3.1.1 first, dropping back to 3.1 if that fails</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.MQTT_VERSION_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MQTT_VERSION_3_1">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MQTT_VERSION_3_1</h4>
<pre>public static final&nbsp;int MQTT_VERSION_3_1</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.MQTT_VERSION_3_1">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MQTT_VERSION_3_1_1">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MQTT_VERSION_3_1_1</h4>
<pre>public static final&nbsp;int MQTT_VERSION_3_1_1</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.paho.client.mqttv3.MqttConnectOptions.MQTT_VERSION_3_1_1">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="MqttConnectOptions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MqttConnectOptions</h4>
<pre>public&nbsp;MqttConnectOptions()</pre>
<div class="block">Constructs a new <code>MqttConnectOptions</code> object using the
default values.
The defaults are:
<ul>
<li>The keepalive interval is 60 seconds</li>
<li>Clean Session is true</li>
<li>The message delivery retry interval is 15 seconds</li>
<li>The connection timeout period is 30 seconds</li>
<li>No Will message is set</li>
<li>A standard SocketFactory is used</li>
</ul>
More information about these values can be found in the setter methods.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</h4>
<pre>public&nbsp;char[]&nbsp;getPassword()</pre>
<div class="block">Returns the password to use for the connection.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the password to use for the connection.</dd>
</dl>
</li>
</ul>
<a name="setPassword-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;setPassword(char[]&nbsp;password)</pre>
<div class="block">Sets the password to use for the connection.</div>
</li>
</ul>
<a name="getUserName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getUserName()</pre>
<div class="block">Returns the user name to use for the connection.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user name to use for the connection.</dd>
</dl>
</li>
</ul>
<a name="setUserName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserName</h4>
<pre>public&nbsp;void&nbsp;setUserName(java.lang.String&nbsp;userName)</pre>
<div class="block">Sets the user name to use for the connection.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the user name is blank or only
contains whitespace characters.</dd>
</dl>
</li>
</ul>
<a name="setWill-org.eclipse.paho.client.mqttv3.MqttTopic-byte:A-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWill</h4>
<pre>public&nbsp;void&nbsp;setWill(<a href="../../../../../org/eclipse/paho/client/mqttv3/MqttTopic.html" title="class in org.eclipse.paho.client.mqttv3">MqttTopic</a>&nbsp;topic,
byte[]&nbsp;payload,
int&nbsp;qos,
boolean&nbsp;retained)</pre>
<div class="block">Sets the "Last Will and Testament" (LWT) for the connection.
In the event that this client unexpectedly loses its connection to the
server, the server will publish a message to itself using the supplied
details.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topic</code> - the topic to publish to.</dd>
<dd><code>payload</code> - the byte payload for the message.</dd>
<dd><code>qos</code> - the quality of service to publish the message at (0, 1 or 2).</dd>
<dd><code>retained</code> - whether or not the message should be retained.</dd>
</dl>
</li>
</ul>
<a name="setWill-java.lang.String-byte:A-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWill</h4>
<pre>public&nbsp;void&nbsp;setWill(java.lang.String&nbsp;topic,
byte[]&nbsp;payload,
int&nbsp;qos,
boolean&nbsp;retained)</pre>
<div class="block">Sets the "Last Will and Testament" (LWT) for the connection.
In the event that this client unexpectedly loses its connection to the
server, the server will publish a message to itself using the supplied
details.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topic</code> - the topic to publish to.</dd>
<dd><code>payload</code> - the byte payload for the message.</dd>
<dd><code>qos</code> - the quality of service to publish the message at (0, 1 or 2).</dd>
<dd><code>retained</code> - whether or not the message should be retained.</dd>
</dl>
</li>
</ul>
<a name="getKeepAliveInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeepAliveInterval</h4>
<pre>public&nbsp;int&nbsp;getKeepAliveInterval()</pre>
<div class="block">Returns the "keep alive" interval.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the keep alive interval.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setKeepAliveInterval-int-"><code>setKeepAliveInterval(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="getMqttVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMqttVersion</h4>
<pre>public&nbsp;int&nbsp;getMqttVersion()</pre>
<div class="block">Returns the MQTT version.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MQTT version.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setMqttVersion-int-"><code>setMqttVersion(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setKeepAliveInterval-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeepAliveInterval</h4>
<pre>public&nbsp;void&nbsp;setKeepAliveInterval(int&nbsp;keepAliveInterval)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the "keep alive" interval.
This value, measured in seconds, defines the maximum time interval
between messages sent or received. It enables the client to
detect if the server is no longer available, without
having to wait for the TCP/IP timeout. The client will ensure
that at least one message travels across the network within each
keep alive period. In the absence of a data-related message during
the time period, the client sends a very small "ping" message, which
the server will acknowledge.
A value of 0 disables keepalive processing in the client.
<p>The default value is 60 seconds</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keepAliveInterval</code> - the interval, measured in seconds, must be >= 0.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code></dd>
</dl>
</li>
</ul>
<a name="getMaxInflight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxInflight</h4>
<pre>public&nbsp;int&nbsp;getMaxInflight()</pre>
<div class="block">Returns the "max inflight".
The max inflight limits to how many messages we can send without receiving acknowledgments.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the max inflight</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setMaxInflight-int-"><code>setMaxInflight(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setMaxInflight-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxInflight</h4>
<pre>public&nbsp;void&nbsp;setMaxInflight(int&nbsp;maxInflight)</pre>
<div class="block">Sets the "max inflight".
please increase this value in a high traffic environment.
<p>The default value is 10</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxInflight</code> - </dd>
</dl>
</li>
</ul>
<a name="getConnectionTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionTimeout</h4>
<pre>public&nbsp;int&nbsp;getConnectionTimeout()</pre>
<div class="block">Returns the connection timeout value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection timeout value.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setConnectionTimeout-int-"><code>setConnectionTimeout(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setConnectionTimeout-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnectionTimeout</h4>
<pre>public&nbsp;void&nbsp;setConnectionTimeout(int&nbsp;connectionTimeout)</pre>
<div class="block">Sets the connection timeout value.
This value, measured in seconds, defines the maximum time interval
the client will wait for the network connection to the MQTT server to be established.
The default timeout is 30 seconds.
A value of 0 disables timeout processing meaning the client will wait until the
network connection is made successfully or fails.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionTimeout</code> - the timeout value, measured in seconds. It must be >0;</dd>
</dl>
</li>
</ul>
<a name="getSocketFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocketFactory</h4>
<pre>public&nbsp;javax.net.SocketFactory&nbsp;getSocketFactory()</pre>
<div class="block">Returns the socket factory that will be used when connecting, or
<code>null</code> if one has not been set.</div>
</li>
</ul>
<a name="setSocketFactory-javax.net.SocketFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocketFactory</h4>
<pre>public&nbsp;void&nbsp;setSocketFactory(javax.net.SocketFactory&nbsp;socketFactory)</pre>
<div class="block">Sets the <code>SocketFactory</code> to use. This allows an application
to apply its own policies around the creation of network sockets. If
using an SSL connection, an <code>SSLSocketFactory</code> can be used
to supply application-specific security settings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketFactory</code> - the factory to use.</dd>
</dl>
</li>
</ul>
<a name="getWillDestination--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWillDestination</h4>
<pre>public&nbsp;java.lang.String&nbsp;getWillDestination()</pre>
<div class="block">Returns the topic to be used for last will and testament (LWT).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MqttTopic to use, or <code>null</code> if LWT is not set.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setWill-org.eclipse.paho.client.mqttv3.MqttTopic-byte:A-int-boolean-"><code>setWill(MqttTopic, byte[], int, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getWillMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWillMessage</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html" title="class in org.eclipse.paho.client.mqttv3">MqttMessage</a>&nbsp;getWillMessage()</pre>
<div class="block">Returns the message to be sent as last will and testament (LWT).
The returned object is "read only". Calling any "setter" methods on
the returned object will result in an
<code>IllegalStateException</code> being thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the message to use, or <code>null</code> if LWT is not set.</dd>
</dl>
</li>
</ul>
<a name="getSSLProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLProperties</h4>
<pre>public&nbsp;java.util.Properties&nbsp;getSSLProperties()</pre>
<div class="block">Returns the SSL properties for the connection.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the properties for the SSL connection</dd>
</dl>
</li>
</ul>
<a name="setSSLProperties-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSSLProperties</h4>
<pre>public&nbsp;void&nbsp;setSSLProperties(java.util.Properties&nbsp;props)</pre>
<div class="block">Sets the SSL properties for the connection. Note that these
properties are only valid if an implementation of the Java
Secure Socket Extensions (JSSE) is available. These properties are
<em>not</em> used if a SocketFactory has been set using
<a href="../../../../../org/eclipse/paho/client/mqttv3/MqttConnectOptions.html#setSocketFactory-javax.net.SocketFactory-"><code>setSocketFactory(SocketFactory)</code></a>.
The following properties can be used:</p>
<dl>
<dt>com.ibm.ssl.protocol</dt>
<dd>One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS.</dd>
<dt>com.ibm.ssl.contextProvider
<dd>Underlying JSSE provider. For example "IBMJSSE2" or "SunJSSE"</dd>
<dt>com.ibm.ssl.keyStore</dt>
<dd>The name of the file that contains the KeyStore object that you
want the KeyManager to use. For example /mydir/etc/key.p12</dd>
<dt>com.ibm.ssl.keyStorePassword</dt>
<dd>The password for the KeyStore object that you want the KeyManager to use.
The password can either be in plain-text,
or may be obfuscated using the static method:
<code>com.ibm.micro.security.Password.obfuscate(char[] password)</code>.
This obfuscates the password using a simple and insecure XOR and Base64
encoding mechanism. Note that this is only a simple scrambler to
obfuscate clear-text passwords.</dd>
<dt>com.ibm.ssl.keyStoreType</dt>
<dd>Type of key store, for example "PKCS12", "JKS", or "JCEKS".</dd>
<dt>com.ibm.ssl.keyStoreProvider</dt>
<dd>Key store provider, for example "IBMJCE" or "IBMJCEFIPS".</dd>
<dt>com.ibm.ssl.trustStore</dt>
<dd>The name of the file that contains the KeyStore object that you
want the TrustManager to use.</dd>
<dt>com.ibm.ssl.trustStorePassword</dt>
<dd>The password for the TrustStore object that you want the
TrustManager to use. The password can either be in plain-text,
or may be obfuscated using the static method:
<code>com.ibm.micro.security.Password.obfuscate(char[] password)</code>.
This obfuscates the password using a simple and insecure XOR and Base64
encoding mechanism. Note that this is only a simple scrambler to
obfuscate clear-text passwords.</dd>
<dt>com.ibm.ssl.trustStoreType</dt>
<dd>The type of KeyStore object that you want the default TrustManager to use.
Same possible values as "keyStoreType".</dd>
<dt>com.ibm.ssl.trustStoreProvider</dt>
<dd>Trust store provider, for example "IBMJCE" or "IBMJCEFIPS".</dd>
<dt>com.ibm.ssl.enabledCipherSuites</dt>
<dd>A list of which ciphers are enabled. Values are dependent on the provider,
for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA.</dd>
<dt>com.ibm.ssl.keyManager</dt>
<dd>Sets the algorithm that will be used to instantiate a KeyManagerFactory object
instead of using the default algorithm available in the platform. Example values:
"IbmX509" or "IBMJ9X509".
</dd>
<dt>com.ibm.ssl.trustManager</dt>
<dd>Sets the algorithm that will be used to instantiate a TrustManagerFactory object
instead of using the default algorithm available in the platform. Example values:
"PKIX" or "IBMJ9X509".
</dd>
</dl></div>
</li>
</ul>
<a name="isCleanSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCleanSession</h4>
<pre>public&nbsp;boolean&nbsp;isCleanSession()</pre>
<div class="block">Returns whether the client and server should remember state for the client across reconnects.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the clean session flag</dd>
</dl>
</li>
</ul>
<a name="setCleanSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCleanSession</h4>
<pre>public&nbsp;void&nbsp;setCleanSession(boolean&nbsp;cleanSession)</pre>
<div class="block">Sets whether the client and server should remember state across restarts and reconnects.
<ul>
<li>If set to false both the client and server will maintain state across
restarts of the client, the server and the connection. As state is maintained:
<ul>
<li>Message delivery will be reliable meeting
the specified QOS even if the client, server or connection are restarted.
<li> The server will treat a subscription as durable.
</ul>
<lI>If set to true the client and server will not maintain state across
restarts of the client, the server or the connection. This means
<ul>
<li>Message delivery to the specified QOS cannot be maintained if the
client, server or connection are restarted
<lI>The server will treat a subscription as non-durable
</ul></div>
</li>
</ul>
<a name="getServerURIs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerURIs</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getServerURIs()</pre>
<div class="block">Return a list of serverURIs the client may connect to</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serverURIs or null if not set</dd>
</dl>
</li>
</ul>
<a name="setServerURIs-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServerURIs</h4>
<pre>public&nbsp;void&nbsp;setServerURIs(java.lang.String[]&nbsp;array)</pre>
<div class="block">Set a list of one or more serverURIs the client may connect to.
<p>
Each <code>serverURI</code> specifies the address of a server that the client may
connect to. Two types of
connection are supported <code>tcp://</code> for a TCP connection and
<code>ssl://</code> for a TCP connection secured by SSL/TLS.
For example:
<ul>
<li><code>tcp://localhost:1883</code></li>
<li><code>ssl://localhost:8883</code></li>
</ul>
If the port is not specified, it will
default to 1883 for <code>tcp://</code>" URIs, and 8883 for <code>ssl://</code> URIs.
<p>
If serverURIs is set then it overrides the serverURI parameter passed in on the
constructor of the MQTT client.
<p>
When an attempt to connect is initiated the client will start with the first
serverURI in the list and work through
the list until a connection is established with a server. If a connection cannot be made to
any of the servers then the connect attempt fails.
<p>
Specifying a list of servers that a client may connect to has several uses:
<ol>
<li>High Availability and reliable message delivery
<p>Some MQTT servers support a high availability feature where two or more
"equal" MQTT servers share state. An MQTT client can connect to any of the "equal"
servers and be assured that messages are reliably delivered and durable subscriptions
are maintained no matter which server the client connects to.
<p>The cleansession flag must be set to false if durable subscriptions and/or reliable
message delivery is required.
<li>Hunt List
<p>A set of servers may be specified that are not "equal" (as in the high availability
option). As no state is shared across the servers reliable message delivery and
durable subscriptions are not valid. The cleansession flag must be set to true if the
hunt list mode is used
</ol>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>array</code> - of serverURIs</dd>
</dl>
</li>
</ul>
<a name="setMqttVersion-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMqttVersion</h4>
<pre>public&nbsp;void&nbsp;setMqttVersion(int&nbsp;MqttVersion)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the MQTT version.
The default action is to connect with version 3.1.1,
and to fall back to 3.1 if that fails.
Version 3.1.1 or 3.1 can be selected specifically, with no fall back,
by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>MqttVersion</code> - the version of the MQTT protocol.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code></dd>
</dl>
</li>
</ul>
<a name="isAutomaticReconnect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutomaticReconnect</h4>
<pre>public&nbsp;boolean&nbsp;isAutomaticReconnect()</pre>
<div class="block">Returns whether the client will automatically attempt to reconnect to the
server if the connection is lost</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the automatic reconnection flag.</dd>
</dl>
</li>
</ul>
<a name="setAutomaticReconnect-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutomaticReconnect</h4>
<pre>public&nbsp;void&nbsp;setAutomaticReconnect(boolean&nbsp;automaticReconnect)</pre>
<div class="block">Sets whether the client will automatically attempt to reconnect to the
server if the connection is lost.
<ul>
<li>If set to false, the client will not attempt to automatically
reconnect to the server in the event that the connection is lost.</li>
<li>If set to true, in the event that the connection is lost, the client
will attempt to reconnect to the server. It will initially wait 1 second before
it attempts to reconnect, for every failed reconnect attempt, the delay will double
until it is at 2 minutes at which point the delay will stay at 2 minutes.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>automaticReconnect</code> - </dd>
</dl>
</li>
</ul>
<a name="getDebug--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDebug</h4>
<pre>public&nbsp;java.util.Properties&nbsp;getDebug()</pre>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</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/MqttConnectOptions.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/MqttClientPersistence.html" title="interface in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttDeliveryToken.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/paho/client/mqttv3/MqttConnectOptions.html" target="_top">Frames</a></li>
<li><a href="MqttConnectOptions.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>