Google Git
Sign in
apache / qpid-site / 51a7727b7b09b8341a4f593dcb1b9a86d20a650f / . / input / releases / qpid-proton-j-0.34.1 / api / org / apache / qpid / proton / engine / impl / DeliveryImpl.html
blob: 2e4e27c50cfcbc58300d9a57e1e19ee88d0a541d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DeliveryImpl (Qpid Proton-J 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="DeliveryImpl (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10};
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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.proton.engine.impl</a></div>
<h2 title="Class DeliveryImpl" class="title">Class DeliveryImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.proton.engine.impl.DeliveryImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code>, <code><a href="../Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DeliveryImpl</span>
extends java.lang.Object
implements <a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_MESSAGE_FORMAT">DEFAULT_MESSAGE_FORMAT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../Record.html" title="interface in org.apache.qpid.proton.engine">Record</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#attachments()">attachments</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#available()">available</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of bytes currently available for this delivery, which may not be complete yet, that are still
to either be received by the application or sent by the transport.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disposition(org.apache.qpid.proton.amqp.transport.DeliveryState)">disposition</a></span>&#8203;(<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">updates the state of the delivery
The new state may have no on-the-wire effect, if delivery settlement was already communicated to/from the peer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#free()">free</a></span>()</code></th>
<td class="colLast">
<div class="block">TODO When does an application call this method? Do we really need this?</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultDeliveryState()">getDefaultDeliveryState</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">LinkImpl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLink()">getLink</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalState()">getLocalState</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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="i10" class="altColor">
<td class="colFirst"><code><a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.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">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTag()">getTag</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="DeliveryImpl.html" title="class in org.apache.qpid.proton.engine.impl">DeliveryImpl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorkNext()">getWorkNext</a></span>()</code></th>
<td class="colLast">&nbsp;</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">
<div class="block">Check for whether the delivery was aborted.</div>
</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="#isBuffered()">isBuffered</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#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="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadable()">isReadable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this delivery has data ready to be received.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<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">
<div class="block">Returns whether this delivery has been settled.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUpdated()">isUpdated</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this delivery's state or settled flag has ever remotely changed.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isWritable()">isWritable</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="DeliveryImpl.html" title="class in org.apache.qpid.proton.engine.impl">DeliveryImpl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#next()">next</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pending()">pending</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remotelySettled()">remotelySettled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContext(java.lang.Object)">setContext</a></span>&#8203;(java.lang.Object&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDefaultDeliveryState(org.apache.qpid.proton.amqp.transport.DeliveryState)">setDefaultDeliveryState</a></span>&#8203;(<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Configures a default DeliveryState to be used if a
received delivery is settled/freed without any disposition
state having been previously applied.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageFormat(int)">setMessageFormat</a></span>&#8203;(int&nbsp;messageFormat)</code></th>
<td class="colLast">
<div class="block">Sets the message-format for this Delivery, representing the 32bit value using an int.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</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.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_MESSAGE_FORMAT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_MESSAGE_FORMAT</h4>
<pre>public static final&nbsp;int DEFAULT_MESSAGE_FORMAT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.qpid.proton.engine.impl.DeliveryImpl.DEFAULT_MESSAGE_FORMAT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getTag()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTag</h4>
<pre class="methodSignature">public&nbsp;byte[]&nbsp;getTag()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getTag()">getTag</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="getLink()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLink</h4>
<pre class="methodSignature">public&nbsp;<a href="LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">LinkImpl</a>&nbsp;getLink()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getLink()">getLink</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="getLocalState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalState</h4>
<pre class="methodSignature">public&nbsp;<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;getLocalState()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getLocalState()">getLocalState</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="getRemoteState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteState</h4>
<pre class="methodSignature">public&nbsp;<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;getRemoteState()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getRemoteState()">getRemoteState</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="remotelySettled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remotelySettled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;remotelySettled()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#remotelySettled()">remotelySettled</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="setMessageFormat(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageFormat</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMessageFormat&#8203;(int&nbsp;messageFormat)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#setMessageFormat(int)">Delivery</a></code></span></div>
<div class="block">Sets the message-format for this Delivery, representing the 32bit value using an int.
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="../Delivery.html#setMessageFormat(int)">setMessageFormat</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageFormat</code> - the message format</dd>
</dl>
</li>
</ul>
<a id="getMessageFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageFormat</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMessageFormat()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#getMessageFormat()">Delivery</a></code></span></div>
<div class="block">Gets the message-format for this Delivery, representing the 32bit value using an int.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getMessageFormat()">getMessageFormat</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the message-format</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Delivery.html#setMessageFormat(int)"><code>Delivery.setMessageFormat(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="disposition(org.apache.qpid.proton.amqp.transport.DeliveryState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disposition</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;disposition&#8203;(<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#disposition(org.apache.qpid.proton.amqp.transport.DeliveryState)">Delivery</a></code></span></div>
<div class="block">updates the state of the delivery
The new state may have no on-the-wire effect, if delivery settlement was already communicated to/from the peer.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#disposition(org.apache.qpid.proton.amqp.transport.DeliveryState)">disposition</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - the new delivery state</dd>
</dl>
</li>
</ul>
<a id="settle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>settle</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;settle()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#settle()">Delivery</a></code></span></div>
<div class="block">Settles this delivery.
Causes the delivery to be removed from the connection's work list (see <a href="../Connection.html#getWorkHead()"><code>Connection.getWorkHead()</code></a>).
If this delivery is its link's current delivery, the link's current delivery pointer is advanced.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#settle()">settle</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre class="methodSignature">public&nbsp;<a href="DeliveryImpl.html" title="class in org.apache.qpid.proton.engine.impl">DeliveryImpl</a>&nbsp;next()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#next()">next</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="free()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;free()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#free()">Delivery</a></code></span></div>
<div class="block">TODO When does an application call this method? Do we really need this?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#free()">free</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="getWorkNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkNext</h4>
<pre class="methodSignature">public&nbsp;<a href="DeliveryImpl.html" title="class in org.apache.qpid.proton.engine.impl">DeliveryImpl</a>&nbsp;getWorkNext()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getWorkNext()">getWorkNext</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Connection.html#getWorkHead()"><code>Connection.getWorkHead()</code></a></dd>
</dl>
</li>
</ul>
<a id="isSettled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSettled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSettled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#isSettled()">Delivery</a></code></span></div>
<div class="block">Returns whether this delivery has been settled.
TODO proton-j and proton-c return the local and remote statuses respectively. Resolve this ambiguity.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isSettled()">isSettled</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Delivery.html#settle()"><code>Delivery.settle()</code></a></dd>
</dl>
</li>
</ul>
<a id="available()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>available</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;available()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#available()">Delivery</a></code></span></div>
<div class="block">Returns the number of bytes currently available for this delivery, which may not be complete yet, that are still
to either be received by the application or sent by the transport.
Note that this value will change as bytes are received/sent, and is in general not equal to the total length of
a delivery, except the point where <a href="../Delivery.html#isPartial()"><code>Delivery.isPartial()</code></a> returns false and no content has yet been received by the
application or sent by the transport.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#available()">available</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes currently available for the delivery</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Receiver.html#recv(byte%5B%5D,int,int)"><code>Receiver.recv(byte[], int, int)</code></a>,
<a href="../Receiver.html#recv(org.apache.qpid.proton.codec.WritableBuffer)"><code>Receiver.recv(org.apache.qpid.proton.codec.WritableBuffer)</code></a>,
<a href="../Sender.html#send(byte%5B%5D,int,int)"><code>Sender.send(byte[], int, int)</code></a>,
<a href="../Sender.html#send(org.apache.qpid.proton.codec.ReadableBuffer)"><code>Sender.send(org.apache.qpid.proton.codec.ReadableBuffer)</code></a></dd>
</dl>
</li>
</ul>
<a id="isWritable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWritable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isWritable()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isWritable()">isWritable</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="isReadable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isReadable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#isReadable()">Delivery</a></code></span></div>
<div class="block">Returns whether this delivery has data ready to be received.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isReadable()">isReadable</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Receiver.html#recv(byte%5B%5D,int,int)"><code>Receiver.recv(byte[], int, int)</code></a></dd>
</dl>
</li>
</ul>
<a id="isAborted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAborted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAborted()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#isAborted()">Delivery</a></code></span></div>
<div class="block">Check for whether the delivery was aborted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isAborted()">isAborted</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the delivery was aborted.</dd>
</dl>
</li>
</ul>
<a id="isPartial()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartial</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isPartial()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#isPartial()">Delivery</a></code></span></div>
<div class="block">Check for whether the delivery is still partial.
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="../Delivery.html#isAborted()"><code>aborted</code></a> delivery
will also be considered partial and the full payload won't
be received.
For a sending Delivery, this means the sender link has not been
<a href="../Sender.html#advance()"><code>advanced</code></a> to complete the delivery yet.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isPartial()">isPartial</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</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="../Delivery.html#isAborted()"><code>Delivery.isAborted()</code></a></dd>
</dl>
</li>
</ul>
<a id="isUpdated()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpdated</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isUpdated()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#isUpdated()">Delivery</a></code></span></div>
<div class="block">Returns whether this delivery's state or settled flag has ever remotely changed.
TODO what is the main intended use case for calling this method?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isUpdated()">isUpdated</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="isBuffered()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBuffered</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBuffered()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#isBuffered()">isBuffered</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="getContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;getContext()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getContext()">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="setContext(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContext</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setContext&#8203;(java.lang.Object&nbsp;context)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#setContext(java.lang.Object)">setContext</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="attachments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attachments</h4>
<pre class="methodSignature">public&nbsp;<a href="../Record.html" title="interface in org.apache.qpid.proton.engine">Record</a>&nbsp;attachments()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Extendable.html#attachments()">attachments</a></code>&nbsp;in interface&nbsp;<code><a href="../Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="pending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pending</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;pending()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#pending()">pending</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
</dl>
</li>
</ul>
<a id="setDefaultDeliveryState(org.apache.qpid.proton.amqp.transport.DeliveryState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultDeliveryState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDefaultDeliveryState&#8203;(<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Delivery.html#setDefaultDeliveryState(org.apache.qpid.proton.amqp.transport.DeliveryState)">Delivery</a></code></span></div>
<div class="block">Configures a default DeliveryState to be used if a
received delivery is settled/freed without any disposition
state having been previously applied.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#setDefaultDeliveryState(org.apache.qpid.proton.amqp.transport.DeliveryState)">setDefaultDeliveryState</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - the default delivery state</dd>
</dl>
</li>
</ul>
<a id="getDefaultDeliveryState()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDefaultDeliveryState</h4>
<pre class="methodSignature">public&nbsp;<a href="../../amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;getDefaultDeliveryState()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Delivery.html#getDefaultDeliveryState()">getDefaultDeliveryState</a></code>&nbsp;in interface&nbsp;<code><a href="../Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>