blob: 04816fed6ad11b1f3797221fc314c40121aa6b62 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ConnectionOptions (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="ConnectionOptions (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,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":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/ConnectionOptions.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 ConnectionOptions" class="title">Class ConnectionOptions</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.ConnectionOptions</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">ConnectionOptions</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 behavior of the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> created from them.</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_CHANNEL_MAX">DEFAULT_CHANNEL_MAX</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CLOSE_TIMEOUT">DEFAULT_CLOSE_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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="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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_DESIRED_CAPABILITIES">DEFAULT_DESIRED_CAPABILITIES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_DRAIN_TIMEOUT">DEFAULT_DRAIN_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_IDLE_TIMEOUT">DEFAULT_IDLE_TIMEOUT</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_MAX_FRAME_SIZE">DEFAULT_MAX_FRAME_SIZE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_NEXT_RECEIVER_POLICY">DEFAULT_NEXT_RECEIVER_POLICY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_OPEN_TIMEOUT">DEFAULT_OPEN_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_REQUEST_TIMEOUT">DEFAULT_REQUEST_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_SEND_TIMEOUT">DEFAULT_SEND_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</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()">ConnectionOptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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.ConnectionOptions)">ConnectionOptions</a></span>&#8203;(<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Creates a <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#channelMax()">channelMax</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#channelMax(int)">channelMax</a></span>&#8203;(int&nbsp;channelMax)</code></th>
<td class="colLast">
<div class="block">Configure the channel maximum value for the new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> created with these options.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</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="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeTimeout()">closeTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeTimeout(long)">closeTimeout</a></span>&#8203;(long&nbsp;closeTimeout)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to close
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> h
as been honored.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeTimeout(long,java.util.concurrent.TimeUnit)">closeTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to close
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> h
as been honored.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectedHandler()">connectedHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectedHandler(java.util.function.BiConsumer)">connectedHandler</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;&nbsp;connectedHandler)</code></th>
<td class="colLast">
<div class="block">Configures a handler that will be notified when a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> has established.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.ConnectionOptions)">copyInto</a></span>&#8203;(<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Copy all options from this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance into the instance
provided.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultNextReceiverPolicy()">defaultNextReceiverPolicy</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultNextReceiverPolicy(org.apache.qpid.protonj2.client.NextReceiverPolicy)">defaultNextReceiverPolicy</a></span>&#8203;(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a>&nbsp;policy)</code></th>
<td class="colLast">
<div class="block">Configures the default next receiver policy for this connection and any session
that is created without specifying user defined session default options.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><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>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#desiredCapabilities()">desiredCapabilities</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#desiredCapabilities(java.lang.String...)">desiredCapabilities</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;desiredCapabilities)</code></th>
<td class="colLast">
<div class="block">Sets the collection of capabilities to request from the remote for a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
created using these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disconnectedHandler()">disconnectedHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disconnectedHandler(java.util.function.BiConsumer)">disconnectedHandler</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;&nbsp;disconnectedHandler)</code></th>
<td class="colLast">
<div class="block">Configures a handler that will be notified when the connection has failed and cannot be recovered
should reconnect be enabled.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTimeout()">drainTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTimeout(long)">drainTimeout</a></span>&#8203;(long&nbsp;drainTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the drain timeout (in milliseconds) after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTimeout(long,java.util.concurrent.TimeUnit)">drainTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Sets the drain timeout value after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#idleTimeout()">idleTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#idleTimeout(long)">idleTimeout</a></span>&#8203;(long&nbsp;idleTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the idle timeout (in milliseconds) after which the connection will
be closed if the peer has not send any data.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#idleTimeout(long,java.util.concurrent.TimeUnit)">idleTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Sets the idle timeout value after which the connection will be closed
if the peer has not send any data.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#interruptedHandler()">interruptedHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#interruptedHandler(java.util.function.BiConsumer)">interruptedHandler</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;&nbsp;interruptedHandler)</code></th>
<td class="colLast">
<div class="block">Configures a handler that will be notified when the current <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> experiences an
interruption.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxFrameSize()">maxFrameSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxFrameSize(int)">maxFrameSize</a></span>&#8203;(int&nbsp;maxFrameSize)</code></th>
<td class="colLast">
<div class="block">Sets the max frame size (in bytes), values of -1 indicates to use the client selected default.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><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>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities()">offeredCapabilities</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities(java.lang.String...)">offeredCapabilities</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;offeredCapabilities)</code></th>
<td class="colLast">
<div class="block">Sets the collection of capabilities to offer to the remote from a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
created using these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openTimeout()">openTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openTimeout(long)">openTimeout</a></span>&#8203;(long&nbsp;openTimeout)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to open
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>
has been honored.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openTimeout(long,java.util.concurrent.TimeUnit)">openTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to open
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>
has been honored.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><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></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#password()">password</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#password(java.lang.String)">password</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;password)</code></th>
<td class="colLast">
<div class="block">Sets the password used when performing connection authentication.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties(java.util.Map)">properties</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;<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>&gt;&nbsp;properties)</code></th>
<td class="colLast">
<div class="block">Sets a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> of properties to convey to the remote when a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
is created from these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectedHandler()">reconnectedHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectedHandler(java.util.function.BiConsumer)">reconnectedHandler</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;&nbsp;reconnectedHandler)</code></th>
<td class="colLast">
<div class="block">Configures a handler that will be notified when a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> that has previously
experienced and interruption has been reconnected to a remote based on the reconnection
configuration.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</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">Controls if the connection will attempt to reconnect if unable to connect immediately
or if an existing connection fails.</div>
</td>
</tr>
<tr id="i38" 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="#reconnectOptions()">reconnectOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestTimeout()">requestTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestTimeout(long)">requestTimeout</a></span>&#8203;(long&nbsp;requestTimeout)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to
perform some action such as starting a new transaction.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestTimeout(long,java.util.concurrent.TimeUnit)">requestTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to
perform some action such as starting a new transaction.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="SaslOptions.html" title="class in org.apache.qpid.protonj2.client">SaslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saslOptions()">saslOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTimeout()">sendTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTimeout(long)">sendTimeout</a></span>&#8203;(long&nbsp;sendTimeout)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTimeout(long,java.util.concurrent.TimeUnit)">sendTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslEnabled()">sslEnabled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslEnabled(boolean)">sslEnabled</a></span>&#8203;(boolean&nbsp;sslEnabled)</code></th>
<td class="colLast">
<div class="block">Controls if the connection will attempt to connect using a secure IO layer or not.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslOptions()">sslOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traceFrames()">traceFrames</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traceFrames(boolean)">traceFrames</a></span>&#8203;(boolean&nbsp;traceFrames)</code></th>
<td class="colLast">
<div class="block">Configure if the newly created connection should enabled AMQP frame tracing to the
system output.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transportOptions()">transportOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><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></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#user()">user</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#user(java.lang.String)">user</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;user)</code></th>
<td class="colLast">
<div class="block">Sets the user name used when performing connection authentication.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><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></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#virtualHost()">virtualHost</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#virtualHost(java.lang.String)">virtualHost</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;virtualHost)</code></th>
<td class="colLast">
<div class="block">The virtual host value to provide to the remote when creating a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</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_DESIRED_CAPABILITIES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_DESIRED_CAPABILITIES</h4>
<pre>public static final&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="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>&gt; DEFAULT_DESIRED_CAPABILITIES</pre>
</li>
</ul>
<a id="INFINITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INFINITE</h4>
<pre>public static final&nbsp;long INFINITE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.INFINITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_OPEN_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_OPEN_TIMEOUT</h4>
<pre>public static final&nbsp;long DEFAULT_OPEN_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_OPEN_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_CLOSE_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CLOSE_TIMEOUT</h4>
<pre>public static final&nbsp;long DEFAULT_CLOSE_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_CLOSE_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_SEND_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SEND_TIMEOUT</h4>
<pre>public static final&nbsp;long DEFAULT_SEND_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_SEND_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_REQUEST_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_REQUEST_TIMEOUT</h4>
<pre>public static final&nbsp;long DEFAULT_REQUEST_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_REQUEST_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_IDLE_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_IDLE_TIMEOUT</h4>
<pre>public static final&nbsp;long DEFAULT_IDLE_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_IDLE_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_DRAIN_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_DRAIN_TIMEOUT</h4>
<pre>public static final&nbsp;long DEFAULT_DRAIN_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_DRAIN_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_CHANNEL_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CHANNEL_MAX</h4>
<pre>public static final&nbsp;int DEFAULT_CHANNEL_MAX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_CHANNEL_MAX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_MAX_FRAME_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_FRAME_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_MAX_FRAME_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.ConnectionOptions.DEFAULT_MAX_FRAME_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_NEXT_RECEIVER_POLICY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_NEXT_RECEIVER_POLICY</h4>
<pre>public static final&nbsp;<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a> DEFAULT_NEXT_RECEIVER_POLICY</pre>
</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>ConnectionOptions</h4>
<pre>public&nbsp;ConnectionOptions()</pre>
<div class="block">Create a new <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance configured with default configuration settings.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.qpid.protonj2.client.ConnectionOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConnectionOptions</h4>
<pre>public&nbsp;ConnectionOptions&#8203;(<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;options)</pre>
<div class="block">Creates a <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</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.ConnectionOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">protected&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;copyInto&#8203;(<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;other)</pre>
<div class="block">Copy all options from this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance that was given.</dd>
</dl>
</li>
</ul>
<a id="closeTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;closeTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout used when awaiting a response from the remote when a resource is closed.</dd>
</dl>
</li>
</ul>
<a id="closeTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;closeTimeout&#8203;(long&nbsp;closeTimeout)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to close
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> h
as been honored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>closeTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="closeTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;closeTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to close
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> h
as been honored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="openTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;openTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout used when awaiting a response from the remote when a resource is opened.</dd>
</dl>
</li>
</ul>
<a id="openTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;openTimeout&#8203;(long&nbsp;openTimeout)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to open
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>
has been honored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>openTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="openTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;openTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to open
a resource such as a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>, <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>, <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>
has been honored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="sendTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;sendTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout used when awaiting a response from the remote when a resource is message send.</dd>
</dl>
</li>
</ul>
<a id="sendTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;sendTimeout&#8203;(long&nbsp;sendTimeout)</pre>
<div class="block">Configures the timeout used when awaiting a send operation to complete. A send will block if the
remote has not granted the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> credit to do so, if the send blocks
for longer than this timeout the send call will fail with an <a href="exceptions/ClientSendTimedOutException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientSendTimedOutException</code></a>
exception to indicate that the send did not complete.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sendTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="sendTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;sendTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Configures the timeout used when awaiting a send operation to complete. A send will block if the
remote has not granted the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> or the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> credit to do so, if the send blocks
for longer than this timeout the send call will fail with an <a href="exceptions/ClientSendTimedOutException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientSendTimedOutException</code></a>
exception to indicate that the send did not complete.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="requestTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;requestTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout used when awaiting a response from the remote when a resource makes a request.</dd>
</dl>
</li>
</ul>
<a id="requestTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;requestTimeout&#8203;(long&nbsp;requestTimeout)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to
perform some action such as starting a new transaction. If the remote does not respond
within the configured timeout the resource making the request will mark it as failed and
return an error to the request initiator usually in the form of a
<a href="exceptions/ClientOperationTimedOutException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientOperationTimedOutException</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="requestTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;requestTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to
perform some action such as starting a new transaction. If the remote does not respond
within the configured timeout the resource making the request will mark it as failed and
return an error to the request initiator usually in the form of a
<a href="exceptions/ClientOperationTimedOutException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientOperationTimedOutException</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="channelMax()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>channelMax</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;channelMax()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured or default channel max value for create <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="channelMax(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>channelMax</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;channelMax&#8203;(int&nbsp;channelMax)</pre>
<div class="block">Configure the channel maximum value for the new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> created with these options.
<p>
The channel max value controls how many <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instances can be created by a given
Connection, the default value is <i>65535</i>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channelMax</code> - The channel max value to assign to newly created <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="maxFrameSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxFrameSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;maxFrameSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configure maximum frame size value for newly create <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="maxFrameSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxFrameSize</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;maxFrameSize&#8203;(int&nbsp;maxFrameSize)</pre>
<div class="block">Sets the max frame size (in bytes), values of -1 indicates to use the client selected default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxFrameSize</code> - the frame size in bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="idleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>idleTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;idleTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured idle timeout value that will be sent to the remote.</dd>
</dl>
</li>
</ul>
<a id="idleTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>idleTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;idleTimeout&#8203;(long&nbsp;idleTimeout)</pre>
<div class="block">Sets the idle timeout (in milliseconds) after which the connection will
be closed if the peer has not send any data. The provided value will be
halved before being transmitted as our advertised idle-timeout in the
AMQP <a href="../types/transport/Open.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Open</code></a> frame.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>idleTimeout</code> - the timeout in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="idleTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>idleTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;idleTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Sets the idle timeout value after which the connection will be closed
if the peer has not send any data. The provided value will be halved before
being transmitted as our advertised idle-timeout in the AMQP <a href="../types/transport/Open.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Open</code></a> frame.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="drainTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;drainTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured drain timeout value that will use to fail a pending drain request.</dd>
</dl>
</li>
</ul>
<a id="drainTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;drainTimeout&#8203;(long&nbsp;drainTimeout)</pre>
<div class="block">Sets the drain timeout (in milliseconds) after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>drainTimeout</code> - the drainTimeout to use for receiver links.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="drainTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;drainTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Sets the drain timeout value after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="offeredCapabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offeredCapabilities</h4>
<pre class="methodSignature">public&nbsp;<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;offeredCapabilities()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the offeredCapabilities that have been configured.</dd>
</dl>
</li>
</ul>
<a id="offeredCapabilities(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offeredCapabilities</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;offeredCapabilities&#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;offeredCapabilities)</pre>
<div class="block">Sets the collection of capabilities to offer to the remote from a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
created using these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>. The offered capabilities advertise to the
remote capabilities that this <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> supports.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offeredCapabilities</code> - the offeredCapabilities to set on a new <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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="desiredCapabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>desiredCapabilities</h4>
<pre class="methodSignature">public&nbsp;<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;desiredCapabilities()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the desiredCapabilities that have been configured.</dd>
</dl>
</li>
</ul>
<a id="desiredCapabilities(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>desiredCapabilities</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;desiredCapabilities&#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;desiredCapabilities)</pre>
<div class="block">Sets the collection of capabilities to request from the remote for a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
created using these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>. The desired capabilities inform the remote
peer of the various capabilities the new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> requires and the remote should
return those that it supports in its offered capabilities.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>desiredCapabilities</code> - the desiredCapabilities to set on a new <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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="properties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;<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>&gt;&nbsp;properties()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the properties that have been configured.</dd>
</dl>
</li>
</ul>
<a id="properties(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;properties&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#8203;<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>&gt;&nbsp;properties)</pre>
<div class="block">Sets a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> of properties to convey to the remote when a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
is created from these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - the properties to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="virtualHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>virtualHost</h4>
<pre class="methodSignature">public&nbsp;<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;virtualHost()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the virtual host value configured.</dd>
</dl>
</li>
</ul>
<a id="virtualHost(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>virtualHost</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;virtualHost&#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;virtualHost)</pre>
<div class="block">The virtual host value to provide to the remote when creating a new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>virtualHost</code> - the virtual host to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="user()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>user</h4>
<pre class="methodSignature">public&nbsp;<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;user()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user name that is configured for new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="user(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>user</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;user&#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;user)</pre>
<div class="block">Sets the user name used when performing connection authentication.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="password()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>password</h4>
<pre class="methodSignature">public&nbsp;<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;password()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the password that is configured for new <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="password(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>password</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;password&#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;password)</pre>
<div class="block">Sets the password used when performing connection authentication.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - the password to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="transportOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transportOptions</h4>
<pre class="methodSignature">public&nbsp;<a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a>&nbsp;transportOptions()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the transport options that will be used for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd>
</dl>
</li>
</ul>
<a id="sslOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslOptions</h4>
<pre class="methodSignature">public&nbsp;<a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a>&nbsp;sslOptions()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SSL options that will be used for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd>
</dl>
</li>
</ul>
<a id="saslOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saslOptions</h4>
<pre class="methodSignature">public&nbsp;<a href="SaslOptions.html" title="class in org.apache.qpid.protonj2.client">SaslOptions</a>&nbsp;saslOptions()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SASL options that will be used for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</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>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if reconnection support has been enabled for this connection.</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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;reconnectEnabled&#8203;(boolean&nbsp;reconnectEnabled)</pre>
<div class="block">Controls if the connection will attempt to reconnect if unable to connect immediately
or if an existing connection fails.
<p>
This option enables or disables reconnection to a remote remote peer after IO errors.
To control specifics of the reconnection configuration for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> the
values must be updated in the <a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReconnectOptions</code></a> configuration prior to creating
the connection.</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 options instance.</dd>
</dl>
</li>
</ul>
<a id="reconnectOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectOptions</h4>
<pre class="methodSignature">public&nbsp;<a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a>&nbsp;reconnectOptions()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the reconnection options that will be used for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</dd>
</dl>
</li>
</ul>
<a id="traceFrames(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traceFrames</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;traceFrames&#8203;(boolean&nbsp;traceFrames)</pre>
<div class="block">Configure if the newly created connection should enabled AMQP frame tracing to the
system output.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>traceFrames</code> - true if frame tracing on this connection should be enabled.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="traceFrames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traceFrames</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;traceFrames()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the connection is configured to perform frame tracing.</dd>
</dl>
</li>
</ul>
<a id="sslEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslEnabled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;sslEnabled()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if SSL support has been enabled for this connection.</dd>
</dl>
</li>
</ul>
<a id="sslEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslEnabled</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;sslEnabled&#8203;(boolean&nbsp;sslEnabled)</pre>
<div class="block">Controls if the connection will attempt to connect using a secure IO layer or not.
<p>
This option enables or disables SSL encryption when connecting to a remote peer. To
control specifics of the SSL configuration for the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> the values must
be updated in the <a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> configuration prior to creating the connection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslEnabled</code> - Is SSL encryption enabled for the <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="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="defaultNextReceiverPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultNextReceiverPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a>&nbsp;defaultNextReceiverPolicy()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured default next receiver policy for the connection.</dd>
</dl>
</li>
</ul>
<a id="defaultNextReceiverPolicy(org.apache.qpid.protonj2.client.NextReceiverPolicy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultNextReceiverPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;defaultNextReceiverPolicy&#8203;(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a>&nbsp;policy)</pre>
<div class="block">Configures the default next receiver policy for this connection and any session
that is created without specifying user defined session default options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>policy</code> - The next receiver policy to assign as the default.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="disconnectedHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnectedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;&nbsp;disconnectedHandler()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection failed handler currently registered.</dd>
</dl>
</li>
</ul>
<a id="disconnectedHandler(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnectedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;disconnectedHandler&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;&nbsp;disconnectedHandler)</pre>
<div class="block">Configures a handler that will be notified when the connection has failed and cannot be recovered
should reconnect be enabled. Once notified of the failure the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> is no longer
operable and the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> APIs will throw an exception to indicate that the connection
has failed. The client application should close a failed <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> once it becomes
aware of the failure to ensure all connection resources are cleaned up properly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>disconnectedHandler</code> - the connection failed handler to notify when the connection fails for any reason.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#interruptedHandler"><code>interruptedHandler</code></a>,
<a href="#connectedHandler"><code>connectedHandler</code></a>,
<a href="#disconnectedHandler"><code>disconnectedHandler</code></a></dd>
</dl>
</li>
</ul>
<a id="connectedHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;&nbsp;connectedHandler()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection established handler that is currently registered</dd>
</dl>
</li>
</ul>
<a id="connectedHandler(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;connectedHandler&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;&nbsp;connectedHandler)</pre>
<div class="block">Configures a handler that will be notified when a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> has established.
This handler is called for each connection event when reconnection is enabled unless a
<a href="#reconnectedHandler"><code>reconnectedHandler</code></a> is configured in which case this handler is only notified
on the first connection to a remote.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectedHandler</code> - the connection established handler to assign to these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> instance.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#disconnectedHandler()"><code>disconnectedHandler()</code></a>,
<a href="#interruptedHandler"><code>interruptedHandler</code></a>,
<a href="#reconnectedHandler"><code>reconnectedHandler</code></a></dd>
</dl>
</li>
</ul>
<a id="interruptedHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interruptedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;&nbsp;interruptedHandler()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection interrupted handler that is currently registered</dd>
</dl>
</li>
</ul>
<a id="interruptedHandler(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interruptedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;interruptedHandler&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a>&gt;&nbsp;interruptedHandler)</pre>
<div class="block">Configures a handler that will be notified when the current <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> experiences an
interruption. The <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> will only signal this handler when the reconnection feature
is enabled and will follow this event either with a notification that the connection has been
restored (if a handler is registered), or with a notification that the connection has failed
if the reconnection configuration places limits on the the number of reconnection attempts.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interruptedHandler</code> - the connection interrupted handler to assign to these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#connectedHandler"><code>connectedHandler</code></a>,
<a href="#reconnectedHandler"><code>reconnectedHandler</code></a>,
<a href="#disconnectedHandler"><code>disconnectedHandler</code></a></dd>
</dl>
</li>
</ul>
<a id="reconnectedHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;&nbsp;reconnectedHandler()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection restored handler that is currently registered</dd>
</dl>
</li>
</ul>
<a id="reconnectedHandler(java.util.function.BiConsumer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reconnectedHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a>&nbsp;reconnectedHandler&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>,&#8203;<a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a>&gt;&nbsp;reconnectedHandler)</pre>
<div class="block">Configures a handler that will be notified when a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> that has previously
experienced and interruption has been reconnected to a remote based on the reconnection
configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reconnectedHandler</code> - the connection restored handler to assign to these <a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#connectedHandler"><code>connectedHandler</code></a>,
<a href="#interruptedHandler"><code>interruptedHandler</code></a>,
<a href="#disconnectedHandler"><code>disconnectedHandler</code></a></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/ConnectionOptions.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>