Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / SessionOptions.html
blob: 66f700ad4d84a5e124f769865a3a7343e5f4b438 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SessionOptions (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="SessionOptions (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};
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/SessionOptions.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 SessionOptions" class="title">Class SessionOptions</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.SessionOptions</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">SessionOptions</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="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</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_SESSION_INCOMING_CAPACITY">DEFAULT_SESSION_INCOMING_CAPACITY</a></span></code></th>
<td class="colLast">
<div class="block">The default Session configured incoming capacity limit to provide to the remote</div>
</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_SESSION_OUTGOING_CAPACITY">DEFAULT_SESSION_OUTGOING_CAPACITY</a></span></code></th>
<td class="colLast">
<div class="block">The default Session configured outgoing capacity to apply to local pending writes.</div>
</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()">SessionOptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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.SessionOptions)">SessionOptions</a></span>&#8203;(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Create a new SessionOptions instance that copies the configuration from the specified source options.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="i1" 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="i2" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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 <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> as been honored.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="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="i4" class="altColor">
<td class="colFirst"><code>protected <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.SessionOptions)">copyInto</a></span>&#8203;(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Copy all options from this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance into the instance
provided.</div>
</td>
</tr>
<tr id="i5" 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="i6" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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 the session created with these
configuration options.</div>
</td>
</tr>
<tr id="i7" 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="i8" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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">&nbsp;</td>
</tr>
<tr id="i9" 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="i10" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="i11" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#incomingCapacity()">incomingCapacity</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#incomingCapacity(int)">incomingCapacity</a></span>&#8203;(int&nbsp;incomingCapacity)</code></th>
<td class="colLast">
<div class="block">Sets the incoming capacity for a <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> created with these options.</div>
</td>
</tr>
<tr id="i14" 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="#offeredCapabilities()">offeredCapabilities</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<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="i17" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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 <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> has been honored.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="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="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outgoingCapacity()">outgoingCapacity</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outgoingCapacity(int)">outgoingCapacity</a></span>&#8203;(int&nbsp;outgoingCapacity)</code></th>
<td class="colLast">
<div class="block">Sets the outgoing capacity for a <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> created with these options.</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/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="i22" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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">&nbsp;</td>
</tr>
<tr id="i23" 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="i24" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="i25" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="i26" class="altColor">
<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="i27" class="rowColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="i28" class="altColor">
<td class="colFirst"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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>
</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_SESSION_INCOMING_CAPACITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SESSION_INCOMING_CAPACITY</h4>
<pre>public static final&nbsp;int DEFAULT_SESSION_INCOMING_CAPACITY</pre>
<div class="block">The default Session configured incoming capacity limit to provide to the remote</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SessionOptions.DEFAULT_SESSION_INCOMING_CAPACITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_SESSION_OUTGOING_CAPACITY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_SESSION_OUTGOING_CAPACITY</h4>
<pre>public static final&nbsp;int DEFAULT_SESSION_OUTGOING_CAPACITY</pre>
<div class="block">The default Session configured outgoing capacity to apply to local pending writes.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SessionOptions.DEFAULT_SESSION_OUTGOING_CAPACITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SessionOptions</h4>
<pre>public&nbsp;SessionOptions()</pre>
<div class="block">Create a new <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance configured with default configuration settings.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.qpid.protonj2.client.SessionOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SessionOptions</h4>
<pre>public&nbsp;SessionOptions&#8203;(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;options)</pre>
<div class="block">Create a new SessionOptions instance that copies the configuration from the specified source options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - The SessionOptions instance whose settings are to be copied into 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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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.SessionOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">protected&nbsp;<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;copyInto&#8203;(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;other)</pre>
<div class="block">Copy all options from this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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 <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> 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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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 <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offeredCapabilities</code> - the offeredCapabilities to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>desiredCapabilities</code> - the desiredCapabilities to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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</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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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>
<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="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="incomingCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incomingCapacity</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;incomingCapacity()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the incoming capacity that is configured for newly created <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="incomingCapacity(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incomingCapacity</h4>
<pre class="methodSignature">public&nbsp;<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;incomingCapacity&#8203;(int&nbsp;incomingCapacity)</pre>
<div class="block">Sets the incoming capacity for a <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> created with these options. The incoming capacity
controls how much buffering a session will allow before applying back pressure to the remote
thereby preventing excessive memory overhead.
<p>
This is an advanced option and in most cases the client defaults should be left in place unless
a specific issue needs to be addressed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>incomingCapacity</code> - the incoming capacity to set when creating a new <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="outgoingCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outgoingCapacity</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;outgoingCapacity()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the outgoing capacity limit that is configured for newly created <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="outgoingCapacity(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outgoingCapacity</h4>
<pre class="methodSignature">public&nbsp;<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;outgoingCapacity&#8203;(int&nbsp;outgoingCapacity)</pre>
<div class="block">Sets the outgoing capacity for a <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> created with these options. The outgoing capacity
controls how much buffering a session will allow before applying back pressure to the local
thereby preventing excessive memory overhead while writing large amounts of data and the
client is experiencing back-pressure due to the remote not keeping pace.
<p>
This is an advanced option and in most cases the client defaults should be left in place unless
a specific issue needs to be addressed. Setting this value incorrectly can lead to senders that
either block frequently or experience very poor overall performance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outgoingCapacity</code> - the outgoing capacity to set when creating a new <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</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 a session created using these options.</dd>
</dl>
</li>
</ul>
<a id="defaultNextReceiverPolicy(org.apache.qpid.protonj2.client.NextReceiverPolicy)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultNextReceiverPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</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 the session created with these
configuration options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>policy</code> - The default next receiver policy to assign to a new session.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SessionOptions.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>