| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ProtonOutgoingDelivery (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="ProtonOutgoingDelivery (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,"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}; |
| 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/ProtonOutgoingDelivery.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.engine.impl</a></div> |
| <h2 title="Class ProtonOutgoingDelivery" class="title">Class ProtonOutgoingDelivery</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>org.apache.qpid.protonj2.engine.impl.ProtonOutgoingDelivery</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ProtonOutgoingDelivery</span> |
| extends <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> |
| implements <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></pre> |
| <div class="block">Proton outgoing delivery implementation</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(org.apache.qpid.protonj2.engine.impl.ProtonSender)">ProtonOutgoingDelivery</a></span>​(<a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a> link)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an empty outgoing delivery instance that is owned by the given <a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonSender</code></a> |
| instance.</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="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abort()">abort</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Aborts the outgoing delivery if not already settled.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryStateUpdatedHandler(org.apache.qpid.protonj2.engine.EventHandler)">deliveryStateUpdatedHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a>> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Handler for updates to the remote state of outgoing deliveries that have begun transferring frames.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState)">disposition</a></span>​(<a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state)</code></th> |
| <td class="colLast"> |
| <div class="block">updates the state of the delivery</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState,boolean)">disposition</a></span>​(<a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state, |
| boolean settle)</code></th> |
| <td class="colLast"> |
| <div class="block">Update the delivery with the given disposition if not locally settled and optionally |
| settles the delivery if not already settled.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonAttachments.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonAttachments</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachments()">getAttachments</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLink()">getLink</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLinkedResource()">getLinkedResource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLinkedResource(java.lang.Class)">getLinkedResource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> typeClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageFormat()">getMessageFormat</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the message-format for this Delivery, representing the 32bit value using an int.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteState()">getRemoteState</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTag()">getTag</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransferCount()">getTransferCount</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the total number of transfer frames that have occurred for the given <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAborted()">isAborted</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPartial()">isPartial</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Check for whether the delivery is still partial.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRemotelySettled()">isRemotelySettled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSettled()">isSettled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLinkedResource(java.lang.Object)">setLinkedResource</a></span>​(<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> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Links a given resource to this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageFormat(int)">setMessageFormat</a></span>​(int messageFormat)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the message-format for this Delivery, representing the 32bit value using an integer value.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTag(byte%5B%5D)">setTag</a></span>​(byte[] deliveryTag)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the delivery tag to assign to this outgoing delivery from the given byte array.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTag(org.apache.qpid.protonj2.types.DeliveryTag)">setTag</a></span>​(<a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a> deliveryTag)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types"><code>DeliveryTag</code></a> to assign to this outgoing delivery.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settle()">settle</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Settles this delivery if not already settled.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">streamBytes</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given bytes as a portion of the payload of this delivery, additional bytes can be streamed until |
| the stream complete flag is set to true on a call to <a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>OutgoingDelivery.streamBytes(ProtonBuffer, boolean)</code></a> or a call |
| to <a href="../OutgoingDelivery.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"><code>OutgoingDelivery.writeBytes(ProtonBuffer)</code></a> is made.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)">streamBytes</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| boolean complete)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given bytes as a portion of the payload of this delivery, additional bytes can be streamed until |
| the stream complete flag is set to true on a call to <a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>OutgoingDelivery.streamBytes(ProtonBuffer, boolean)</code></a> and the |
| buffer contents on that send are fully written.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeBytes</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given bytes as the payload of this delivery, no additional writes can occur on this delivery |
| if the write succeeds in sending all of the given bytes.</div> |
| </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.<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#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <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#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>(org.apache.qpid.protonj2.engine.impl.ProtonSender)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonOutgoingDelivery</h4> |
| <pre>public ProtonOutgoingDelivery​(<a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a> link)</pre> |
| <div class="block">Creates an empty outgoing delivery instance that is owned by the given <a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonSender</code></a> |
| instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>link</code> - the <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> link that owns this outgoing delivery.</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="getLink()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLink</h4> |
| <pre class="methodSignature">public <a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a> getLink()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getLink()">getLink</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the link that this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> is bound to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre class="methodSignature">public <a href="ProtonAttachments.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonAttachments</a> getAttachments()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getAttachments()">getAttachments</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Attachments.html" title="interface in org.apache.qpid.protonj2.engine"><code>Attachments</code></a> instance that is associated with this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLinkedResource(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinkedResource</h4> |
| <pre class="methodSignature">public <a href="ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a> setLinkedResource​(<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> resource)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#setLinkedResource(java.lang.Object)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Links a given resource to this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#setLinkedResource(java.lang.Object)">setLinkedResource</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - The resource to link to this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLinkedResource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkedResource</h4> |
| <pre class="methodSignature">public <T> T getLinkedResource()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getLinkedResource()">getLinkedResource</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type that the linked resource should be cast to on return.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user set linked resource for this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLinkedResource(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkedResource</h4> |
| <pre class="methodSignature">public <T> T getLinkedResource​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> typeClass)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#getLinkedResource(java.lang.Class)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getLinkedResource(java.lang.Class)">getLinkedResource</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type to cast the linked resource to if one is set.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeClass</code> - the type's Class which is used for casting the returned value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user set linked resource for this Context instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTag()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTag</h4> |
| <pre class="methodSignature">public <a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a> getTag()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getTag()">getTag</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types"><code>DeliveryTag</code></a> assigned to this Delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTag(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTag</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> setTag​(byte[] deliveryTag)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#setTag(byte%5B%5D)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Sets the delivery tag to assign to this outgoing delivery from the given byte array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#setTag(byte%5B%5D)">setTag</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deliveryTag</code> - a byte array containing the delivery tag to assign to this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTag(org.apache.qpid.protonj2.types.DeliveryTag)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTag</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> setTag​(<a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a> deliveryTag)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#setTag(org.apache.qpid.protonj2.types.DeliveryTag)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Sets the <a href="../../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types"><code>DeliveryTag</code></a> to assign to this outgoing delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#setTag(org.apache.qpid.protonj2.types.DeliveryTag)">setTag</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deliveryTag</code> - a byte array containing the delivery tag to assign to this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> getState()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getState()">getState</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport"><code>DeliveryState</code></a> at the local side of this Delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteState</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> getRemoteState()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getRemoteState()">getRemoteState</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport"><code>DeliveryState</code></a> at the remote side of this Delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMessageFormat()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageFormat</h4> |
| <pre class="methodSignature">public int getMessageFormat()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#getMessageFormat()">OutgoingDelivery</a></code></span></div> |
| <div class="block">Gets the message-format for this Delivery, representing the 32bit value using an int. |
| <p> |
| The default value is 0 as per the message format defined in the core AMQP 1.0 specification. |
| <p> |
| See the following for more details:<br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer</a><br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-message-format"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-message-format</a><br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#section-message-format"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#section-message-format</a><br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#definition-MESSAGE-FORMAT"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#definition-MESSAGE-FORMAT</a><br></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getMessageFormat()">getMessageFormat</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the message-format for this Delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMessageFormat(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageFormat</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> setMessageFormat​(int messageFormat)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#setMessageFormat(int)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Sets the message-format for this Delivery, representing the 32bit value using an integer value. The message format can |
| only be set@Override prior to the first <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> of delivery payload having been written. If one of the delivery |
| write methods is called prior to the message format being set then it defaults to the AMQP default format of zero. |
| <p> |
| The default value is 0 as per the message format defined in the core AMQP 1.0 specification. |
| <p> |
| See the following for more details:<br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer</a><br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-message-format"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-message-format</a><br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#section-message-format"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#section-message-format</a><br> |
| <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#definition-MESSAGE-FORMAT"> |
| http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#definition-MESSAGE-FORMAT</a><br></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#setMessageFormat(int)">setMessageFormat</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageFormat</code> - the message format</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isPartial()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPartial</h4> |
| <pre class="methodSignature">public boolean isPartial()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#isPartial()">OutgoingDelivery</a></code></span></div> |
| <div class="block">Check for whether the delivery is still partial. |
| <p> |
| For a receiving Delivery, this means the delivery does not hold |
| a complete message payload as all the content hasn't been |
| received yet. Note that an <a href="../OutgoingDelivery.html#isAborted()"><code>aborted</code></a> delivery |
| will also be considered partial and the full payload won't |
| be received. |
| <p> |
| For a sending Delivery, this means that the application has not marked |
| the delivery as complete yet.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#isPartial()">isPartial</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the delivery is partial</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../OutgoingDelivery.html#isAborted()"><code>OutgoingDelivery.isAborted()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAborted()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAborted</h4> |
| <pre class="methodSignature">public boolean isAborted()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#isAborted()">isAborted</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the delivery has been aborted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSettled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSettled</h4> |
| <pre class="methodSignature">public boolean isSettled()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#isSettled()">isSettled</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the delivery has been settled locally.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRemotelySettled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelySettled</h4> |
| <pre class="methodSignature">public boolean isRemotelySettled()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#isRemotelySettled()">isRemotelySettled</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the delivery has been settled by the remote.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disposition(org.apache.qpid.protonj2.types.transport.DeliveryState)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disposition</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> disposition​(<a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState)">OutgoingDelivery</a></code></span></div> |
| <div class="block">updates the state of the delivery</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState)">disposition</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - the new delivery state</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disposition(org.apache.qpid.protonj2.types.transport.DeliveryState,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disposition</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> disposition​(<a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state, |
| boolean settle)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState,boolean)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Update the delivery with the given disposition if not locally settled and optionally |
| settles the delivery if not already settled. |
| <p> |
| The action taken by this method depends on the state of the <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> |
| at the time it is called. |
| <p> |
| If there has yet to be any writes from this delivery the delivery state and settlement |
| value is cached and applied to the first (or only) write of payload from this delivery. |
| If however a write has already been performed than this method result in a <a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> |
| frame being sent to the remote with the given delivery state and settlement value. Once |
| the delivery is marked as settled any future call to this method will do nothing if the |
| requested disposition and settlement is the same however if a new state is applied which |
| cannot be conveyed due to having already locally settling the <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> than |
| an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a> is thrown to indicate that request is not valid.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState,boolean)">disposition</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - the new delivery state</dd> |
| <dd><code>settle</code> - if true the delivery is settled.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="settle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>settle</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> settle()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#settle()">OutgoingDelivery</a></code></span></div> |
| <div class="block">Settles this delivery if not already settled. Once settled locally no further updates |
| to the delivery state can be applied. If called prior to the first write of payload |
| bytes the settlement state is cached and transmitted within the first <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> |
| frame of this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#settle()">settle</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeBytes</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> writeBytes​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Write the given bytes as the payload of this delivery, no additional writes can occur on this delivery |
| if the write succeeds in sending all of the given bytes. |
| <p> |
| When called the provided buffer is treated as containing the entirety of the transfer payload and the |
| Transfer(s) that result from this call will result in a final Transfer frame whose more flag is set to |
| false which tells the remote that no additional data will be sent for this <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a>. The |
| <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> will output as much of the buffer as possible within the constraints of both the link |
| credit and the current capacity of the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>. |
| <p> |
| The caller must check that all bytes were written and if not they should await updates from the |
| <a href="../Link.html#creditStateUpdateHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Link.creditStateUpdateHandler(EventHandler)</code></a> that indicate that the <a href="../Sender.html#isSendable()"><code>Sender.isSendable()</code></a> |
| has become true again or the caller should check <a href="../Sender.html#isSendable()"><code>Sender.isSendable()</code></a> periodically until it |
| becomes true once again.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeBytes</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The buffer whose contents should be sent.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>streamBytes</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> streamBytes​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Write the given bytes as a portion of the payload of this delivery, additional bytes can be streamed until |
| the stream complete flag is set to true on a call to <a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>OutgoingDelivery.streamBytes(ProtonBuffer, boolean)</code></a> or a call |
| to <a href="../OutgoingDelivery.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"><code>OutgoingDelivery.writeBytes(ProtonBuffer)</code></a> is made. |
| <p> |
| The <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> will output as much of the buffer as possible within the constraints of both the link |
| credit and the current capacity of the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>. The caller must check that all bytes were0 |
| written and if not they should await updates from the <a href="../Link.html#creditStateUpdateHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Link.creditStateUpdateHandler(EventHandler)</code></a> |
| that indicate that the <a href="../Sender.html#isSendable()"><code>Sender.isSendable()</code></a> has become true again or the caller should check |
| <a href="../Sender.html#isSendable()"><code>Sender.isSendable()</code></a> periodically until it becomes true once again. |
| <p> |
| This method is the same as calling <a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>OutgoingDelivery.streamBytes(ProtonBuffer, boolean)</code></a> with the complete value set |
| to false.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">streamBytes</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The buffer whose contents should be sent.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>streamBytes</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> streamBytes​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| boolean complete)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Write the given bytes as a portion of the payload of this delivery, additional bytes can be streamed until |
| the stream complete flag is set to true on a call to <a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>OutgoingDelivery.streamBytes(ProtonBuffer, boolean)</code></a> and the |
| buffer contents on that send are fully written. |
| <p> |
| The <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> will output as much of the buffer as possible within the constraints of both the link |
| credit and the current capacity of the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>. The caller must check that all bytes were0 |
| written and if not they should await updates from the <a href="../Link.html#creditStateUpdateHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Link.creditStateUpdateHandler(EventHandler)</code></a> |
| that indicate that the <a href="../Sender.html#isSendable()"><code>Sender.isSendable()</code></a> has become true again or the caller should check |
| <a href="../Sender.html#isSendable()"><code>Sender.isSendable()</code></a> periodically until it becomes true once again.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)">streamBytes</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The buffer whose contents should be sent.</dd> |
| <dd><code>complete</code> - When true the delivery is marked complete and no further bytes can be written.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="abort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>abort</h4> |
| <pre class="methodSignature">public <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a> abort()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#abort()">OutgoingDelivery</a></code></span></div> |
| <div class="block">Aborts the outgoing delivery if not already settled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#abort()">abort</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryStateUpdatedHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deliveryStateUpdatedHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a> deliveryStateUpdatedHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a>> handler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#deliveryStateUpdatedHandler(org.apache.qpid.protonj2.engine.EventHandler)">OutgoingDelivery</a></code></span></div> |
| <div class="block">Handler for updates to the remote state of outgoing deliveries that have begun transferring frames. |
| <p> |
| Remote state updates for an <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> can happen when the remote settles a complete |
| <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> or otherwise modifies the delivery outcome and the user needs to act on those |
| changes such as a spontaneous update to the <a href="../../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport"><code>DeliveryState</code></a>. If the initial <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> of |
| an outgoing delivery already indicates settlement then this handler will never be called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#deliveryStateUpdatedHandler(org.apache.qpid.protonj2.engine.EventHandler)">deliveryStateUpdatedHandler</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handler</code> - The handler that will be invoked when a new remote state update for an <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> arrives on this link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString()</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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="getTransferCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTransferCount</h4> |
| <pre class="methodSignature">public int getTransferCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../OutgoingDelivery.html#getTransferCount()">OutgoingDelivery</a></code></span></div> |
| <div class="block">Returns the total number of transfer frames that have occurred for the given <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a>. |
| If the <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> has yet to have any of its write methods called this value will read |
| zero. Aborting a transfer after any <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames have been written will not result in an |
| addition recorded <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> write.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../OutgoingDelivery.html#getTransferCount()">getTransferCount</a></code> in interface <code><a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of <a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames that this <a href="../OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> has initiated.</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/ProtonOutgoingDelivery.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> |
