| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Class org.apache.qpid.protonj2.client.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="use: package: org.apache.qpid.protonj2.client, class: ReconnectOptions"> |
| <meta name="generator" content="javadoc/ClassUseWriter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-use-page"> |
| <script type="text/javascript"></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><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">Class</a></li> |
| <li class="nav-bar-cell1-rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#use">Help</a></li> |
| </ul> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Uses of Class org.apache.qpid.protonj2.client.ReconnectOptions" class="title">Uses of Class<br>org.apache.qpid.protonj2.client.ReconnectOptions</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.client">org.apache.qpid.protonj2.client</a></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <section class="class-uses"> |
| <ul class="block-list"> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.client"> |
| <h2>Uses of <a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a></h2> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> that return <a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></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">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#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"> |
| <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"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><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"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#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"> |
| <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"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#maxInitialConnectionAttempts(int)" class="member-name-link">maxInitialConnectionAttempts</a><wbr>(int maxInitialConnectionAttempts)</code></div> |
| <div class="col-last odd-row-color"> |
| <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 even-row-color"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#maxReconnectAttempts(int)" class="member-name-link">maxReconnectAttempts</a><wbr>(int maxReconnectionAttempts)</code></div> |
| <div class="col-last even-row-color"> |
| <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"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#maxReconnectDelay(int)" class="member-name-link">maxReconnectDelay</a><wbr>(int maxReconnectDelay)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The maximum time that the client will wait before attempting a reconnect.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#reconnectBackOffMultiplier(double)" class="member-name-link">reconnectBackOffMultiplier</a><wbr>(double reconnectBackOffMultiplier)</code></div> |
| <div class="col-last even-row-color"> |
| <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"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#reconnectDelay(int)" class="member-name-link">reconnectDelay</a><wbr>(int reconnectDelay)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Controls the delay between successive reconnection attempts, defaults to 10 milliseconds.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#reconnectEnabled(boolean)" class="member-name-link">reconnectEnabled</a><wbr>(boolean reconnectEnabled)</code></div> |
| <div class="col-last even-row-color"> |
| <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"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ConnectionOptions.</span><code><a href="../ConnectionOptions.html#reconnectOptions()" class="member-name-link">reconnectOptions</a>()</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#useReconnectBackOff(boolean)" class="member-name-link">useReconnectBackOff</a><wbr>(boolean useReconnectBackOff)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Controls whether the time between reconnection attempts should grow based on a configured multiplier.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#warnAfterReconnectAttempts(int)" class="member-name-link">warnAfterReconnectAttempts</a><wbr>(int warnAfterReconnectAttempts)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Controls how often the client will log a message indicating that a reconnection is being attempted.</div> |
| </div> |
| </div> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> with parameters of type <a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></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">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><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"><span class="type-name-label">ReconnectOptions.</span><code><a href="../ReconnectOptions.html#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"> |
| <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> |
| <div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> with parameters of type <a href="../ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-second even-row-color"><code><a href="../ReconnectOptions.html#%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 even-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> |
| </ul> |
| </section> |
| </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> |
