| <!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>ReceiverImpl (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="ReceiverImpl (Qpid Proton-J API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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> |
| <!-- ========= 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/impl/ProtocolTracer.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/qpid/proton/engine/impl/RecordImpl.html" title="class in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/qpid/proton/engine/impl/ReceiverImpl.html" target="_top">Frames</a></li> |
| <li><a href="ReceiverImpl.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.impl</div> |
| <h2 title="Class ReceiverImpl" class="title">Class ReceiverImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html" title="class in org.apache.qpid.proton.engine.impl">org.apache.qpid.proton.engine.impl.EndpointImpl</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">org.apache.qpid.proton.engine.impl.LinkImpl</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.proton.engine.impl.ReceiverImpl</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a>, <a href="../../../../../../org/apache/qpid/proton/engine/ProtonJEndpoint.html" title="interface in org.apache.qpid.proton.engine">ProtonJEndpoint</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ReceiverImpl</span> |
| extends <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">LinkImpl</a> |
| implements <a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></pre> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#advance--">advance</a></span>()</code> |
| <div class="block">Attempts to advance the current delivery.</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/impl/ReceiverImpl.html#drain-int-">drain</a></span>(int credit)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#draining--">draining</a></span>()</code> </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/impl/ReceiverImpl.html#flow-int-">flow</a></span>(int credits)</code> |
| <div class="block">Adds the specified number of credits.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#getRemoteCredit--">getRemoteCredit</a></span>()</code> |
| <div class="block">Returns a [locally generated] view of credit at the remote peer by considering the |
| current link <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--"><code>credit</code></a> count as well as the effect of |
| any locally <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--"><code>queued</code></a> messages.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#recv--">recv</a></span>()</code> |
| <div class="block">Receive message data for the current delivery returning the data in a Readable buffer.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#recv-byte:A-int-int-">recv</a></span>(byte[] bytes, |
| int offset, |
| int size)</code> |
| <div class="block">Receive message data for the current delivery.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#recv-org.apache.qpid.proton.codec.WritableBuffer-">recv</a></span>(<a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> buffer)</code> |
| <div class="block">Receive message data for the current delivery.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html#setDrain-boolean-">setDrain</a></span>(boolean drain)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.impl.LinkImpl"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.qpid.proton.engine.impl.<a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">LinkImpl</a></h3> |
| <code><a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#addCredit-int-">addCredit</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#current--">current</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#delivery-byte:A-">delivery</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#delivery-byte:A-int-int-">delivery</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#detach--">detach</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#detached--">detached</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#drained--">drained</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getConnectionImpl--">getConnectionImpl</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getCredit--">getCredit</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getDesiredCapabilities--">getDesiredCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getDrain--">getDrain</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getMaxMessageSize--">getMaxMessageSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getName--">getName</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getOfferedCapabilities--">getOfferedCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getProperties--">getProperties</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getQueued--">getQueued</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getReceiverSettleMode--">getReceiverSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteDesiredCapabilities--">getRemoteDesiredCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteMaxMessageSize--">getRemoteMaxMessageSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteOfferedCapabilities--">getRemoteOfferedCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteProperties--">getRemoteProperties</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteReceiverSettleMode--">getRemoteReceiverSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteSenderSettleMode--">getRemoteSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteSource--">getRemoteSource</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getRemoteTarget--">getRemoteTarget</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getSenderSettleMode--">getSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getSession--">getSession</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getSource--">getSource</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getTarget--">getTarget</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#getUnsettled--">getUnsettled</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#head--">head</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#next-java.util.EnumSet-java.util.EnumSet-">next</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setCredit-int-">setCredit</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setDesiredCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setDesiredCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setMaxMessageSize-org.apache.qpid.proton.amqp.UnsignedLong-">setMaxMessageSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setOfferedCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setOfferedCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setProperties-java.util.Map-">setProperties</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setReceiverSettleMode-org.apache.qpid.proton.amqp.transport.ReceiverSettleMode-">setReceiverSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setRemoteSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">setRemoteSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">setSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setSource-org.apache.qpid.proton.amqp.transport.Source-">setSource</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#setTarget-org.apache.qpid.proton.amqp.transport.Target-">setTarget</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.impl.EndpointImpl"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.qpid.proton.engine.impl.<a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html" title="class in org.apache.qpid.proton.engine.impl">EndpointImpl</a></h3> |
| <code><a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#attachments--">attachments</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#close--">close</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#free--">free</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#getCondition--">getCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#getContext--">getContext</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#getLocalState--">getLocalState</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#getRemoteCondition--">getRemoteCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#getRemoteState--">getRemoteState</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#open--">open</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#setCondition-org.apache.qpid.proton.amqp.transport.ErrorCondition-">setCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/impl/EndpointImpl.html#setContext-java.lang.Object-">setContext</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Link"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a></h3> |
| <code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html#current--">current</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#delivery-byte:A-">delivery</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#delivery-byte:A-int-int-">delivery</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#detach--">detach</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#detached--">detached</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#drained--">drained</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--">getCredit</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getDesiredCapabilities--">getDesiredCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getDrain--">getDrain</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getMaxMessageSize--">getMaxMessageSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getName--">getName</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getOfferedCapabilities--">getOfferedCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getProperties--">getProperties</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--">getQueued</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getReceiverSettleMode--">getReceiverSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteDesiredCapabilities--">getRemoteDesiredCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteMaxMessageSize--">getRemoteMaxMessageSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteOfferedCapabilities--">getRemoteOfferedCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteProperties--">getRemoteProperties</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteReceiverSettleMode--">getRemoteReceiverSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteSenderSettleMode--">getRemoteSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteSource--">getRemoteSource</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteTarget--">getRemoteTarget</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getSenderSettleMode--">getSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getSession--">getSession</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getSource--">getSource</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getTarget--">getTarget</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getUnsettled--">getUnsettled</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#head--">head</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#next-java.util.EnumSet-java.util.EnumSet-">next</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setDesiredCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setDesiredCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setMaxMessageSize-org.apache.qpid.proton.amqp.UnsignedLong-">setMaxMessageSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setOfferedCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setOfferedCapabilities</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setProperties-java.util.Map-">setProperties</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setReceiverSettleMode-org.apache.qpid.proton.amqp.transport.ReceiverSettleMode-">setReceiverSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setRemoteSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">setRemoteSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">setSenderSettleMode</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setSource-org.apache.qpid.proton.amqp.transport.Source-">setSource</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#setTarget-org.apache.qpid.proton.amqp.transport.Target-">setTarget</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Endpoint"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a></h3> |
| <code><a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#close--">close</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#free--">free</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getCondition--">getCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getContext--">getContext</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getLocalState--">getLocalState</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getRemoteCondition--">getRemoteCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getRemoteState--">getRemoteState</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--">open</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#setCondition-org.apache.qpid.proton.amqp.transport.ErrorCondition-">setCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#setContext-java.lang.Object-">setContext</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Extendable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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="advance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>advance</h4> |
| <pre>public boolean advance()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html#advance--">Link</a></code></span></div> |
| <div class="block">Attempts to advance the current delivery. Advances it to the next delivery if one exists, else null. |
| |
| The behaviour of this method is different for senders and receivers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html#advance--">advance</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#advance--">advance</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html#advance--">advance</a></code> in class <code><a href="../../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">LinkImpl</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if it can advance, false if it cannot |
| |
| TODO document the meaning of the return value more fully. Currently Senderimpl only returns false if there is no current delivery</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flow-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flow</h4> |
| <pre>public void flow(int credits)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#flow-int-">Receiver</a></code></span></div> |
| <div class="block">Adds the specified number of credits. |
| |
| The number of link credits initialises to zero. It is the application's responsibility to call |
| this method to allow the receiver to receive <code>credits</code> more deliveries.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#flow-int-">flow</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="recv-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recv</h4> |
| <pre>public int recv(byte[] bytes, |
| int offset, |
| int size)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-byte:A-int-int-">Receiver</a></code></span></div> |
| <div class="block">Receive message data for the current delivery. |
| |
| If the caller takes all the bytes the Receiver currently has for this delivery then it is removed from |
| the Connection's work list. |
| |
| Before considering a delivery to be complete, the caller should examine <a href="../../../../../../org/apache/qpid/proton/engine/Delivery.html#isPartial--"><code>Delivery.isPartial()</code></a>. If |
| the delivery is partial, the caller should call <a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-byte:A-int-int-"><code>Receiver.recv(byte[], int, int)</code></a> again to receive |
| the additional bytes once the Delivery appears again on the Connection work-list. |
| |
| TODO might the flags other than IO_WORK in DeliveryImpl also prevent the work list being pruned? |
| e.g. what if a slow JMS consumer receives a disposition frame containing state=RELEASED? This is not IO_WORK.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-byte:A-int-int-">recv</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - the destination array where the message data is written</dd> |
| <dd><code>offset</code> - index in the array to start writing data at</dd> |
| <dd><code>size</code> - the maximum number of bytes to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of bytes written. -1 if there are no more bytes for the current delivery.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/qpid/proton/engine/Link.html#current--"><code>Link.current()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="recv-org.apache.qpid.proton.codec.WritableBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recv</h4> |
| <pre>public int recv(<a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-org.apache.qpid.proton.codec.WritableBuffer-">Receiver</a></code></span></div> |
| <div class="block">Receive message data for the current delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv-org.apache.qpid.proton.codec.WritableBuffer-">recv</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer to write the message data.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of bytes written. -1 if there are no more bytes for the current delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="recv--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recv</h4> |
| <pre>public <a href="../../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> recv()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv--">Receiver</a></code></span></div> |
| <div class="block">Receive message data for the current delivery returning the data in a Readable buffer. |
| |
| The delivery will return an empty buffer if there is no pending data to be read or if all |
| data has been read either by a previous call to this method or by a call to one of the other |
| receive methods.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#recv--">recv</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a ReadableBuffer that contains the currently available data for the current delivery.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="drain-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>drain</h4> |
| <pre>public void drain(int credit)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#drain-int-">drain</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="draining--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>draining</h4> |
| <pre>public boolean draining()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#draining--">draining</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDrain-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDrain</h4> |
| <pre>public void setDrain(boolean drain)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html#setDrain-boolean-">setDrain</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRemoteCredit--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRemoteCredit</h4> |
| <pre>public int getRemoteCredit()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteCredit--">Link</a></code></span></div> |
| <div class="block">Returns a [locally generated] view of credit at the remote peer by considering the |
| current link <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--"><code>credit</code></a> count as well as the effect of |
| any locally <a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--"><code>queued</code></a> messages.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteCredit--">getRemoteCredit</a></code> in interface <code><a href="../../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>view of effective remote credit</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/impl/ProtocolTracer.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/qpid/proton/engine/impl/RecordImpl.html" title="class in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/qpid/proton/engine/impl/ReceiverImpl.html" target="_top">Frames</a></li> |
| <li><a href="ReceiverImpl.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |