| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>OutgoingDelivery (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.engine, interface: OutgoingDelivery"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/OutgoingDelivery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine</a></div> |
| <h1 title="Interface OutgoingDelivery" class="title">Interface OutgoingDelivery</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">OutgoingDelivery</span></div> |
| <div class="block">API for an outgoing Delivery.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#abort()" class="member-name-link">abort</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Aborts the outgoing delivery if not already settled.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deliveryStateUpdatedHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">deliveryStateUpdatedHandler</a><wbr>(<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></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Handler for updates to the remote state of outgoing deliveries that have begun transferring frames.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState)" class="member-name-link">disposition</a><wbr>(<a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">updates the state of the delivery</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#disposition(org.apache.qpid.protonj2.types.transport.DeliveryState,boolean)" class="member-name-link">disposition</a><wbr>(<a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state, |
| boolean settle)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update the delivery with the given disposition if not locally settled and optionally |
| settles the delivery if not already settled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAttachments()" class="member-name-link">getAttachments</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLink()" class="member-name-link">getLink</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLinkedResource()" class="member-name-link">getLinkedResource</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLinkedResource(java.lang.Class)" class="member-name-link">getLinkedResource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> typeClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMessageFormat()" class="member-name-link">getMessageFormat</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the message-format for this Delivery, representing the 32bit value using an int.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteState()" class="member-name-link">getRemoteState</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTag()" class="member-name-link">getTag</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTransferCount()" class="member-name-link">getTransferCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isAborted()" class="member-name-link">isAborted</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isPartial()" class="member-name-link">isPartial</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Check for whether the delivery is still partial.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isRemotelySettled()" class="member-name-link">isRemotelySettled</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSettled()" class="member-name-link">isSettled</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLinkedResource(java.lang.Object)" class="member-name-link">setLinkedResource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> resource)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMessageFormat(int)" class="member-name-link">setMessageFormat</a><wbr>(int messageFormat)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the message-format for this Delivery, representing the 32bit value using an integer value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setTag(byte%5B%5D)" class="member-name-link">setTag</a><wbr>(byte[] deliveryTag)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the delivery tag to assign to this outgoing delivery from the given byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setTag(org.apache.qpid.protonj2.types.DeliveryTag)" class="member-name-link">setTag</a><wbr>(<a href="../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a> deliveryTag)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#settle()" class="member-name-link">settle</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Settles this delivery if not already settled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">streamBytes</a><wbr>(<a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>streamBytes(ProtonBuffer, boolean)</code></a> or a call |
| to <a href="#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"><code>writeBytes(ProtonBuffer)</code></a> is made.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)" class="member-name-link">streamBytes</a><wbr>(<a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| boolean complete)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>streamBytes(ProtonBuffer, boolean)</code></a> and the |
| buffer contents on that send are fully written.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">writeBytes</a><wbr>(<a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getLink()"> |
| <h3>getLink</h3> |
| <div class="member-signature"><span class="return-type"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></span> <span class="element-name">getLink</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttachments()"> |
| <h3>getAttachments</h3> |
| <div class="member-signature"><span class="return-type"><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></span> <span class="element-name">getAttachments</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLinkedResource(java.lang.Object)"> |
| <h3>setLinkedResource</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">setLinkedResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> resource)</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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinkedResource()"> |
| <h3>getLinkedResource</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getLinkedResource</span>()</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The type that the linked resource should be cast to on return.</dd> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinkedResource(java.lang.Class)"> |
| <h3>getLinkedResource</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getLinkedResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> typeClass)</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 class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The type to cast the linked resource to if one is set.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>typeClass</code> - the type's Class which is used for casting the returned value.</dd> |
| <dt>Returns:</dt> |
| <dd>the user set linked resource for this Context instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if the linked resource cannot be cast to the type requested.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessageFormat()"> |
| <h3>getMessageFormat</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getMessageFormat</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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the message-format for this Delivery.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMessageFormat(int)"> |
| <h3>setMessageFormat</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">setMessageFormat</span><wbr><span class="parameters">(int messageFormat)</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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>messageFormat</code> - the message format</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the delivery has already written <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTag()"> |
| <h3>getTag</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a></span> <span class="element-name">getTag</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTag(byte[])"> |
| <h3>setTag</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">setTag</span><wbr><span class="parameters">(byte[] deliveryTag)</span></div> |
| <div class="block">Sets the delivery tag to assign to this outgoing delivery from the given byte array.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the delivery has already written <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTag(org.apache.qpid.protonj2.types.DeliveryTag)"> |
| <h3>setTag</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">setTag</span><wbr><span class="parameters">(<a href="../types/DeliveryTag.html" title="interface in org.apache.qpid.protonj2.types">DeliveryTag</a> deliveryTag)</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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isPartial()"> |
| <h3>isPartial</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isPartial</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="#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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the delivery is partial</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isAborted()"><code>isAborted()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <h3>writeBytes</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">writeBytes</span><wbr><span class="parameters">(<a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - The buffer whose contents should be sent.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the parent <a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> link becomes inoperable due to closure or failure.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <h3>streamBytes</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">streamBytes</span><wbr><span class="parameters">(<a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</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="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>streamBytes(ProtonBuffer, boolean)</code></a> or a call |
| to <a href="#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)"><code>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="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>streamBytes(ProtonBuffer, boolean)</code></a> with the complete value set |
| to false.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - The buffer whose contents should be sent.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the parent <a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> link becomes inoperable due to closure or failure.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"> |
| <h3>streamBytes</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">streamBytes</span><wbr><span class="parameters">(<a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| boolean complete)</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="#streamBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean)"><code>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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the parent <a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> link becomes inoperable due to closure or failure.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAborted()"> |
| <h3>isAborted</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isAborted</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the delivery has been aborted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abort()"> |
| <h3>abort</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">abort</span>()</div> |
| <div class="block">Aborts the outgoing delivery if not already settled.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>this delivery.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getState()"> |
| <h3>getState</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a></span> <span class="element-name">getState</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disposition(org.apache.qpid.protonj2.types.transport.DeliveryState)"> |
| <h3>disposition</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">disposition</span><wbr><span class="parameters">(<a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state)</span></div> |
| <div class="block">updates the state of the delivery</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>state</code> - the new delivery state</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disposition(org.apache.qpid.protonj2.types.transport.DeliveryState,boolean)"> |
| <h3>disposition</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">disposition</span><wbr><span class="parameters">(<a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a> state, |
| boolean settle)</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" title="class or interface in java.lang" class="external-link"><code>IllegalStateException</code></a> is thrown to indicate that request is not valid.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>state</code> - the new delivery state</dd> |
| <dd><code>settle</code> - if true the delivery is settled.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSettled()"> |
| <h3>isSettled</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isSettled</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the delivery has been settled locally.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="settle()"> |
| <h3>settle</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">settle</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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRemotelySettled()"> |
| <h3>isRemotelySettled</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isRemotelySettled</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the delivery has been settled by the remote.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteState()"> |
| <h3>getRemoteState</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/transport/DeliveryState.html" title="interface in org.apache.qpid.protonj2.types.transport">DeliveryState</a></span> <span class="element-name">getRemoteState</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTransferCount()"> |
| <h3>getTransferCount</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getTransferCount</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 class="notes"> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deliveryStateUpdatedHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>deliveryStateUpdatedHandler</h3> |
| <div class="member-signature"><span class="return-type"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></span> <span class="element-name">deliveryStateUpdatedHandler</span><wbr><span class="parameters">(<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)</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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>this <a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine"><code>OutgoingDelivery</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
