| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ReceiverOptions (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="ReceiverOptions (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,"i28":10,"i29":10,"i30":10,"i31":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/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="../../../../../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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <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>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.ReceiverOptions</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">StreamReceiverOptions</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ReceiverOptions</span> |
| extends java.lang.Object</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"> </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>​(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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"> </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>​(boolean 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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#autoSettle()">autoSettle</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" 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="#autoSettle(boolean)">autoSettle</a></span>​(boolean autoSettle)</code></th> |
| <td class="colLast"> |
| <div class="block">Controls if the created Receiver will automatically settle the deliveries that have |
| been received by the application (default is <code>true</code>).</div> |
| </td> |
| </tr> |
| <tr id="i4" 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"> </td> |
| </tr> |
| <tr id="i5" 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"> </td> |
| </tr> |
| <tr id="i6" 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="#closeTimeout(long)">closeTimeout</a></span>​(long 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</div> |
| </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="#closeTimeout(long,java.util.concurrent.TimeUnit)">closeTimeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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>​(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> 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="i9" class="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i10" 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="#creditWindow(int)">creditWindow</a></span>​(int 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="i11" 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"> </td> |
| </tr> |
| <tr id="i12" 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="#deliveryMode(org.apache.qpid.protonj2.client.DeliveryMode)">deliveryMode</a></span>​(<a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a> 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances.</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="#desiredCapabilities()">desiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" 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="#desiredCapabilities(java.lang.String...)">desiredCapabilities</a></span>​(java.lang.String... desiredCapabilities)</code></th> |
| <td class="colLast"> </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="#drainTimeout()">drainTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" 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)">drainTimeout</a></span>​(long 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="i17" 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,java.util.concurrent.TimeUnit)">drainTimeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit 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="i18" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i19" 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="#linkName(java.lang.String)">linkName</a></span>​(java.lang.String linkName)</code></th> |
| <td class="colLast"> |
| <div class="block">Configures the link name to use when creating a given <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i21" 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="#offeredCapabilities(java.lang.String...)">offeredCapabilities</a></span>​(java.lang.String... offeredCapabilities)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openTimeout()">openTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" 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="#openTimeout(long)">openTimeout</a></span>​(long 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> has been honored.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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="#openTimeout(long,java.util.concurrent.TimeUnit)">openTimeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> has been honored.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" 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="#properties(java.util.Map)">properties</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestTimeout()">requestTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" 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="#requestTimeout(long)">requestTimeout</a></span>​(long 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="i29" 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="#requestTimeout(long,java.util.concurrent.TimeUnit)">requestTimeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit 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="i30" 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"> </td> |
| </tr> |
| <tr id="i31" 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"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ReceiverOptions</h4> |
| <pre>public ReceiverOptions()</pre> |
| <div class="block">Create a new ReceiverOptions instance with defaults set for all options.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ReceiverOptions</h4> |
| <pre>public ReceiverOptions​(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> autoAccept​(boolean 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 boolean 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="autoSettle(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>autoSettle</h4> |
| <pre class="methodSignature">public <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> autoSettle​(boolean autoSettle)</pre> |
| <div class="block">Controls if the created Receiver will automatically settle 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>autoSettle</code> - The value to assign for auto delivery settlement.</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="autoSettle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>autoSettle</h4> |
| <pre class="methodSignature">public boolean autoSettle()</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 settlement setting.</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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> deliveryMode​(<a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a> 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deliveryMode</h4> |
| <pre class="methodSignature">public <a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a> deliveryMode()</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> delivery mode configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="linkName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>linkName</h4> |
| <pre class="methodSignature">public <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> linkName​(java.lang.String linkName)</pre> |
| <div class="block">Configures the link name to use when creating a given <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</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="linkName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>linkName</h4> |
| <pre class="methodSignature">public java.lang.String linkName()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured link name to use when creating a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="creditWindow()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>creditWindow</h4> |
| <pre class="methodSignature">public int 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> creditWindow​(int 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="closeTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeTimeout</h4> |
| <pre class="methodSignature">public long 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> closeTimeout​(long closeTimeout)</pre> |
| <div class="block">Configures the timeout used when awaiting a response from the remote that a request to close |
| the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> closeTimeout​(long timeout, |
| java.util.concurrent.TimeUnit units)</pre> |
| <div class="block">Configures the timeout used when awaiting a response from the remote that a request to close |
| the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openTimeout</h4> |
| <pre class="methodSignature">public long 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="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> openTimeout​(long openTimeout)</pre> |
| <div class="block">Configures the timeout used when awaiting a response from the remote that a request to open |
| a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> has been honored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>openTimeout</code> - Timeout value in milliseconds to wait for a remote response.</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="openTimeout(long,java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openTimeout</h4> |
| <pre class="methodSignature">public <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> openTimeout​(long timeout, |
| java.util.concurrent.TimeUnit units)</pre> |
| <div class="block">Configures the timeout used when awaiting a response from the remote that a request to open |
| a <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> has been honored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - Timeout value to wait for a remote response.</dd> |
| <dd><code>units</code> - The <code>TimeUnit</code> 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="drainTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>drainTimeout</h4> |
| <pre class="methodSignature">public long 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> drainTimeout​(long 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> drainTimeout​(long timeout, |
| java.util.concurrent.TimeUnit 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 <code>TimeUnit</code> 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="requestTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestTimeout</h4> |
| <pre class="methodSignature">public long 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> requestTimeout​(long 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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> requestTimeout​(long timeout, |
| java.util.concurrent.TimeUnit 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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="offeredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offeredCapabilities</h4> |
| <pre class="methodSignature">public java.lang.String[] 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> offeredCapabilities​(java.lang.String... 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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="desiredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>desiredCapabilities</h4> |
| <pre class="methodSignature">public java.lang.String[] 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> desiredCapabilities​(java.lang.String... 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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="properties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> 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 <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> properties​(java.util.Map<java.lang.String,​java.lang.Object> 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="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sourceOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sourceOptions</h4> |
| <pre class="methodSignature">public <a href="SourceOptions.html" title="class in org.apache.qpid.protonj2.client">SourceOptions</a> sourceOptions()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the source options that will be used when creating new <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="targetOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>targetOptions</h4> |
| <pre class="methodSignature">public <a href="TargetOptions.html" title="class in org.apache.qpid.protonj2.client">TargetOptions</a> targetOptions()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the target options that will be used when creating new <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> instances.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> clone()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>clone</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copyInto(org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>copyInto</h4> |
| <pre class="methodSignature">protected <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> copyInto​(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> 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>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/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="../../../../../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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
