Google Git
Sign in
apache / qpid-site / 5404ff5f26d72c4c418dd95f4ef04e1fba050c29 / . / content / releases / qpid-proton-j-0.30.0 / api / org / apache / qpid / proton / engine / Delivery.html
blob: c4d4407d96b753fe0895787172050d1455e77432 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Delivery (Qpid Proton-J API)</title>
<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="Delivery (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/qpid/proton/engine/CoreHandler.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/Delivery.html" target="_top">Frames</a></li>
<li><a href="Delivery.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.qpid.proton.engine</div>
<h2 title="Interface Delivery" class="title">Interface Delivery</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/impl/DeliveryImpl.html" title="class in org.apache.qpid.proton.engine.impl">DeliveryImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Delivery</span>
extends <a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></pre>
<div class="block">A delivery of a message on a particular link.
Whilst a message is logically a long-lived object, a delivery is short-lived - it
is only intended to be used by the application until it is settled and all its data has been read.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#available--">available</a></span>()</code>
<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="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#clear--">clear</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#disposition-org.apache.qpid.proton.amqp.transport.DeliveryState-">disposition</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</code>
<div class="block">updates the state of the delivery</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#free--">free</a></span>()</code>
<div class="block">TODO When does an application call this method? Do we really need this?</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getContext--">getContext</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getDefaultDeliveryState--">getDefaultDeliveryState</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getLink--">getLink</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getLocalState--">getLocalState</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getMessageFormat--">getMessageFormat</a></span>()</code>
<div class="block">Gets the message-format for this Delivery, representing the 32bit value using an int.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getRemoteState--">getRemoteState</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getTag--">getTag</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#getWorkNext--">getWorkNext</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isAborted--">isAborted</a></span>()</code>
<div class="block">Check for whether the delivery was aborted.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isBuffered--">isBuffered</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isPartial--">isPartial</a></span>()</code>
<div class="block">Check for whether the delivery is still partial.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isReadable--">isReadable</a></span>()</code>
<div class="block">Returns whether this delivery has data ready to be received.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isSettled--">isSettled</a></span>()</code>
<div class="block">Returns whether this delivery has been settled.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isUpdated--">isUpdated</a></span>()</code>
<div class="block">Returns whether this delivery's state or settled flag has ever remotely changed.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#isWritable--">isWritable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#next--">next</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#pending--">pending</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#remotelySettled--">remotelySettled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#setContext-java.lang.Object-">setContext</a></span>(java.lang.Object&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#setDefaultDeliveryState-org.apache.qpid.proton.amqp.transport.DeliveryState-">setDefaultDeliveryState</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</code>
<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="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#setMessageFormat-int-">setMessageFormat</a></span>(int&nbsp;messageFormat)</code>
<div class="block">Sets the message-format for this Delivery, representing the 32bit value using an int.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#settle--">settle</a></span>()</code>
<div class="block">Settles this delivery.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Extendable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/engine/Extendable.html#attachments--">attachments</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTag</h4>
<pre>byte[]&nbsp;getTag()</pre>
</li>
</ul>
<a name="getLink--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLink</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a>&nbsp;getLink()</pre>
</li>
</ul>
<a name="getLocalState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalState</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;getLocalState()</pre>
</li>
</ul>
<a name="getRemoteState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteState</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;getRemoteState()</pre>
</li>
</ul>
<a name="disposition-org.apache.qpid.proton.amqp.transport.DeliveryState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disposition</h4>
<pre>void&nbsp;disposition(<a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</pre>
<div class="block">updates the state of the delivery</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - the new delivery state</dd>
</dl>
</li>
</ul>
<a name="settle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>settle</h4>
<pre>void&nbsp;settle()</pre>
<div class="block">Settles this delivery.
Causes the delivery to be removed from the connection's work list (see <a href="../../../../../org/apache/qpid/proton/engine/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>
</li>
</ul>
<a name="isSettled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSettled</h4>
<pre>boolean&nbsp;isSettled()</pre>
<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="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#settle--"><code>settle()</code></a></dd>
</dl>
</li>
</ul>
<a name="remotelySettled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remotelySettled</h4>
<pre>boolean&nbsp;remotelySettled()</pre>
</li>
</ul>
<a name="free--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre>void&nbsp;free()</pre>
<div class="block">TODO When does an application call this method? Do we really need this?</div>
</li>
</ul>
<a name="getWorkNext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkNext</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a>&nbsp;getWorkNext()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getWorkHead--"><code>Connection.getWorkHead()</code></a></dd>
</dl>
</li>
</ul>
<a name="next--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a>&nbsp;next()</pre>
</li>
</ul>
<a name="isWritable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWritable</h4>
<pre>boolean&nbsp;isWritable()</pre>
</li>
</ul>
<a name="isReadable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadable</h4>
<pre>boolean&nbsp;isReadable()</pre>
<div class="block">Returns whether this delivery has data ready to be received.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-byte:A-int-int-"><code>Receiver.recv(byte[], int, int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContext</h4>
<pre>void&nbsp;setContext(java.lang.Object&nbsp;o)</pre>
</li>
</ul>
<a name="getContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre>java.lang.Object&nbsp;getContext()</pre>
</li>
</ul>
<a name="isUpdated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpdated</h4>
<pre>boolean&nbsp;isUpdated()</pre>
<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>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>void&nbsp;clear()</pre>
</li>
</ul>
<a name="isPartial--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartial</h4>
<pre>boolean&nbsp;isPartial()</pre>
<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="../../../../../org/apache/qpid/proton/engine/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="../../../../../org/apache/qpid/proton/engine/Sender.html#advance--"><code>advanced</code></a> to complete the delivery yet.</div>
<dl>
<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="../../../../../org/apache/qpid/proton/engine/Delivery.html#isAborted--"><code>isAborted()</code></a></dd>
</dl>
</li>
</ul>
<a name="isAborted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAborted</h4>
<pre>boolean&nbsp;isAborted()</pre>
<div class="block">Check for whether the delivery was aborted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the delivery was aborted.</dd>
</dl>
</li>
</ul>
<a name="pending--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pending</h4>
<pre>int&nbsp;pending()</pre>
</li>
</ul>
<a name="isBuffered--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBuffered</h4>
<pre>boolean&nbsp;isBuffered()</pre>
</li>
</ul>
<a name="setDefaultDeliveryState-org.apache.qpid.proton.amqp.transport.DeliveryState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultDeliveryState</h4>
<pre>void&nbsp;setDefaultDeliveryState(<a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;state)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - the default delivery state</dd>
</dl>
</li>
</ul>
<a name="getDefaultDeliveryState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultDeliveryState</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/DeliveryState.html" title="interface in org.apache.qpid.proton.amqp.transport">DeliveryState</a>&nbsp;getDefaultDeliveryState()</pre>
</li>
</ul>
<a name="setMessageFormat-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageFormat</h4>
<pre>void&nbsp;setMessageFormat(int&nbsp;messageFormat)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>messageFormat</code> - the message format</dd>
</dl>
</li>
</ul>
<a name="getMessageFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageFormat</h4>
<pre>int&nbsp;getMessageFormat()</pre>
<div class="block">Gets the message-format for this Delivery, representing the 32bit value using an int.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the message-format</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html#setMessageFormat-int-"><code>setMessageFormat(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="available--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>available</h4>
<pre>int&nbsp;available()</pre>
<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="../../../../../org/apache/qpid/proton/engine/Delivery.html#isPartial--"><code>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="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="../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-byte:A-int-int-"><code>Receiver.recv(byte[], int, int)</code></a>,
<a href="../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-org.apache.qpid.proton.codec.WritableBuffer-"><code>Receiver.recv(org.apache.qpid.proton.codec.WritableBuffer)</code></a>,
<a href="../../../../../org/apache/qpid/proton/engine/Sender.html#send-byte:A-int-int-"><code>Sender.send(byte[], int, int)</code></a>,
<a href="../../../../../org/apache/qpid/proton/engine/Sender.html#send-org.apache.qpid.proton.codec.ReadableBuffer-"><code>Sender.send(org.apache.qpid.proton.codec.ReadableBuffer)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/qpid/proton/engine/CoreHandler.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/Delivery.html" target="_top">Frames</a></li>
<li><a href="Delivery.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>