| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SenderOptions (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="SenderOptions (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}; |
| 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/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="../../../../../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> |
| <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 SenderOptions" class="title">Class SenderOptions</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><<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.SenderOptions</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">SenderOptions</span> |
| extends <a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a><<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>> |
| 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 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"> </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>​(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> 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"> </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><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"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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>​(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> 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="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><<a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine">DeliveryTagGenerator</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryTagGeneratorSupplier()">deliveryTagGeneratorSupplier</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" 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="#deliveryTagGeneratorSupplier(java.util.function.Supplier)">deliveryTagGeneratorSupplier</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><<a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine">DeliveryTagGenerator</a>> supplier)</code></th> |
| <td class="colLast"> |
| <div class="block">Configures a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Supplier</code></a> which provides unique instances of <a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine"><code>DeliveryTagGenerator</code></a> objects |
| for any <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> created using these options.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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="#self()">self</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="#sendTimeout()">sendTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" 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>​(long 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="i7" 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>​(long 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> units)</code></th> |
| <td class="colLast"> |
| <div class="block">Configures the timeout used when awaiting a send operation to complete.</div> |
| </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 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 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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SenderOptions</h4> |
| <pre>public 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="<init>(org.apache.qpid.protonj2.client.SenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SenderOptions</h4> |
| <pre>public SenderOptions​(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> 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="sendTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendTimeout</h4> |
| <pre class="methodSignature">public long 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 <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> sendTimeout​(long 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 <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> sendTimeout​(long 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> 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 <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="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> 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> in class <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.SenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyInto</h4> |
| <pre class="methodSignature">protected <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> copyInto​(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> 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>the <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance that was given.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryTagGeneratorSupplier(java.util.function.Supplier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deliveryTagGeneratorSupplier</h4> |
| <pre class="methodSignature">public <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> deliveryTagGeneratorSupplier​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><<a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine">DeliveryTagGenerator</a>> supplier)</pre> |
| <div class="block">Configures a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Supplier</code></a> which provides unique instances of <a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine"><code>DeliveryTagGenerator</code></a> objects |
| for any <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> created using these options. |
| <p> |
| The client sender will use a default <a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine"><code>DeliveryTagGenerator</code></a> under normal circumstances and the |
| user is not required to configure a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Supplier</code></a>. In some cases where the user is communicating |
| with a system that requires a specific format of delivery tag this option allows use of a custom |
| generator. The caller is responsible for providing a supplier that will create a unique instance of |
| a tag generator as they are not meant to be shared amongst senders. Once a sender has been created |
| the tag generator it uses cannot be changed so future calls to this method will not affect previously |
| 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>supplier</code> - The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Supplier</code></a> of <a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine"><code>DeliveryTagGenerator</code></a> instances.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SenderOptions</code></a> instance that was given.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryTagGeneratorSupplier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deliveryTagGeneratorSupplier</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><<a href="../engine/DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine">DeliveryTagGenerator</a>> deliveryTagGeneratorSupplier()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured delivery tag <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink"><code>Supplier</code></a> or null if none was set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="self()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre class="methodSignature">protected <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> self()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="LinkOptions.html#self()">self</a></code> in class <code><a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a><<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a>></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/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="../../../../../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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
