| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Engine.IIncomingDelivery Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.IIncomingDelivery Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents an incoming delivery that is received by a local receiver from a remote sender on an open link. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.IIncomingDelivery:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.png" usemap="#Apache.Qpid.Proton.Engine.IIncomingDelivery_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.IIncomingDelivery_map" name="Apache.Qpid.Proton.Engine.IIncomingDelivery_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html" title="Proton Incoming Delivery implementation that wraps all the details of managing the read of delivery p..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery" shape="rect" coords="0,56,396,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a657d1bfb97adfd6dbb7cf4e3a9f0b52b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a657d1bfb97adfd6dbb7cf4e3a9f0b52b">ClaimAvailableBytes</a> ()</td></tr> |
| <tr class="memdesc:a657d1bfb97adfd6dbb7cf4e3a9f0b52b"><td class="mdescLeft"> </td><td class="mdescRight">Marks all available bytes as being claimed by the caller meaning that available byte count value can be returned to the session which can expand the session incoming window to allow more bytes to be sent from the remote peer. This method is useful in the case where the session has been configured with a small incoming capacity and the receiver needs to expand the session window in order to read the entire contents of a delivery whose payload exceeds the configured session capacity. The incoming delivery implementation will track the amount of claimed bytes and ensure that it never releases back more bytes to the session than has actually been received as a whole which allows this method to be called with each incoming transfer frame of a large split framed delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a657d1bfb97adfd6dbb7cf4e3a9f0b52b">More...</a><br /></td></tr> |
| <tr class="separator:a657d1bfb97adfd6dbb7cf4e3a9f0b52b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaea181d03e53d361f86f8aca98134563"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#aaea181d03e53d361f86f8aca98134563">ReadAll</a> ()</td></tr> |
| <tr class="memdesc:aaea181d03e53d361f86f8aca98134563"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current read buffer without copying it effectively consuming all currently available bytes from this delivery. If no data is available then this method returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#aaea181d03e53d361f86f8aca98134563">More...</a><br /></td></tr> |
| <tr class="separator:aaea181d03e53d361f86f8aca98134563"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b7e5c4865edf90d4ff58b72ac2b2cf7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a5b7e5c4865edf90d4ff58b72ac2b2cf7">ReadBytes</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr> |
| <tr class="memdesc:a5b7e5c4865edf90d4ff58b72ac2b2cf7"><td class="mdescLeft"> </td><td class="mdescRight">Reads bytes from this delivery and writes them into the destination buffer reducing the available bytes by the value of the number of bytes written to the target. The number of bytes written will be the equal to the writable bytes of the target buffer. The writable bytes of the target buffer will be decremented by the number of bytes written into it. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a5b7e5c4865edf90d4ff58b72ac2b2cf7">More...</a><br /></td></tr> |
| <tr class="separator:a5b7e5c4865edf90d4ff58b72ac2b2cf7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a65c315b77a586a271aa288ef2dbbdd1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a65c315b77a586a271aa288ef2dbbdd1c">ReadBytes</a> (byte[] target, int offset, int length)</td></tr> |
| <tr class="memdesc:a65c315b77a586a271aa288ef2dbbdd1c"><td class="mdescLeft"> </td><td class="mdescRight">Reads bytes from this delivery and writes them into the destination array starting at the given offset and continuing for the specified length reducing the available bytes by the value of the number of bytes written to the target. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a65c315b77a586a271aa288ef2dbbdd1c">More...</a><br /></td></tr> |
| <tr class="separator:a65c315b77a586a271aa288ef2dbbdd1c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4918683947dff96ff1975dbaa775884d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a4918683947dff96ff1975dbaa775884d">Disposition</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> state)</td></tr> |
| <tr class="memdesc:a4918683947dff96ff1975dbaa775884d"><td class="mdescLeft"> </td><td class="mdescRight">Update the delivery with the given disposition if not locally settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a4918683947dff96ff1975dbaa775884d">More...</a><br /></td></tr> |
| <tr class="separator:a4918683947dff96ff1975dbaa775884d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7d77f3b804e897c8187743f6000307dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a7d77f3b804e897c8187743f6000307dd">Disposition</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> state, bool settled)</td></tr> |
| <tr class="memdesc:a7d77f3b804e897c8187743f6000307dd"><td class="mdescLeft"> </td><td class="mdescRight">Update the delivery with the given disposition if not locally settled and optionally settles the delivery if not already settled. Applies the given delivery state and local settlement value to this delivery writing a new disposition frame if the remote has not already settled the delivery. Once locally settled no additional updates to the local delivery state can be applied and if attempted an exception will be thrown to indicate this is not possible. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a7d77f3b804e897c8187743f6000307dd">More...</a><br /></td></tr> |
| <tr class="separator:a7d77f3b804e897c8187743f6000307dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75d2908ef7974c16927b1faa7af461ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a75d2908ef7974c16927b1faa7af461ea">Settle</a> ()</td></tr> |
| <tr class="memdesc:a75d2908ef7974c16927b1faa7af461ea"><td class="mdescLeft"> </td><td class="mdescRight">Settles this delivery locally, transmitting a disposition frame to the remote if the remote has not already settled the delivery. Once locally settled the delivery will not accept any additional updates to the delivery state via one of the disposition methods. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a75d2908ef7974c16927b1faa7af461ea">More...</a><br /></td></tr> |
| <tr class="separator:a75d2908ef7974c16927b1faa7af461ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaa71f884fa54e6b1dc684a11903d4b81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#aaa71f884fa54e6b1dc684a11903d4b81">DeliveryReadHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > handler)</td></tr> |
| <tr class="memdesc:aaa71f884fa54e6b1dc684a11903d4b81"><td class="mdescLeft"> </td><td class="mdescRight">Handler for incoming deliveries that is called for each incoming transfer frame that comprises either one complete delivery or a chunk of a split framed transfer. The handler should check that the delivery being read is partial or not and act accordingly, as partial deliveries expect additional updates as more frames comprising that delivery arrive or the remote aborts the transfer. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#aaa71f884fa54e6b1dc684a11903d4b81">More...</a><br /></td></tr> |
| <tr class="separator:aaa71f884fa54e6b1dc684a11903d4b81"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a4e6ecc7233ad70815cafcd30d69ef9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a2a4e6ecc7233ad70815cafcd30d69ef9">DeliveryAbortedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > handler)</td></tr> |
| <tr class="memdesc:a2a4e6ecc7233ad70815cafcd30d69ef9"><td class="mdescLeft"> </td><td class="mdescRight">Handler for aborted deliveries that is called for each aborted in-progress delivery. This handler is an optional convenience handler that supplements the standard delivery read event handler in cases where the users wishes to break out the processing of inbound delivery data from abort processing. If this handler is not set the delivery will call the registered delivery read handler if one is set. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a2a4e6ecc7233ad70815cafcd30d69ef9">More...</a><br /></td></tr> |
| <tr class="separator:a2a4e6ecc7233ad70815cafcd30d69ef9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a992f7c6edfa30ac41ee822da60467e60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a992f7c6edfa30ac41ee822da60467e60">DeliveryStateUpdatedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > handler)</td></tr> |
| <tr class="memdesc:a992f7c6edfa30ac41ee822da60467e60"><td class="mdescLeft"> </td><td class="mdescRight">Handler for updates to the remote state of incoming deliveries that have previously been received. Remote state updates for an previously received delivery can happen when the remote settles a complete delivery or otherwise modifies the delivery outcome and the user needs to act on those changes such as a spontaneous update to the delivery state. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a992f7c6edfa30ac41ee822da60467e60">More...</a><br /></td></tr> |
| <tr class="separator:a992f7c6edfa30ac41ee822da60467e60"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a6741e02787b9ed1bcf5f6a947cdc6eec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a6741e02787b9ed1bcf5f6a947cdc6eec">Receiver</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6741e02787b9ed1bcf5f6a947cdc6eec"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the parent receiver that read this delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a6741e02787b9ed1bcf5f6a947cdc6eec">More...</a><br /></td></tr> |
| <tr class="separator:a6741e02787b9ed1bcf5f6a947cdc6eec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd581945f321d468e5a82dba8f08099d"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#acd581945f321d468e5a82dba8f08099d">Available</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acd581945f321d468e5a82dba8f08099d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes that are currently available for reading from this incoming delivery. Note that this value will change as bytes are received, and is in general not equal to the total length of a delivery until the point where the is partial check returns false and no content has yet been received by the application. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#acd581945f321d468e5a82dba8f08099d">More...</a><br /></td></tr> |
| <tr class="separator:acd581945f321d468e5a82dba8f08099d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0ea113e87aa3ec04debe3203ccf44eb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a0ea113e87aa3ec04debe3203ccf44eb4">DefaultDeliveryState</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a0ea113e87aa3ec04debe3203ccf44eb4"><td class="mdescLeft"> </td><td class="mdescRight">Configures a default delivery state to be used if a received delivery is settled/freed without any disposition state having been previously applied. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a0ea113e87aa3ec04debe3203ccf44eb4">More...</a><br /></td></tr> |
| <tr class="separator:a0ea113e87aa3ec04debe3203ccf44eb4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a50f5c5927bc6133889f3a487fc3216b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a50f5c5927bc6133889f3a487fc3216b4">Attachments</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a50f5c5927bc6133889f3a487fc3216b4"><td class="mdescLeft"> </td><td class="mdescRight">Access the attachments instance that allows callers to attach state data to an incoming delivery instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a50f5c5927bc6133889f3a487fc3216b4">More...</a><br /></td></tr> |
| <tr class="separator:a50f5c5927bc6133889f3a487fc3216b4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0ba693be924197e0193ca6e00d1546b2"><td class="memItemLeft" align="right" valign="top">object </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a0ba693be924197e0193ca6e00d1546b2">LinkedResource</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a0ba693be924197e0193ca6e00d1546b2"><td class="mdescLeft"> </td><td class="mdescRight">Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this incoming delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a0ba693be924197e0193ca6e00d1546b2">More...</a><br /></td></tr> |
| <tr class="separator:a0ba693be924197e0193ca6e00d1546b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0b0bb1dd66edc00ac18e201ea2becf27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">IDeliveryTag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a0b0bb1dd66edc00ac18e201ea2becf27">DeliveryTag</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a0b0bb1dd66edc00ac18e201ea2becf27"><td class="mdescLeft"> </td><td class="mdescRight">Access the delivery tag that the remote sender assigned to this incoming delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a0b0bb1dd66edc00ac18e201ea2becf27">More...</a><br /></td></tr> |
| <tr class="separator:a0b0bb1dd66edc00ac18e201ea2becf27"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a82368bafab4e1c3f61448dac4e0151d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a82368bafab4e1c3f61448dac4e0151d8">State</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a82368bafab4e1c3f61448dac4e0151d8"><td class="mdescLeft"> </td><td class="mdescRight">Access the delivery state assigned by the local end of this delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a82368bafab4e1c3f61448dac4e0151d8">More...</a><br /></td></tr> |
| <tr class="separator:a82368bafab4e1c3f61448dac4e0151d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a090068071298693bb306569433eb8d41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a090068071298693bb306569433eb8d41">RemoteState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a090068071298693bb306569433eb8d41"><td class="mdescLeft"> </td><td class="mdescRight">Access the delivery state assigned by the remote end of this delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a090068071298693bb306569433eb8d41">More...</a><br /></td></tr> |
| <tr class="separator:a090068071298693bb306569433eb8d41"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac22c8154c9e4804518c7ab4e6c41f983"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#ac22c8154c9e4804518c7ab4e6c41f983">MessageFormat</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac22c8154c9e4804518c7ab4e6c41f983"><td class="mdescLeft"> </td><td class="mdescRight">Access the message-format for this Delivery, representing the 32bit value using an unsigned int. The default value is 0 as per the message format defined in the core AMQP 1.0 specification. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#ac22c8154c9e4804518c7ab4e6c41f983">More...</a><br /></td></tr> |
| <tr class="separator:ac22c8154c9e4804518c7ab4e6c41f983"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af7b053fdcb6693e76dcc64b0c5fd1e56"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#af7b053fdcb6693e76dcc64b0c5fd1e56">IsPartial</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af7b053fdcb6693e76dcc64b0c5fd1e56"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the delivery is partial or has been completed by the remote. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#af7b053fdcb6693e76dcc64b0c5fd1e56">More...</a><br /></td></tr> |
| <tr class="separator:af7b053fdcb6693e76dcc64b0c5fd1e56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a2746493a491dfb58a5c4d50376573f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a4a2746493a491dfb58a5c4d50376573f">IsAborted</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4a2746493a491dfb58a5c4d50376573f"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the delivery has been aborted by the remote sender. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a4a2746493a491dfb58a5c4d50376573f">More...</a><br /></td></tr> |
| <tr class="separator:a4a2746493a491dfb58a5c4d50376573f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4d4fde2a28b84b6c12abbb86d57462f7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a4d4fde2a28b84b6c12abbb86d57462f7">IsSettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4d4fde2a28b84b6c12abbb86d57462f7"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the delivery has been settled locally. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a4d4fde2a28b84b6c12abbb86d57462f7">More...</a><br /></td></tr> |
| <tr class="separator:a4d4fde2a28b84b6c12abbb86d57462f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7482ccfe249d5dbef8a7b09a510c97bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a7482ccfe249d5dbef8a7b09a510c97bb">IsRemotelySettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7482ccfe249d5dbef8a7b09a510c97bb"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the delivery has been settled by the remote. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#a7482ccfe249d5dbef8a7b09a510c97bb">More...</a><br /></td></tr> |
| <tr class="separator:a7482ccfe249d5dbef8a7b09a510c97bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3aaea9a319cb20feacf4b5ee06e4027"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#af3aaea9a319cb20feacf4b5ee06e4027">TransferCount</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af3aaea9a319cb20feacf4b5ee06e4027"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of transfer frames that have occurred for this delivery so far. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html#af3aaea9a319cb20feacf4b5ee06e4027">More...</a><br /></td></tr> |
| <tr class="separator:af3aaea9a319cb20feacf4b5ee06e4027"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents an incoming delivery that is received by a local receiver from a remote sender on an open link. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a657d1bfb97adfd6dbb7cf4e3a9f0b52b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a657d1bfb97adfd6dbb7cf4e3a9f0b52b">◆ </a></span>ClaimAvailableBytes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.ClaimAvailableBytes </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Marks all available bytes as being claimed by the caller meaning that available byte count value can be returned to the session which can expand the session incoming window to allow more bytes to be sent from the remote peer. This method is useful in the case where the session has been configured with a small incoming capacity and the receiver needs to expand the session window in order to read the entire contents of a delivery whose payload exceeds the configured session capacity. The incoming delivery implementation will track the amount of claimed bytes and ensure that it never releases back more bytes to the session than has actually been received as a whole which allows this method to be called with each incoming transfer frame of a large split framed delivery. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a452291dd3ac692f57f7f0d09905adab0">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2a4e6ecc7233ad70815cafcd30d69ef9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a4e6ecc7233ad70815cafcd30d69ef9">◆ </a></span>DeliveryAbortedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.DeliveryAbortedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for aborted deliveries that is called for each aborted in-progress delivery. This handler is an optional convenience handler that supplements the standard delivery read event handler in cases where the users wishes to break out the processing of inbound delivery data from abort processing. If this handler is not set the delivery will call the registered delivery read handler if one is set. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>A delegate that will handle this event</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a30f891957ba9ee1bb9cbdc81d3ad2a55">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aaa71f884fa54e6b1dc684a11903d4b81"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaa71f884fa54e6b1dc684a11903d4b81">◆ </a></span>DeliveryReadHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.DeliveryReadHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for incoming deliveries that is called for each incoming transfer frame that comprises either one complete delivery or a chunk of a split framed transfer. The handler should check that the delivery being read is partial or not and act accordingly, as partial deliveries expect additional updates as more frames comprising that delivery arrive or the remote aborts the transfer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>A delegate that will handle this event</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#ac4de084d12906cc419cc116a0c045942">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a992f7c6edfa30ac41ee822da60467e60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a992f7c6edfa30ac41ee822da60467e60">◆ </a></span>DeliveryStateUpdatedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.DeliveryStateUpdatedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for updates to the remote state of incoming deliveries that have previously been received. Remote state updates for an previously received delivery can happen when the remote settles a complete delivery or otherwise modifies the delivery outcome and the user needs to act on those changes such as a spontaneous update to the delivery state. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>A delegate that will handle this event</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#ad92e7ab99e3685f2e5a97bf39dcdd7f9">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a4918683947dff96ff1975dbaa775884d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4918683947dff96ff1975dbaa775884d">◆ </a></span>Disposition() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.Disposition </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> </td> |
| <td class="paramname"><em>state</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Update the delivery with the given disposition if not locally settled. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">state</td><td>The delivery state to apply to this delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a3b359dcb574f9d0665415a2c6df1a9bc">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7d77f3b804e897c8187743f6000307dd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7d77f3b804e897c8187743f6000307dd">◆ </a></span>Disposition() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.Disposition </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> </td> |
| <td class="paramname"><em>state</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>settled</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Update the delivery with the given disposition if not locally settled and optionally settles the delivery if not already settled. Applies the given delivery state and local settlement value to this delivery writing a new disposition frame if the remote has not already settled the delivery. Once locally settled no additional updates to the local delivery state can be applied and if attempted an exception will be thrown to indicate this is not possible. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">state</td><td>The delivery state to apply to this delivery</td></tr> |
| <tr><td class="paramname">settled</td><td>Should the delivery be settled</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidOperationException</td><td>If already locally settled"</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a86751af1c661f647c1892065f4401f3f">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aaea181d03e53d361f86f8aca98134563"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaea181d03e53d361f86f8aca98134563">◆ </a></span>ReadAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.ReadAll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the current read buffer without copying it effectively consuming all currently available bytes from this delivery. If no data is available then this method returns null. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The currently available delivery bytes without copying them.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a5c4c791e523888514ee828e2d947b676">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a65c315b77a586a271aa288ef2dbbdd1c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a65c315b77a586a271aa288ef2dbbdd1c">◆ </a></span>ReadBytes() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.ReadBytes </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>target</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>offset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads bytes from this delivery and writes them into the destination array starting at the given offset and continuing for the specified length reducing the available bytes by the value of the number of bytes written to the target. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">target</td><td>The byte array where the bytes are written</td></tr> |
| <tr><td class="paramname">offset</td><td>The offset into the array to start writing at</td></tr> |
| <tr><td class="paramname">length</td><td>The number of bytes to write into the array</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a0006165549116f364171d0f1bf0486c4">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5b7e5c4865edf90d4ff58b72ac2b2cf7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5b7e5c4865edf90d4ff58b72ac2b2cf7">◆ </a></span>ReadBytes() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.ReadBytes </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>buffer</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads bytes from this delivery and writes them into the destination buffer reducing the available bytes by the value of the number of bytes written to the target. The number of bytes written will be the equal to the writable bytes of the target buffer. The writable bytes of the target buffer will be decremented by the number of bytes written into it. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer to write into</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#a8b2c96f47d5f5b3508d2a74738a5f98f">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a75d2908ef7974c16927b1faa7af461ea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a75d2908ef7974c16927b1faa7af461ea">◆ </a></span>Settle()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.Settle </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Settles this delivery locally, transmitting a disposition frame to the remote if the remote has not already settled the delivery. Once locally settled the delivery will not accept any additional updates to the delivery state via one of the disposition methods. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This incoming delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonIncomingDelivery.html#ae61e4d52865bdc1d2645f7c7ffcfb074">Apache.Qpid.Proton.Engine.Implementation.ProtonIncomingDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a50f5c5927bc6133889f3a487fc3216b4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a50f5c5927bc6133889f3a487fc3216b4">◆ </a></span>Attachments</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.Attachments</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Access the attachments instance that allows callers to attach state data to an incoming delivery instance. </p> |
| |
| </div> |
| </div> |
| <a id="acd581945f321d468e5a82dba8f08099d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd581945f321d468e5a82dba8f08099d">◆ </a></span>Available</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Engine.IIncomingDelivery.Available</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the number of bytes that are currently available for reading from this incoming delivery. Note that this value will change as bytes are received, and is in general not equal to the total length of a delivery until the point where the is partial check returns false and no content has yet been received by the application. </p> |
| |
| </div> |
| </div> |
| <a id="a0ea113e87aa3ec04debe3203ccf44eb4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0ea113e87aa3ec04debe3203ccf44eb4">◆ </a></span>DefaultDeliveryState</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.DefaultDeliveryState</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures a default delivery state to be used if a received delivery is settled/freed without any disposition state having been previously applied. </p> |
| |
| </div> |
| </div> |
| <a id="a0b0bb1dd66edc00ac18e201ea2becf27"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0b0bb1dd66edc00ac18e201ea2becf27">◆ </a></span>DeliveryTag</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1IDeliveryTag.html">IDeliveryTag</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.DeliveryTag</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Access the delivery tag that the remote sender assigned to this incoming delivery. </p> |
| |
| </div> |
| </div> |
| <a id="a4a2746493a491dfb58a5c4d50376573f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4a2746493a491dfb58a5c4d50376573f">◆ </a></span>IsAborted</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Engine.IIncomingDelivery.IsAborted</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the delivery has been aborted by the remote sender. </p> |
| |
| </div> |
| </div> |
| <a id="af7b053fdcb6693e76dcc64b0c5fd1e56"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af7b053fdcb6693e76dcc64b0c5fd1e56">◆ </a></span>IsPartial</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Engine.IIncomingDelivery.IsPartial</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the delivery is partial or has been completed by the remote. </p> |
| |
| </div> |
| </div> |
| <a id="a7482ccfe249d5dbef8a7b09a510c97bb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7482ccfe249d5dbef8a7b09a510c97bb">◆ </a></span>IsRemotelySettled</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Engine.IIncomingDelivery.IsRemotelySettled</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the delivery has been settled by the remote. </p> |
| |
| </div> |
| </div> |
| <a id="a4d4fde2a28b84b6c12abbb86d57462f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4d4fde2a28b84b6c12abbb86d57462f7">◆ </a></span>IsSettled</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Engine.IIncomingDelivery.IsSettled</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the delivery has been settled locally. </p> |
| |
| </div> |
| </div> |
| <a id="a0ba693be924197e0193ca6e00d1546b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0ba693be924197e0193ca6e00d1546b2">◆ </a></span>LinkedResource</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">object Apache.Qpid.Proton.Engine.IIncomingDelivery.LinkedResource</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this incoming delivery. </p> |
| |
| </div> |
| </div> |
| <a id="ac22c8154c9e4804518c7ab4e6c41f983"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac22c8154c9e4804518c7ab4e6c41f983">◆ </a></span>MessageFormat</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.IIncomingDelivery.MessageFormat</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Access the message-format for this Delivery, representing the 32bit value using an unsigned int. The default value is 0 as per the message format defined in the core AMQP 1.0 specification. </p> |
| |
| </div> |
| </div> |
| <a id="a6741e02787b9ed1bcf5f6a947cdc6eec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6741e02787b9ed1bcf5f6a947cdc6eec">◆ </a></span>Receiver</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.Receiver</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a reference to the parent receiver that read this delivery. </p> |
| |
| </div> |
| </div> |
| <a id="a090068071298693bb306569433eb8d41"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a090068071298693bb306569433eb8d41">◆ </a></span>RemoteState</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.RemoteState</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Access the delivery state assigned by the remote end of this delivery. </p> |
| |
| </div> |
| </div> |
| <a id="a82368bafab4e1c3f61448dac4e0151d8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a82368bafab4e1c3f61448dac4e0151d8">◆ </a></span>State</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> Apache.Qpid.Proton.Engine.IIncomingDelivery.State</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Access the delivery state assigned by the local end of this delivery. </p> |
| |
| </div> |
| </div> |
| <a id="af3aaea9a319cb20feacf4b5ee06e4027"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af3aaea9a319cb20feacf4b5ee06e4027">◆ </a></span>TransferCount</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.IIncomingDelivery.TransferCount</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the total number of transfer frames that have occurred for this delivery so far. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Engine/IIncomingDelivery.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
