blob: 06dd369c53fc00bf63cf21b3e7798a5a1891ae3b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 -->
<title>SenderOptions (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-05-12">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SenderOptions (Qpid ProtonJ2 Parent 1.0.0-M1 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};
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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</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/SenderOptions.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="../../../../../index-all.html">Index</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>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>Field&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>Field&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 SenderOptions" class="title">Class SenderOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.SenderOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="StreamSenderOptions.html" title="class in org.apache.qpid.protonj2.client">StreamSenderOptions</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SenderOptions</span>
extends java.lang.Object</pre>
<div class="block">Options that control the behavior of a <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> created from them.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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()">SenderOptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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.SenderOptions)">SenderOptions</a></span>&#8203;(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Create a new SenderOptions 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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#autoSettle()">autoSettle</a></span>()</code></th>
<td class="colLast">
<div class="block">Get whether the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> is auto settling deliveries.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#autoSettle(boolean)">autoSettle</a></span>&#8203;(boolean&nbsp;autoSettle)</code></th>
<td class="colLast">
<div class="block">Sets whether sent deliveries should be automatically locally-settled once
they have become remotely-settled by the receiving peer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeTimeout()">closeTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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
the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> link.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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,
java.util.concurrent.TimeUnit&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
the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> link.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.SenderOptions)">copyInto</a></span>&#8203;(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Copy all options from this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance into the instance
provided.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryMode()">deliveryMode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryMode(org.apache.qpid.protonj2.client.DeliveryMode)">deliveryMode</a></span>&#8203;(<a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a>&nbsp;deliveryMode)</code></th>
<td class="colLast">
<div class="block">Sets the <a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client"><code>DeliveryMode</code></a> value to assign to newly created <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> instances.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</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="i10" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#desiredCapabilities(java.lang.String...)">desiredCapabilities</a></span>&#8203;(java.lang.String...&nbsp;desiredCapabilities)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#linkName()">linkName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#linkName(java.lang.String)">linkName</a></span>&#8203;(java.lang.String&nbsp;linkName)</code></th>
<td class="colLast">
<div class="block">Configures the link name to use when creating a given <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> instance.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</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="i14" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities(java.lang.String...)">offeredCapabilities</a></span>&#8203;(java.lang.String...&nbsp;offeredCapabilities)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openTimeout()">openTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> has been honored.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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,
java.util.concurrent.TimeUnit&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 <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> has been honored.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&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="i19" class="rowColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties(java.util.Map)">properties</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;properties)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<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="i21" class="rowColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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="i22" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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,
java.util.concurrent.TimeUnit&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="i23" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendTimeout()">sendTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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="i25" class="rowColor">
<td class="colFirst"><code><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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,
java.util.concurrent.TimeUnit&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Configures the timeout used when awaiting a send operation to complete.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="SourceOptions.html" title="class in org.apache.qpid.protonj2.client">SourceOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sourceOptions()">sourceOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="TargetOptions.html" title="class in org.apache.qpid.protonj2.client">TargetOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#targetOptions()">targetOptions</a></span>()</code></th>
<td class="colLast">&nbsp;</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.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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>SenderOptions</h4>
<pre>public&nbsp;SenderOptions()</pre>
<div class="block">Create a new <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance configured with default configuration settings.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.qpid.protonj2.client.SenderOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SenderOptions</h4>
<pre>public&nbsp;SenderOptions&#8203;(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;options)</pre>
<div class="block">Create a new SenderOptions instance that copies the configuration from the specified source options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - The SenderOptions 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="linkName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linkName</h4>
<pre class="methodSignature">public&nbsp;<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;linkName&#8203;(java.lang.String&nbsp;linkName)</pre>
<div class="block">Configures the link name to use when creating a given <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>linkName</code> - The assigned link name to use when creating a <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="linkName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linkName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;linkName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured link name to use when creating a <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a>.</dd>
</dl>
</li>
</ul>
<a id="autoSettle(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>autoSettle</h4>
<pre class="methodSignature">public&nbsp;<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;autoSettle&#8203;(boolean&nbsp;autoSettle)</pre>
<div class="block">Sets whether sent deliveries should be automatically locally-settled once
they have become remotely-settled by the receiving peer.
True by default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>autoSettle</code> - whether deliveries should be auto settled locally after being
settled by the receiver</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sender</dd>
</dl>
</li>
</ul>
<a id="autoSettle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>autoSettle</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;autoSettle()</pre>
<div class="block">Get whether the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> is auto settling deliveries.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether deliveries should be auto settled locally after being settled
by the receiver</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#autoSettle(boolean)"><code>autoSettle(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a id="deliveryMode(org.apache.qpid.protonj2.client.DeliveryMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliveryMode</h4>
<pre class="methodSignature">public&nbsp;<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;deliveryMode&#8203;(<a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a>&nbsp;deliveryMode)</pre>
<div class="block">Sets the <a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client"><code>DeliveryMode</code></a> value to assign to newly created <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> instances.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deliveryMode</code> - The delivery mode value to configure.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="deliveryMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deliveryMode</h4>
<pre class="methodSignature">public&nbsp;<a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a>&nbsp;deliveryMode()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current value of the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> delivery mode configuration.</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 <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> 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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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
the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> link.</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;closeTimeout&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;units)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to close
the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> link.</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 <code>TimeUnit</code> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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 <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> 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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;openTimeout&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;units)</pre>
<div class="block">Configures the timeout used when awaiting a response from the remote that a request to open
a <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</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 <code>TimeUnit</code> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;sendTimeout&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&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 <code>TimeUnit</code> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;requestTimeout&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&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 <code>TimeUnit</code> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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;java.lang.String[]&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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;offeredCapabilities&#8203;(java.lang.String...&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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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;java.lang.String[]&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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;desiredCapabilities&#8203;(java.lang.String...&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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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;java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;properties&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="sourceOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sourceOptions</h4>
<pre class="methodSignature">public&nbsp;<a href="SourceOptions.html" title="class in org.apache.qpid.protonj2.client">SourceOptions</a>&nbsp;sourceOptions()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the source</dd>
</dl>
</li>
</ul>
<a id="targetOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetOptions</h4>
<pre class="methodSignature">public&nbsp;<a href="TargetOptions.html" title="class in org.apache.qpid.protonj2.client">TargetOptions</a>&nbsp;targetOptions()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the target</dd>
</dl>
</li>
</ul>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="copyInto(org.apache.qpid.protonj2.client.SenderOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">protected&nbsp;<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;copyInto&#8203;(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>&nbsp;other)</pre>
<div class="block">Copy all options from this <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</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>this options class for chaining.</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/SenderOptions.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="../../../../../index-all.html">Index</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>Field&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>Field&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; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>