blob: eabfc67c022bee68bd1bfb0cf61e854483bf0ff2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.qpid.protonj2.client.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="use: package: org.apache.qpid.protonj2.client, class: SessionOptions">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript"></script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">Class</a></li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.apache.qpid.protonj2.client.SessionOptions" class="title">Uses of Class<br>org.apache.qpid.protonj2.client.SessionOptions</h1>
</div>
<div class="caption"><span>Packages that use <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.client">org.apache.qpid.protonj2.client</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.qpid.protonj2.client">
<h2>Uses of <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> that return <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#clone()" class="member-name-link">clone</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#closeTimeout(long)" class="member-name-link">closeTimeout</a><wbr>(long&nbsp;closeTimeout)</code></div>
<div class="col-last odd-row-color">
<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 even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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 even-row-color">
<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 odd-row-color"><code>protected <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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 odd-row-color">
<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 even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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">
<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"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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 odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#drainTimeout(long)" class="member-name-link">drainTimeout</a><wbr>(long&nbsp;drainTimeout)</code></div>
<div class="col-last even-row-color">
<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"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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">
<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"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#incomingCapacity(int)" class="member-name-link">incomingCapacity</a><wbr>(int&nbsp;incomingCapacity)</code></div>
<div class="col-last even-row-color">
<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 odd-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#openTimeout(long)" class="member-name-link">openTimeout</a><wbr>(long&nbsp;openTimeout)</code></div>
<div class="col-last even-row-color">
<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 odd-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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 odd-row-color">
<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 even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#outgoingCapacity(int)" class="member-name-link">outgoingCapacity</a><wbr>(int&nbsp;outgoingCapacity)</code></div>
<div class="col-last even-row-color">
<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"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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 odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#requestTimeout(long)" class="member-name-link">requestTimeout</a><wbr>(long&nbsp;requestTimeout)</code></div>
<div class="col-last even-row-color">
<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"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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">
<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"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#sendTimeout(long)" class="member-name-link">sendTimeout</a><wbr>(long&nbsp;sendTimeout)</code></div>
<div class="col-last even-row-color">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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 odd-row-color">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> with parameters of type <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SessionOptions.</span><code><a href="../SessionOptions.html#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">
<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"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">openSession</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">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> with parameters of type <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../SessionOptions.html#%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 even-row-color">
<div class="block">Create a new SessionOptions instance that copies the configuration from the specified source options.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.client.impl">
<h2>Uses of <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a></h2>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> with parameters of type <a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientConnection.</span><code><a href="../impl/ClientConnection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">openSession</a><wbr>(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a>&nbsp;sessionOptions)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</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>