Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / content / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / ReconnectOptions.html
blob: d5b88d4a51a1e360ca9929dceac1815abbc64e88 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ReconnectOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="ReconnectOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"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};
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>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReconnectOptions.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="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
<h2 title="Class ReconnectOptions" class="title">Class ReconnectOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.ReconnectOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ReconnectOptions</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre>
<div class="block">Options that control the reconnection behavior of a client <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_MAX_RECONNECT_DELAY">DEFAULT_MAX_RECONNECT_DELAY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_RECONNECT_BACKOFF_MULTIPLIER">DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_RECONNECT_DELAY">DEFAULT_RECONNECT_DELAY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_RECONNECT_ENABLED">DEFAULT_RECONNECT_ENABLED</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_USE_RECONNECT_BACKOFF">DEFAULT_USE_RECONNECT_BACKOFF</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS">DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INFINITE">INFINITE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ReconnectOptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance configured with default configuration settings.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.ReconnectOptions)">ReconnectOptions</a></span>&#8203;(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Creates a <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance that is a copy of the given instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addReconnectLocation(java.lang.String,int)">addReconnectLocation</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;host,
int&nbsp;port)</code></th>
<td class="colLast">
<div class="block">Adds an additional reconnection location that can be used when attempting to reconnect the client
following a connection failure.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.ReconnectOptions)">copyInto</a></span>&#8203;(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Copy all options from this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance into the instance
provided.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxInitialConnectionAttempts()">maxInitialConnectionAttempts</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxInitialConnectionAttempts(int)">maxInitialConnectionAttempts</a></span>&#8203;(int&nbsp;maxInitialConnectionAttempts)</code></th>
<td class="colLast">
<div class="block">For a client that has never connected to a remote peer before this option controls how many attempts
are made to connect before reporting the connection as failed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxReconnectAttempts()">maxReconnectAttempts</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxReconnectAttempts(int)">maxReconnectAttempts</a></span>&#8203;(int&nbsp;maxReconnectionAttempts)</code></th>
<td class="colLast">
<div class="block">The number of reconnection attempts allowed before reporting the connection as failed to the client.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxReconnectDelay()">maxReconnectDelay</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxReconnectDelay(int)">maxReconnectDelay</a></span>&#8203;(int&nbsp;maxReconnectDelay)</code></th>
<td class="colLast">
<div class="block">The maximum time that the client will wait before attempting a reconnect.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectBackOffMultiplier()">reconnectBackOffMultiplier</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectBackOffMultiplier(double)">reconnectBackOffMultiplier</a></span>&#8203;(double&nbsp;reconnectBackOffMultiplier)</code></th>
<td class="colLast">
<div class="block">The multiplier used to grow the reconnection delay value, defaults to 2.0d.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectDelay()">reconnectDelay</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectDelay(int)">reconnectDelay</a></span>&#8203;(int&nbsp;reconnectDelay)</code></th>
<td class="colLast">
<div class="block">Controls the delay between successive reconnection attempts, defaults to 10 milliseconds.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectEnabled()">reconnectEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if reconnect is currently enabled for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> that
these options are assigned to.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectEnabled(boolean)">reconnectEnabled</a></span>&#8203;(boolean&nbsp;reconnectEnabled)</code></th>
<td class="colLast">
<div class="block">Set to <code>true</code> to enable reconnection support on the associated <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
or <code>false</code> to disable.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectLocations()">reconnectLocations</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useReconnectBackOff()">useReconnectBackOff</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useReconnectBackOff(boolean)">useReconnectBackOff</a></span>&#8203;(boolean&nbsp;useReconnectBackOff)</code></th>
<td class="colLast">
<div class="block">Controls whether the time between reconnection attempts should grow based on a configured multiplier.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#warnAfterReconnectAttempts()">warnAfterReconnectAttempts</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#warnAfterReconnectAttempts(int)">warnAfterReconnectAttempts</a></span>&#8203;(int&nbsp;warnAfterReconnectAttempts)</code></th>
<td class="colLast">
<div class="block">Controls how often the client will log a message indicating that a reconnection is being attempted.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_RECONNECT_ENABLED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_RECONNECT_ENABLED</h4>
<pre>public static final&nbsp;boolean DEFAULT_RECONNECT_ENABLED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_RECONNECT_ENABLED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="INFINITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INFINITE</h4>
<pre>public static final&nbsp;int INFINITE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.INFINITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</h4>
<pre>public static final&nbsp;int DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_RECONNECT_DELAY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_RECONNECT_DELAY</h4>
<pre>public static final&nbsp;int DEFAULT_RECONNECT_DELAY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_RECONNECT_DELAY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_MAX_RECONNECT_DELAY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_RECONNECT_DELAY</h4>
<pre>public static final&nbsp;int DEFAULT_MAX_RECONNECT_DELAY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_MAX_RECONNECT_DELAY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_USE_RECONNECT_BACKOFF">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_USE_RECONNECT_BACKOFF</h4>
<pre>public static final&nbsp;boolean DEFAULT_USE_RECONNECT_BACKOFF</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_USE_RECONNECT_BACKOFF">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_RECONNECT_BACKOFF_MULTIPLIER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</h4>
<pre>public static final&nbsp;double DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_RECONNECT_BACKOFF_MULTIPLIER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReconnectOptions</h4>
<pre>public&nbsp;ReconnectOptions()</pre>
<div class="block">Create a new <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance configured with default configuration settings.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.qpid.protonj2.client.ReconnectOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReconnectOptions</h4>
<pre>public&nbsp;ReconnectOptions&#8203;(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;options)</pre>
<div class="block">Creates a <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance that is a copy of the given instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - The <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance whose configuration should be copied to this one.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="copyInto(org.apache.qpid.protonj2.client.ReconnectOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">protected&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;copyInto&#8203;(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;other)</pre>
<div class="block">Copy all options from this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance into the instance
provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the target of this copy operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance that was given.</dd>
</dl>
</li>
</ul>
<a id="reconnectEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectEnabled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;reconnectEnabled()</pre>
<div class="block">Returns <code>true</code> if reconnect is currently enabled for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> that
these options are assigned to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the reconnect enabled configuration state for this options instance.</dd>
</dl>
</li>
</ul>
<a id="reconnectEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectEnabled</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;reconnectEnabled&#8203;(boolean&nbsp;reconnectEnabled)</pre>
<div class="block">Set to <code>true</code> to enable reconnection support on the associated <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
or <code>false</code> to disable. When enabled a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> will attempt to reconnect
to a remote based on the configuration set in this options instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reconnectEnabled</code> - Controls if reconnection is enabled or not for the associated <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="addReconnectLocation(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addReconnectLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;addReconnectLocation&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;host,
int&nbsp;port)</pre>
<div class="block">Adds an additional reconnection location that can be used when attempting to reconnect the client
following a connection failure.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - The host name of the remote host to attempt a reconnection to.</dd>
<dd><code>port</code> - The port on the remote host to use when connecting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="reconnectLocations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectLocations</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>&gt;&nbsp;reconnectLocations()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unmodifiable view of the configured reconnect locations.</dd>
</dl>
</li>
</ul>
<a id="warnAfterReconnectAttempts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>warnAfterReconnectAttempts</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;warnAfterReconnectAttempts()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of reconnection attempt before the client should log a warning.</dd>
</dl>
</li>
</ul>
<a id="warnAfterReconnectAttempts(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>warnAfterReconnectAttempts</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;warnAfterReconnectAttempts&#8203;(int&nbsp;warnAfterReconnectAttempts)</pre>
<div class="block">Controls how often the client will log a message indicating that a reconnection is being attempted.
The default is to log every 10 connection attempts.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>warnAfterReconnectAttempts</code> - The number of attempts before logging an update about not yet reconnecting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="maxInitialConnectionAttempts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxInitialConnectionAttempts</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;maxInitialConnectionAttempts()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured maximum number of initial connection attempts to try before giving up</dd>
</dl>
</li>
</ul>
<a id="maxInitialConnectionAttempts(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxInitialConnectionAttempts</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;maxInitialConnectionAttempts&#8203;(int&nbsp;maxInitialConnectionAttempts)</pre>
<div class="block">For a client that has never connected to a remote peer before this option controls how many attempts
are made to connect before reporting the connection as failed. The default behavior is to use the
value of maxReconnectAttempts.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxInitialConnectionAttempts</code> - the maximum number of initial connection attempts to try before giving up.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="maxReconnectAttempts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxReconnectAttempts</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;maxReconnectAttempts()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured maximum number of reconnection attempts to try before giving up</dd>
</dl>
</li>
</ul>
<a id="maxReconnectAttempts(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxReconnectAttempts</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;maxReconnectAttempts&#8203;(int&nbsp;maxReconnectionAttempts)</pre>
<div class="block">The number of reconnection attempts allowed before reporting the connection as failed to the client.
The default is no limit or (-1).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxReconnectionAttempts</code> - the maximum number of reconnection attempts to try before giving up.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="reconnectDelay()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectDelay</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;reconnectDelay()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured reconnect delay to use after between attempts to connect or reconnect.</dd>
</dl>
</li>
</ul>
<a id="reconnectDelay(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectDelay</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;reconnectDelay&#8203;(int&nbsp;reconnectDelay)</pre>
<div class="block">Controls the delay between successive reconnection attempts, defaults to 10 milliseconds. If the
back off option is not enabled this value remains constant.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reconnectDelay</code> - The reconnect delay to apply to successive attempts to reconnect.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="maxReconnectDelay()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxReconnectDelay</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;maxReconnectDelay()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured maximum reconnect attempt delay allowed when using delay back off scheduling.</dd>
</dl>
</li>
</ul>
<a id="maxReconnectDelay(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxReconnectDelay</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;maxReconnectDelay&#8203;(int&nbsp;maxReconnectDelay)</pre>
<div class="block">The maximum time that the client will wait before attempting a reconnect. This value is only used when the
back off feature is enabled to ensure that the delay does not grow too large. Defaults to 30 seconds as the
max time between successive connection attempts.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxReconnectDelay</code> - The maximum interval allowed when connection attempt back off is in effect.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="useReconnectBackOff()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useReconnectBackOff</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;useReconnectBackOff()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the reconnection attempts will be delayed using a back off multiplier.</dd>
</dl>
</li>
</ul>
<a id="useReconnectBackOff(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useReconnectBackOff</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;useReconnectBackOff&#8203;(boolean&nbsp;useReconnectBackOff)</pre>
<div class="block">Controls whether the time between reconnection attempts should grow based on a configured multiplier.
This option defaults to true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useReconnectBackOff</code> - should connection attempts use a back off of the configured delay.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="reconnectBackOffMultiplier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectBackOffMultiplier</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;reconnectBackOffMultiplier()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the multiplier used when the reconnection back off feature is enabled.</dd>
</dl>
</li>
</ul>
<a id="reconnectBackOffMultiplier(double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reconnectBackOffMultiplier</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;reconnectBackOffMultiplier&#8203;(double&nbsp;reconnectBackOffMultiplier)</pre>
<div class="block">The multiplier used to grow the reconnection delay value, defaults to 2.0d.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reconnectBackOffMultiplier</code> - the delay multiplier used when building delay between reconnection attempts.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReconnectOptions.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="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>