| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ReconnectOptions (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.client, class: ReconnectOptions"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ReconnectOptions.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client</a></div> |
| <h1 title="Class ReconnectOptions" class="title">Class ReconnectOptions</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.client.ReconnectOptions</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <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" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ReconnectOptions</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_MAX_RECONNECT_DELAY" class="member-name-link">DEFAULT_MAX_RECONNECT_DELAY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final double</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_RECONNECT_BACKOFF_MULTIPLIER" class="member-name-link">DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_RECONNECT_DELAY" class="member-name-link">DEFAULT_RECONNECT_DELAY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_RECONNECT_ENABLED" class="member-name-link">DEFAULT_RECONNECT_ENABLED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_USE_RECONNECT_BACKOFF" class="member-name-link">DEFAULT_USE_RECONNECT_BACKOFF</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS" class="member-name-link">DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#INFINITE" class="member-name-link">INFINITE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ReconnectOptions</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.ReconnectOptions)" class="member-name-link">ReconnectOptions</a><wbr>(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a> options)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addReconnectLocation(java.lang.String,int)" class="member-name-link">addReconnectLocation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds an additional reconnection location that can be used when attempting to reconnect the client |
| following a connection failure.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyInto(org.apache.qpid.protonj2.client.ReconnectOptions)" class="member-name-link">copyInto</a><wbr>(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a> other)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxInitialConnectionAttempts()" class="member-name-link">maxInitialConnectionAttempts</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxInitialConnectionAttempts(int)" class="member-name-link">maxInitialConnectionAttempts</a><wbr>(int maxInitialConnectionAttempts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxReconnectAttempts()" class="member-name-link">maxReconnectAttempts</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxReconnectAttempts(int)" class="member-name-link">maxReconnectAttempts</a><wbr>(int maxReconnectionAttempts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The number of reconnection attempts allowed before reporting the connection as failed to the client.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxReconnectDelay()" class="member-name-link">maxReconnectDelay</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxReconnectDelay(int)" class="member-name-link">maxReconnectDelay</a><wbr>(int maxReconnectDelay)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The maximum time that the client will wait before attempting a reconnect.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectBackOffMultiplier()" class="member-name-link">reconnectBackOffMultiplier</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectBackOffMultiplier(double)" class="member-name-link">reconnectBackOffMultiplier</a><wbr>(double reconnectBackOffMultiplier)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The multiplier used to grow the reconnection delay value, defaults to 2.0d.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectDelay()" class="member-name-link">reconnectDelay</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectDelay(int)" class="member-name-link">reconnectDelay</a><wbr>(int reconnectDelay)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Controls the delay between successive reconnection attempts, defaults to 10 milliseconds.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectEnabled()" class="member-name-link">reconnectEnabled</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectEnabled(boolean)" class="member-name-link">reconnectEnabled</a><wbr>(boolean reconnectEnabled)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reconnectLocations()" class="member-name-link">reconnectLocations</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#useReconnectBackOff()" class="member-name-link">useReconnectBackOff</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#useReconnectBackOff(boolean)" class="member-name-link">useReconnectBackOff</a><wbr>(boolean useReconnectBackOff)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Controls whether the time between reconnection attempts should grow based on a configured multiplier.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#warnAfterReconnectAttempts()" class="member-name-link">warnAfterReconnectAttempts</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#warnAfterReconnectAttempts(int)" class="member-name-link">warnAfterReconnectAttempts</a><wbr>(int warnAfterReconnectAttempts)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Controls how often the client will log a message indicating that a reconnection is being attempted.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_RECONNECT_ENABLED"> |
| <h3>DEFAULT_RECONNECT_ENABLED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">DEFAULT_RECONNECT_ENABLED</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_RECONNECT_ENABLED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INFINITE"> |
| <h3>INFINITE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">INFINITE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.INFINITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS"> |
| <h3>DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_RECONNECT_DELAY"> |
| <h3>DEFAULT_RECONNECT_DELAY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_RECONNECT_DELAY</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_RECONNECT_DELAY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_RECONNECT_DELAY"> |
| <h3>DEFAULT_MAX_RECONNECT_DELAY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_MAX_RECONNECT_DELAY</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_MAX_RECONNECT_DELAY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_USE_RECONNECT_BACKOFF"> |
| <h3>DEFAULT_USE_RECONNECT_BACKOFF</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">DEFAULT_USE_RECONNECT_BACKOFF</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_USE_RECONNECT_BACKOFF">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_RECONNECT_BACKOFF_MULTIPLIER"> |
| <h3>DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">DEFAULT_RECONNECT_BACKOFF_MULTIPLIER</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ReconnectOptions.DEFAULT_RECONNECT_BACKOFF_MULTIPLIER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ReconnectOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReconnectOptions</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.qpid.protonj2.client.ReconnectOptions)"> |
| <h3>ReconnectOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReconnectOptions</span><wbr><span class="parameters">(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a> options)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">clone</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copyInto(org.apache.qpid.protonj2.client.ReconnectOptions)"> |
| <h3>copyInto</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">copyInto</span><wbr><span class="parameters">(<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a> other)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>other</code> - the target of this copy operation.</dd> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectEnabled()"> |
| <h3>reconnectEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">reconnectEnabled</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the reconnect enabled configuration state for this options instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectEnabled(boolean)"> |
| <h3>reconnectEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">reconnectEnabled</span><wbr><span class="parameters">(boolean reconnectEnabled)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addReconnectLocation(java.lang.String,int)"> |
| <h3>addReconnectLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">addReconnectLocation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port)</span></div> |
| <div class="block">Adds an additional reconnection location that can be used when attempting to reconnect the client |
| following a connection failure.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectLocations()"> |
| <h3>reconnectLocations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a>></span> <span class="element-name">reconnectLocations</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an unmodifiable view of the configured reconnect locations.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warnAfterReconnectAttempts()"> |
| <h3>warnAfterReconnectAttempts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">warnAfterReconnectAttempts</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of reconnection attempt before the client should log a warning.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warnAfterReconnectAttempts(int)"> |
| <h3>warnAfterReconnectAttempts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">warnAfterReconnectAttempts</span><wbr><span class="parameters">(int warnAfterReconnectAttempts)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>warnAfterReconnectAttempts</code> - The number of attempts before logging an update about not yet reconnecting.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxInitialConnectionAttempts()"> |
| <h3>maxInitialConnectionAttempts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">maxInitialConnectionAttempts</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured maximum number of initial connection attempts to try before giving up</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxInitialConnectionAttempts(int)"> |
| <h3>maxInitialConnectionAttempts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">maxInitialConnectionAttempts</span><wbr><span class="parameters">(int maxInitialConnectionAttempts)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>maxInitialConnectionAttempts</code> - the maximum number of initial connection attempts to try before giving up.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxReconnectAttempts()"> |
| <h3>maxReconnectAttempts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">maxReconnectAttempts</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured maximum number of reconnection attempts to try before giving up</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxReconnectAttempts(int)"> |
| <h3>maxReconnectAttempts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">maxReconnectAttempts</span><wbr><span class="parameters">(int maxReconnectionAttempts)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>maxReconnectionAttempts</code> - the maximum number of reconnection attempts to try before giving up.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectDelay()"> |
| <h3>reconnectDelay</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">reconnectDelay</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured reconnect delay to use after between attempts to connect or reconnect.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectDelay(int)"> |
| <h3>reconnectDelay</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">reconnectDelay</span><wbr><span class="parameters">(int reconnectDelay)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>reconnectDelay</code> - The reconnect delay to apply to successive attempts to reconnect.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxReconnectDelay()"> |
| <h3>maxReconnectDelay</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">maxReconnectDelay</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured maximum reconnect attempt delay allowed when using delay back off scheduling.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxReconnectDelay(int)"> |
| <h3>maxReconnectDelay</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">maxReconnectDelay</span><wbr><span class="parameters">(int maxReconnectDelay)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>maxReconnectDelay</code> - The maximum interval allowed when connection attempt back off is in effect.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="useReconnectBackOff()"> |
| <h3>useReconnectBackOff</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">useReconnectBackOff</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>if the reconnection attempts will be delayed using a back off multiplier.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="useReconnectBackOff(boolean)"> |
| <h3>useReconnectBackOff</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">useReconnectBackOff</span><wbr><span class="parameters">(boolean useReconnectBackOff)</span></div> |
| <div class="block">Controls whether the time between reconnection attempts should grow based on a configured multiplier. |
| This option defaults to true.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useReconnectBackOff</code> - should connection attempts use a back off of the configured delay.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectBackOffMultiplier()"> |
| <h3>reconnectBackOffMultiplier</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">reconnectBackOffMultiplier</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the multiplier used when the reconnection back off feature is enabled.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconnectBackOffMultiplier(double)"> |
| <h3>reconnectBackOffMultiplier</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span> <span class="element-name">reconnectBackOffMultiplier</span><wbr><span class="parameters">(double reconnectBackOffMultiplier)</span></div> |
| <div class="block">The multiplier used to grow the reconnection delay value, defaults to 2.0d.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>reconnectBackOffMultiplier</code> - the delay multiplier used when building delay between reconnection attempts.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
