Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / content / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / ReceiverOptions.html
blob: 331cbf9e755268f21e9b3363c38a2b4afacee5f1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ReceiverOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReceiverOptions (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReceiverOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>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 ReceiverOptions" class="title">Class ReceiverOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">org.apache.qpid.protonj2.client.LinkOptions</a>&lt;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.ReceiverOptions</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ReceiverOptions</span>
extends <a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a>&lt;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&gt;
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre>
<div class="block">Options that control the behavior of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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()">ReceiverOptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new ReceiverOptions instance with defaults set for all options.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.ReceiverOptions)">ReceiverOptions</a></span>&#8203;(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Create a new ReceiverOptions 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="#autoAccept()">autoAccept</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#autoAccept(boolean)">autoAccept</a></span>&#8203;(boolean&nbsp;autoAccept)</code></th>
<td class="colLast">
<div class="block">Controls if the created Receiver will automatically accept the deliveries that have
been received by the application (default is <code>true</code>).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</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>protected <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyInto(org.apache.qpid.protonj2.client.ReceiverOptions)">copyInto</a></span>&#8203;(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Copy all options from this <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance into the instance
provided.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#creditWindow()">creditWindow</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#creditWindow(int)">creditWindow</a></span>&#8203;(int&nbsp;creditWindow)</code></th>
<td class="colLast">
<div class="block">A credit window value that will be used to maintain an window of credit for Receiver instances
that are created.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTimeout()">drainTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTimeout(long)">drainTimeout</a></span>&#8203;(long&nbsp;drainTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the drain timeout (in milliseconds) after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTimeout(long,java.util.concurrent.TimeUnit)">drainTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Sets the drain timeout value after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#self()">self</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.LinkOptions">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.qpid.protonj2.client.<a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a></h3>
<code><a href="LinkOptions.html#autoSettle()">autoSettle</a>, <a href="LinkOptions.html#autoSettle(boolean)">autoSettle</a>, <a href="LinkOptions.html#closeTimeout()">closeTimeout</a>, <a href="LinkOptions.html#closeTimeout(long)">closeTimeout</a>, <a href="LinkOptions.html#closeTimeout(long,java.util.concurrent.TimeUnit)">closeTimeout</a>, <a href="LinkOptions.html#copyInto(org.apache.qpid.protonj2.client.LinkOptions)">copyInto</a>, <a href="LinkOptions.html#deliveryMode()">deliveryMode</a>, <a href="LinkOptions.html#deliveryMode(org.apache.qpid.protonj2.client.DeliveryMode)">deliveryMode</a>, <a href="LinkOptions.html#desiredCapabilities()">desiredCapabilities</a>, <a href="LinkOptions.html#desiredCapabilities(java.lang.String...)">desiredCapabilities</a>, <a href="LinkOptions.html#linkName()">linkName</a>, <a href="LinkOptions.html#linkName(java.lang.String)">linkName</a>, <a href="LinkOptions.html#offeredCapabilities()">offeredCapabilities</a>, <a href="LinkOptions.html#offeredCapabilities(java.lang.String...)">offeredCapabilities</a>, <a href="LinkOptions.html#openTimeout()">openTimeout</a>, <a href="LinkOptions.html#openTimeout(long)">openTimeout</a>, <a href="LinkOptions.html#openTimeout(long,java.util.concurrent.TimeUnit)">openTimeout</a>, <a href="LinkOptions.html#properties()">properties</a>, <a href="LinkOptions.html#properties(java.util.Map)">properties</a>, <a href="LinkOptions.html#requestTimeout()">requestTimeout</a>, <a href="LinkOptions.html#requestTimeout(long)">requestTimeout</a>, <a href="LinkOptions.html#requestTimeout(long,java.util.concurrent.TimeUnit)">requestTimeout</a>, <a href="LinkOptions.html#sourceOptions()">sourceOptions</a>, <a href="LinkOptions.html#targetOptions()">targetOptions</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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>ReceiverOptions</h4>
<pre>public&nbsp;ReceiverOptions()</pre>
<div class="block">Create a new ReceiverOptions instance with defaults set for all options.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.qpid.protonj2.client.ReceiverOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReceiverOptions</h4>
<pre>public&nbsp;ReceiverOptions&#8203;(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;options)</pre>
<div class="block">Create a new ReceiverOptions instance that copies the configuration from the specified source options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - The ReceiverOptions 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="autoAccept(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>autoAccept</h4>
<pre class="methodSignature">public&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;autoAccept&#8203;(boolean&nbsp;autoAccept)</pre>
<div class="block">Controls if the created Receiver will automatically accept the deliveries that have
been received by the application (default is <code>true</code>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>autoAccept</code> - The value to assign for auto delivery acceptance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="autoAccept()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>autoAccept</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;autoAccept()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current value of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> auto accept setting.</dd>
</dl>
</li>
</ul>
<a id="creditWindow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>creditWindow</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;creditWindow()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the credit window configuration that will be applied to created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances.</dd>
</dl>
</li>
</ul>
<a id="creditWindow(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>creditWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;creditWindow&#8203;(int&nbsp;creditWindow)</pre>
<div class="block">A credit window value that will be used to maintain an window of credit for Receiver instances
that are created. The <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> will allow up to the credit window amount of incoming
deliveries to be queued and as they are read from the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> the window will be extended
to maintain a consistent backlog of deliveries. The default is to configure a credit window of 10.
<p>
To disable credit windowing and allow the client application to control the credit on the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>
link the credit window value should be set to zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>creditWindow</code> - The assigned credit window value to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="drainTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;drainTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured drain timeout value that will use to fail a pending drain request.</dd>
</dl>
</li>
</ul>
<a id="drainTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;drainTimeout&#8203;(long&nbsp;drainTimeout)</pre>
<div class="block">Sets the drain timeout (in milliseconds) after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>drainTimeout</code> - the drainTimeout to use for receiver links.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="drainTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;drainTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;units)</pre>
<div class="block">Sets the drain timeout value after which a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> request to drain
link credit is considered failed and the request will be marked as such.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout value to wait for a remote response.</dd>
<dd><code>units</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeUnit</code></a> that defines the timeout span.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="copyInto(org.apache.qpid.protonj2.client.ReceiverOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyInto</h4>
<pre class="methodSignature">protected&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;copyInto&#8203;(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;other)</pre>
<div class="block">Copy all options from this <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance into the instance
provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the target of this copy operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance that was given.</dd>
</dl>
</li>
</ul>
<a id="self()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>self</h4>
<pre class="methodSignature">protected&nbsp;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&nbsp;self()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="LinkOptions.html#self()">self</a></code>&nbsp;in class&nbsp;<code><a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a>&lt;<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the true derived type instance for use in this class.</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/ReceiverOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>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; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>