blob: adcdf8933b52fcb190663f84a91eb02468b67146 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>SessionOptions (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.qpid.protonj2.client, class: SessionOptions">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/SessionOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&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="sub-nav-list">
<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>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
<h1 title="Class SessionOptions" class="title">Class SessionOptions</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.qpid.protonj2.client.SessionOptions</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SessionOptions</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></span></div>
<div class="block">Options that control the behavior of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> created from them.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#DEFAULT_SESSION_INCOMING_CAPACITY" class="member-name-link">DEFAULT_SESSION_INCOMING_CAPACITY</a></code></div>
<div class="col-last even-row-color">
<div class="block">The default Session configured incoming capacity limit to provide to the remote</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#DEFAULT_SESSION_OUTGOING_CAPACITY" class="member-name-link">DEFAULT_SESSION_OUTGOING_CAPACITY</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The default Session configured outgoing capacity to apply to local pending writes.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SessionOptions</a>()</code></div>
<div class="col-last even-row-color">
<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>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">SessionOptions</a><wbr>(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color">
<div class="block">Create a new SessionOptions instance that copies the configuration from the specified source options.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeTimeout()" class="member-name-link">closeTimeout</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeTimeout(long)" class="member-name-link">closeTimeout</a><wbr>(long&nbsp;closeTimeout)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeTimeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">closeTimeout</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyInto(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">copyInto</a><wbr>(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;other)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Copy all options from this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance into the instance
provided.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defaultNextReceiverPolicy()" class="member-name-link">defaultNextReceiverPolicy</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defaultNextReceiverPolicy(org.apache.qpid.protonj2.client.NextReceiverPolicy)" class="member-name-link">defaultNextReceiverPolicy</a><wbr>(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a>&nbsp;policy)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configures the default next receiver policy for the session created with these
configuration options.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#desiredCapabilities()" class="member-name-link">desiredCapabilities</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#desiredCapabilities(java.lang.String...)" class="member-name-link">desiredCapabilities</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;desiredCapabilities)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#drainTimeout()" class="member-name-link">drainTimeout</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#drainTimeout(long)" class="member-name-link">drainTimeout</a><wbr>(long&nbsp;drainTimeout)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#drainTimeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">drainTimeout</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#incomingCapacity()" class="member-name-link">incomingCapacity</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#incomingCapacity(int)" class="member-name-link">incomingCapacity</a><wbr>(int&nbsp;incomingCapacity)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#offeredCapabilities()" class="member-name-link">offeredCapabilities</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#offeredCapabilities(java.lang.String...)" class="member-name-link">offeredCapabilities</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;offeredCapabilities)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openTimeout()" class="member-name-link">openTimeout</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openTimeout(long)" class="member-name-link">openTimeout</a><wbr>(long&nbsp;openTimeout)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openTimeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">openTimeout</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#outgoingCapacity()" class="member-name-link">outgoingCapacity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#outgoingCapacity(int)" class="member-name-link">outgoingCapacity</a><wbr>(int&nbsp;outgoingCapacity)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#properties()" class="member-name-link">properties</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#properties(java.util.Map)" class="member-name-link">properties</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;properties)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requestTimeout()" class="member-name-link">requestTimeout</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requestTimeout(long)" class="member-name-link">requestTimeout</a><wbr>(long&nbsp;requestTimeout)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requestTimeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">requestTimeout</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendTimeout()" class="member-name-link">sendTimeout</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendTimeout(long)" class="member-name-link">sendTimeout</a><wbr>(long&nbsp;sendTimeout)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendTimeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">sendTimeout</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">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" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="DEFAULT_SESSION_INCOMING_CAPACITY">
<h3>DEFAULT_SESSION_INCOMING_CAPACITY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">DEFAULT_SESSION_INCOMING_CAPACITY</span></div>
<div class="block">The default Session configured incoming capacity limit to provide to the remote</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SessionOptions.DEFAULT_SESSION_INCOMING_CAPACITY">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="DEFAULT_SESSION_OUTGOING_CAPACITY">
<h3>DEFAULT_SESSION_OUTGOING_CAPACITY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">DEFAULT_SESSION_OUTGOING_CAPACITY</span></div>
<div class="block">The default Session configured outgoing capacity to apply to local pending writes.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.client.SessionOptions.DEFAULT_SESSION_OUTGOING_CAPACITY">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SessionOptions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SessionOptions</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.qpid.protonj2.client.SessionOptions)">
<h3>SessionOptions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SessionOptions</span><wbr><span class="parameters">(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;options)</span></div>
<div class="block">Create a new SessionOptions instance that copies the configuration from the specified source options.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>options</code> - The SessionOptions instance whose settings are to be copied into this one.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">clone</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="copyInto(org.apache.qpid.protonj2.client.SessionOptions)">
<h3>copyInto</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">copyInto</span><wbr><span class="parameters">(<a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;other)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>other</code> - the target of this copy operation.</dd>
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="closeTimeout()">
<h3>closeTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">closeTimeout</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the timeout used when awaiting a response from the remote when a resource is closed.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="closeTimeout(long)">
<h3>closeTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">closeTimeout</span><wbr><span class="parameters">(long&nbsp;closeTimeout)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>closeTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="closeTimeout(long,java.util.concurrent.TimeUnit)">
<h3>closeTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">closeTimeout</span><wbr><span class="parameters">(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</span></div>
<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 class="notes">
<dt>Parameters:</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" title="class or interface in java.util.concurrent" class="external-link"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="openTimeout()">
<h3>openTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">openTimeout</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the timeout used when awaiting a response from the remote when a resource is opened.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="openTimeout(long)">
<h3>openTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">openTimeout</span><wbr><span class="parameters">(long&nbsp;openTimeout)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>openTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="openTimeout(long,java.util.concurrent.TimeUnit)">
<h3>openTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">openTimeout</span><wbr><span class="parameters">(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</span></div>
<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 class="notes">
<dt>Parameters:</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" title="class or interface in java.util.concurrent" class="external-link"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="sendTimeout()">
<h3>sendTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">sendTimeout</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the timeout used when awaiting a response from the remote when a resource is message send.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="sendTimeout(long)">
<h3>sendTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">sendTimeout</span><wbr><span class="parameters">(long&nbsp;sendTimeout)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>sendTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="sendTimeout(long,java.util.concurrent.TimeUnit)">
<h3>sendTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">sendTimeout</span><wbr><span class="parameters">(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</span></div>
<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 class="notes">
<dt>Parameters:</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" title="class or interface in java.util.concurrent" class="external-link"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="requestTimeout()">
<h3>requestTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">requestTimeout</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the timeout used when awaiting a response from the remote when a resource makes a request.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="requestTimeout(long)">
<h3>requestTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">requestTimeout</span><wbr><span class="parameters">(long&nbsp;requestTimeout)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>requestTimeout</code> - Timeout value in milliseconds to wait for a remote response.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="requestTimeout(long,java.util.concurrent.TimeUnit)">
<h3>requestTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">requestTimeout</span><wbr><span class="parameters">(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</span></div>
<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 class="notes">
<dt>Parameters:</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" title="class or interface in java.util.concurrent" class="external-link"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="drainTimeout()">
<h3>drainTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">drainTimeout</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the configured drain timeout value that will use to fail a pending drain request.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="drainTimeout(long)">
<h3>drainTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">drainTimeout</span><wbr><span class="parameters">(long&nbsp;drainTimeout)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>drainTimeout</code> - the drainTimeout to use for receiver links.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="drainTimeout(long,java.util.concurrent.TimeUnit)">
<h3>drainTimeout</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">drainTimeout</span><wbr><span class="parameters">(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;units)</span></div>
<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 class="notes">
<dt>Parameters:</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" title="class or interface in java.util.concurrent" class="external-link"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="offeredCapabilities()">
<h3>offeredCapabilities</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">offeredCapabilities</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the offeredCapabilities</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="offeredCapabilities(java.lang.String...)">
<h3>offeredCapabilities</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">offeredCapabilities</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;offeredCapabilities)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>offeredCapabilities</code> - the offeredCapabilities to set</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="desiredCapabilities()">
<h3>desiredCapabilities</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">desiredCapabilities</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the desiredCapabilities</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="desiredCapabilities(java.lang.String...)">
<h3>desiredCapabilities</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">desiredCapabilities</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;desiredCapabilities)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>desiredCapabilities</code> - the desiredCapabilities to set</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="properties()">
<h3>properties</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name">properties</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the properties</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="properties(java.util.Map)">
<h3>properties</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">properties</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;properties)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>properties</code> - the properties to set</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="incomingCapacity()">
<h3>incomingCapacity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">incomingCapacity</span>()</div>
<dl class="notes">
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="incomingCapacity(int)">
<h3>incomingCapacity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">incomingCapacity</span><wbr><span class="parameters">(int&nbsp;incomingCapacity)</span></div>
<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 class="notes">
<dt>Parameters:</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>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="outgoingCapacity()">
<h3>outgoingCapacity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">outgoingCapacity</span>()</div>
<dl class="notes">
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="outgoingCapacity(int)">
<h3>outgoingCapacity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">outgoingCapacity</span><wbr><span class="parameters">(int&nbsp;outgoingCapacity)</span></div>
<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 class="notes">
<dt>Parameters:</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>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultNextReceiverPolicy()">
<h3>defaultNextReceiverPolicy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a></span>&nbsp;<span class="element-name">defaultNextReceiverPolicy</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the configured default next receiver policy for a session created using these options.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="defaultNextReceiverPolicy(org.apache.qpid.protonj2.client.NextReceiverPolicy)">
<h3>defaultNextReceiverPolicy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span>&nbsp;<span class="element-name">defaultNextReceiverPolicy</span><wbr><span class="parameters">(<a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a>&nbsp;policy)</span></div>
<div class="block">Configures the default next receiver policy for the session created with these
configuration options.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>policy</code> - The default next receiver policy to assign to a new session.</dd>
<dt>Returns:</dt>
<dd>this <a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SessionOptions</code></a> instance.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>