| <!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.Client.IDelivery 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_1Client.html">Client</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</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_1Client_1_1IDelivery-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.IDelivery Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A single AMQP delivery tracker instance. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.IDelivery:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.png" usemap="#Apache.Qpid.Proton.Client.IDelivery_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.IDelivery_map" name="Apache.Qpid.Proton.Client.IDelivery_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html" title="Client inbound delivery API that wraps the proton resources and provides API to operate on them." alt="Apache.Qpid.Proton.Client.Implementation.ClientDelivery" shape="rect" coords="0,56,334,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:aeba70d20d0f2a712a763a5deddcb8b05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IMessage.html">IMessage</a>< object > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aeba70d20d0f2a712a763a5deddcb8b05">Message</a> ()</td></tr> |
| <tr class="memdesc:aeba70d20d0f2a712a763a5deddcb8b05"><td class="mdescLeft"> </td><td class="mdescRight">Decodes the payload of the delivery and returns a new message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aeba70d20d0f2a712a763a5deddcb8b05">More...</a><br /></td></tr> |
| <tr class="separator:aeba70d20d0f2a712a763a5deddcb8b05"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1ae20278de90dd03fdd8de977a8a0692"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a1ae20278de90dd03fdd8de977a8a0692">Accept</a> ()</td></tr> |
| <tr class="memdesc:a1ae20278de90dd03fdd8de977a8a0692"><td class="mdescLeft"> </td><td class="mdescRight">Accepts and settles this delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a1ae20278de90dd03fdd8de977a8a0692">More...</a><br /></td></tr> |
| <tr class="separator:a1ae20278de90dd03fdd8de977a8a0692"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6371857f910a15c8c9ab54188800bc8e"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a6371857f910a15c8c9ab54188800bc8e">AcceptAsync</a> ()</td></tr> |
| <tr class="memdesc:a6371857f910a15c8c9ab54188800bc8e"><td class="mdescLeft"> </td><td class="mdescRight">Accepts and settles this delivery asynchronously ensuring that the call does not block on any IO or other client operations. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a6371857f910a15c8c9ab54188800bc8e">More...</a><br /></td></tr> |
| <tr class="separator:a6371857f910a15c8c9ab54188800bc8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a19c31845755fea7f86f1151a328f3bc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a19c31845755fea7f86f1151a328f3bc7">Release</a> ()</td></tr> |
| <tr class="memdesc:a19c31845755fea7f86f1151a328f3bc7"><td class="mdescLeft"> </td><td class="mdescRight">Releases and settles this delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a19c31845755fea7f86f1151a328f3bc7">More...</a><br /></td></tr> |
| <tr class="separator:a19c31845755fea7f86f1151a328f3bc7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a28ad706bb682b98db653656a924794"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a6a28ad706bb682b98db653656a924794">ReleaseAsync</a> ()</td></tr> |
| <tr class="memdesc:a6a28ad706bb682b98db653656a924794"><td class="mdescLeft"> </td><td class="mdescRight">Releases and settles this delivery asynchronously ensuring that the call does not block on any IO or other client operations. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a6a28ad706bb682b98db653656a924794">More...</a><br /></td></tr> |
| <tr class="separator:a6a28ad706bb682b98db653656a924794"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75416678e73a24b0e0a7b82f0b26e98b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a75416678e73a24b0e0a7b82f0b26e98b">Reject</a> (string condition, string description)</td></tr> |
| <tr class="memdesc:a75416678e73a24b0e0a7b82f0b26e98b"><td class="mdescLeft"> </td><td class="mdescRight">Rejects the delivery with an ErrorCondition that contains the provided condition and description information and settles. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a75416678e73a24b0e0a7b82f0b26e98b">More...</a><br /></td></tr> |
| <tr class="separator:a75416678e73a24b0e0a7b82f0b26e98b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec50e1f3b016cbca311812db1d3f388a"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aec50e1f3b016cbca311812db1d3f388a">RejectAsync</a> (string condition, string description)</td></tr> |
| <tr class="memdesc:aec50e1f3b016cbca311812db1d3f388a"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously rejects the delivery with an ErrorCondition that contains the provided condition and description information and settles. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aec50e1f3b016cbca311812db1d3f388a">More...</a><br /></td></tr> |
| <tr class="separator:aec50e1f3b016cbca311812db1d3f388a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd690dffab589589fd74b7b336d9a9d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#abd690dffab589589fd74b7b336d9a9d0">Modified</a> (bool deliveryFailed, bool undeliverableHere)</td></tr> |
| <tr class="memdesc:abd690dffab589589fd74b7b336d9a9d0"><td class="mdescLeft"> </td><td class="mdescRight">Modifies and settles the delivery applying the failure and routing options. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#abd690dffab589589fd74b7b336d9a9d0">More...</a><br /></td></tr> |
| <tr class="separator:abd690dffab589589fd74b7b336d9a9d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3b5e5bb1d9623f4fa10c518356669759"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a3b5e5bb1d9623f4fa10c518356669759">ModifiedAsync</a> (bool deliveryFailed, bool undeliverableHere)</td></tr> |
| <tr class="memdesc:a3b5e5bb1d9623f4fa10c518356669759"><td class="mdescLeft"> </td><td class="mdescRight">Modifies and settles the delivery asynchronously applying the failure and routing options without any blocking due to IO or other client internal operations. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a3b5e5bb1d9623f4fa10c518356669759">More...</a><br /></td></tr> |
| <tr class="separator:a3b5e5bb1d9623f4fa10c518356669759"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a57ec79ebe62b9942023120ddcca61ab7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a57ec79ebe62b9942023120ddcca61ab7">Disposition</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> state, bool settled)</td></tr> |
| <tr class="memdesc:a57ec79ebe62b9942023120ddcca61ab7"><td class="mdescLeft"> </td><td class="mdescRight">Applies the given delivery state to the delivery if not already settled and optionally settles it. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a57ec79ebe62b9942023120ddcca61ab7">More...</a><br /></td></tr> |
| <tr class="separator:a57ec79ebe62b9942023120ddcca61ab7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba59eb8ce1c3fc12e062da36f564c115"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aba59eb8ce1c3fc12e062da36f564c115">DispositionAsync</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> state, bool settled)</td></tr> |
| <tr class="memdesc:aba59eb8ce1c3fc12e062da36f564c115"><td class="mdescLeft"> </td><td class="mdescRight">Applies the given delivery state to the delivery if not already settled and optionally settles it performing all IO and client work asynchronously ensuring that any calls to this method do not block. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aba59eb8ce1c3fc12e062da36f564c115">More...</a><br /></td></tr> |
| <tr class="separator:aba59eb8ce1c3fc12e062da36f564c115"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c71f9dd00da26d4a6d5bb17d42581be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a4c71f9dd00da26d4a6d5bb17d42581be">Settle</a> ()</td></tr> |
| <tr class="memdesc:a4c71f9dd00da26d4a6d5bb17d42581be"><td class="mdescLeft"> </td><td class="mdescRight">Settles the delivery with the remote which prevents any further delivery state updates. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a4c71f9dd00da26d4a6d5bb17d42581be">More...</a><br /></td></tr> |
| <tr class="separator:a4c71f9dd00da26d4a6d5bb17d42581be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34a8149e4613bdb973c55ed300e10fec"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a34a8149e4613bdb973c55ed300e10fec">SettleAsync</a> ()</td></tr> |
| <tr class="memdesc:a34a8149e4613bdb973c55ed300e10fec"><td class="mdescLeft"> </td><td class="mdescRight">Settles the delivery with the remote which prevents any further delivery state updates asynchronously. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a34a8149e4613bdb973c55ed300e10fec">More...</a><br /></td></tr> |
| <tr class="separator:a34a8149e4613bdb973c55ed300e10fec"><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:a2156931772991e88009ea7fc5b341d80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html">IReceiver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a2156931772991e88009ea7fc5b341d80">Receiver</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2156931772991e88009ea7fc5b341d80"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent receiver instance where this delivery arrived. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a2156931772991e88009ea7fc5b341d80">More...</a><br /></td></tr> |
| <tr class="separator:a2156931772991e88009ea7fc5b341d80"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd84b98c821391002d94466bc90309cf"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#acd84b98c821391002d94466bc90309cf">MessageFormat</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acd84b98c821391002d94466bc90309cf"><td class="mdescLeft"> </td><td class="mdescRight">The message format value that was transmitted with this delivery (default is zero). <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#acd84b98c821391002d94466bc90309cf">More...</a><br /></td></tr> |
| <tr class="separator:acd84b98c821391002d94466bc90309cf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5be32b6ba75b951fce0421ba616aa54e"><td class="memItemLeft" align="right" valign="top">Stream </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a5be32b6ba75b951fce0421ba616aa54e">RawInputStream</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5be32b6ba75b951fce0421ba616aa54e"><td class="mdescLeft"> </td><td class="mdescRight">Create and return an read-only Stream that reads the raw payload bytes of the given delivery. Calling this method claims the payload of the delivery for the returned Stream and excludes use of the message and annotations API methods of the delivery object. Closing the returned input stream discards any unread bytes from the delivery payload. Calling the message or annotations methods after calling this method will throw a ClientIllegalStateException. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a5be32b6ba75b951fce0421ba616aa54e">More...</a><br /></td></tr> |
| <tr class="separator:a5be32b6ba75b951fce0421ba616aa54e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa81be3ff2e9614b778dcc04014c3b68f"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary< string, object > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aa81be3ff2e9614b778dcc04014c3b68f">Annotations</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aa81be3ff2e9614b778dcc04014c3b68f"><td class="mdescLeft"> </td><td class="mdescRight">Decodes the delivery payload and returns a dictionary containing a copy of any associated delivery annotations that were transmitted with the message payload. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#aa81be3ff2e9614b778dcc04014c3b68f">More...</a><br /></td></tr> |
| <tr class="separator:aa81be3ff2e9614b778dcc04014c3b68f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbe3a6e5ade6a95a6f0a41264445f94a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#afbe3a6e5ade6a95a6f0a41264445f94a">Settled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afbe3a6e5ade6a95a6f0a41264445f94a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this delivery has already been settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#afbe3a6e5ade6a95a6f0a41264445f94a">More...</a><br /></td></tr> |
| <tr class="separator:afbe3a6e5ade6a95a6f0a41264445f94a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9c2630b4deb9f5d6cf5076015d48b633"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a9c2630b4deb9f5d6cf5076015d48b633">State</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9c2630b4deb9f5d6cf5076015d48b633"><td class="mdescLeft"> </td><td class="mdescRight">Returns the currently set delivery state for this delivery or null if none set. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a9c2630b4deb9f5d6cf5076015d48b633">More...</a><br /></td></tr> |
| <tr class="separator:a9c2630b4deb9f5d6cf5076015d48b633"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36731502f95a9b1e50777445d9e44f07"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a36731502f95a9b1e50777445d9e44f07">RemoteSettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a36731502f95a9b1e50777445d9e44f07"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this delivery has already been settled by the remote. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a36731502f95a9b1e50777445d9e44f07">More...</a><br /></td></tr> |
| <tr class="separator:a36731502f95a9b1e50777445d9e44f07"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9c783ea002a8115475b2d9cd890ba0a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a9c783ea002a8115475b2d9cd890ba0a3">RemoteState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9c783ea002a8115475b2d9cd890ba0a3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the currently set delivery state for this delivery as set by the remote or null if none set. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#a9c783ea002a8115475b2d9cd890ba0a3">More...</a><br /></td></tr> |
| <tr class="separator:a9c783ea002a8115475b2d9cd890ba0a3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A single AMQP delivery tracker instance. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a1ae20278de90dd03fdd8de977a8a0692"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1ae20278de90dd03fdd8de977a8a0692">◆ </a></span>Accept()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IDelivery.Accept </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accepts and settles this delivery. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#aa0dfd17c070e80edc8a4e5af513a6fdf">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6371857f910a15c8c9ab54188800bc8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6371857f910a15c8c9ab54188800bc8e">◆ </a></span>AcceptAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a>> Apache.Qpid.Proton.Client.IDelivery.AcceptAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accepts and settles this delivery asynchronously ensuring that the call does not block on any IO or other client operations. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that returns this delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#abfa1a80380f4bf10ddbb2e5faa2bf394">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a57ec79ebe62b9942023120ddcca61ab7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57ec79ebe62b9942023120ddcca61ab7">◆ </a></span>Disposition()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IDelivery.Disposition </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_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>Applies the given delivery state to the delivery if not already settled and optionally settles it. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">state</td><td>delivery state to apply to this delivery</td></tr> |
| <tr><td class="paramname">settled</td><td>optionally settles the delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a01b3965f15c3edd1cd1a3295b46cd4cb">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aba59eb8ce1c3fc12e062da36f564c115"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba59eb8ce1c3fc12e062da36f564c115">◆ </a></span>DispositionAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a>> Apache.Qpid.Proton.Client.IDelivery.DispositionAsync </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_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>Applies the given delivery state to the delivery if not already settled and optionally settles it performing all IO and client work asynchronously ensuring that any calls to this method do not block. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">state</td><td>delivery state to apply to this delivery</td></tr> |
| <tr><td class="paramname">settled</td><td>optionally settles the delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that returns this delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#aeafbae337dc75679d48bc236d74541d7">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aeba70d20d0f2a712a763a5deddcb8b05"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeba70d20d0f2a712a763a5deddcb8b05">◆ </a></span>Message()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IMessage.html">IMessage</a><object> Apache.Qpid.Proton.Client.IDelivery.Message </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Decodes the payload of the delivery and returns a new message. </p> |
| <p>Calling this message claims the payload of the delivery for the returned Message and excludes use of the RawInputStream method of the delivery object. Calling the RawInputStream method after calling this method throws ClientIllegalStateException.</p> |
| <p>If the incoming message carried any delivery annotations they can be accessed via the Annotations method. Re-sending the returned message will not also send the incoming delivery annotations, the sender must include them in the sender's send call if they are to be forwarded onto the next recipient. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>Body type of the message</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the decoded message from the delivery payload</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a6e4e42a69582f7c3437a2c61ff443132">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="abd690dffab589589fd74b7b336d9a9d0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abd690dffab589589fd74b7b336d9a9d0">◆ </a></span>Modified()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IDelivery.Modified </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>deliveryFailed</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>undeliverableHere</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Modifies and settles the delivery applying the failure and routing options. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">deliveryFailed</td><td>If the delivery failed on this receiver for some reason</td></tr> |
| <tr><td class="paramname">undeliverableHere</td><td>If the delivery should not be routed back to this receiver.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#adb1c12516cb29407d6815758e8743756">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a3b5e5bb1d9623f4fa10c518356669759"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3b5e5bb1d9623f4fa10c518356669759">◆ </a></span>ModifiedAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a>> Apache.Qpid.Proton.Client.IDelivery.ModifiedAsync </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>deliveryFailed</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>undeliverableHere</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Modifies and settles the delivery asynchronously applying the failure and routing options without any blocking due to IO or other client internal operations. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">deliveryFailed</td><td>If the delivery failed on this receiver for some reason</td></tr> |
| <tr><td class="paramname">undeliverableHere</td><td>If the delivery should not be routed back to this receiver.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that returns this delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a3ac0f47cacfb5b0826b6448bbbdd3f00">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a75416678e73a24b0e0a7b82f0b26e98b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a75416678e73a24b0e0a7b82f0b26e98b">◆ </a></span>Reject()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IDelivery.Reject </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>condition</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>description</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Rejects the delivery with an ErrorCondition that contains the provided condition and description information and settles. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">condition</td><td>The condition that defines this rejection error</td></tr> |
| <tr><td class="paramname">description</td><td>A description of the rejection cause.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a0627c59eaad1222be1e8cd5ff110bff2">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aec50e1f3b016cbca311812db1d3f388a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aec50e1f3b016cbca311812db1d3f388a">◆ </a></span>RejectAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a>> Apache.Qpid.Proton.Client.IDelivery.RejectAsync </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>condition</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>description</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Asynchronously rejects the delivery with an ErrorCondition that contains the provided condition and description information and settles. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">condition</td><td>The condition that defines this rejection error</td></tr> |
| <tr><td class="paramname">description</td><td>A description of the rejection cause.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that returns this delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a880d3daa77cf0a96e002c36a9040dbb4">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a19c31845755fea7f86f1151a328f3bc7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a19c31845755fea7f86f1151a328f3bc7">◆ </a></span>Release()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IDelivery.Release </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Releases and settles this delivery. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a0b1736abee6d80460ed481ad5f1bfe44">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6a28ad706bb682b98db653656a924794"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6a28ad706bb682b98db653656a924794">◆ </a></span>ReleaseAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a>> Apache.Qpid.Proton.Client.IDelivery.ReleaseAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Releases and settles this delivery asynchronously ensuring that the call does not block on any IO or other client operations. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that returns this delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#a2c2841d89b84f6dabe19e853fee30d5a">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a4c71f9dd00da26d4a6d5bb17d42581be"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4c71f9dd00da26d4a6d5bb17d42581be">◆ </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_1Client_1_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IDelivery.Settle </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Settles the delivery with the remote which prevents any further delivery state updates. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#aeeb03284bc29f8045be0d41e57af173f">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a34a8149e4613bdb973c55ed300e10fec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a34a8149e4613bdb973c55ed300e10fec">◆ </a></span>SettleAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a>> Apache.Qpid.Proton.Client.IDelivery.SettleAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Settles the delivery with the remote which prevents any further delivery state updates asynchronously. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that returns this delivery instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientDelivery.html#aacc69b3ac88c4cf3e82e2ded8a9f59bf">Apache.Qpid.Proton.Client.Implementation.ClientDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="aa81be3ff2e9614b778dcc04014c3b68f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa81be3ff2e9614b778dcc04014c3b68f">◆ </a></span>Annotations</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.IDelivery.Annotations</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>Decodes the delivery payload and returns a dictionary containing a copy of any associated delivery annotations that were transmitted with the message payload. </p> |
| <p>Calling this message claims the payload of the delivery for the message and annotations methods and excludes use of the RawInputStream method of the delivery object. Calling the RawInputStream method after calling this method throws ClientIllegalStateException.</p> |
| |
| </div> |
| </div> |
| <a id="acd84b98c821391002d94466bc90309cf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd84b98c821391002d94466bc90309cf">◆ </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.Client.IDelivery.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>The message format value that was transmitted with this delivery (default is zero). </p> |
| |
| </div> |
| </div> |
| <a id="a5be32b6ba75b951fce0421ba616aa54e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5be32b6ba75b951fce0421ba616aa54e">◆ </a></span>RawInputStream</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Stream Apache.Qpid.Proton.Client.IDelivery.RawInputStream</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>Create and return an read-only Stream that reads the raw payload bytes of the given delivery. Calling this method claims the payload of the delivery for the returned Stream and excludes use of the message and annotations API methods of the delivery object. Closing the returned input stream discards any unread bytes from the delivery payload. Calling the message or annotations methods after calling this method will throw a ClientIllegalStateException. </p> |
| |
| </div> |
| </div> |
| <a id="a2156931772991e88009ea7fc5b341d80"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2156931772991e88009ea7fc5b341d80">◆ </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_1Client_1_1IReceiver.html">IReceiver</a> Apache.Qpid.Proton.Client.IDelivery.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 the parent receiver instance where this delivery arrived. </p> |
| |
| </div> |
| </div> |
| <a id="a36731502f95a9b1e50777445d9e44f07"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a36731502f95a9b1e50777445d9e44f07">◆ </a></span>RemoteSettled</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.Client.IDelivery.RemoteSettled</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 true if this delivery has already been settled by the remote. </p> |
| |
| </div> |
| </div> |
| <a id="a9c783ea002a8115475b2d9cd890ba0a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9c783ea002a8115475b2d9cd890ba0a3">◆ </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_1Client_1_1IDeliveryState.html">IDeliveryState</a> Apache.Qpid.Proton.Client.IDelivery.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>Returns the currently set delivery state for this delivery as set by the remote or null if none set. </p> |
| |
| </div> |
| </div> |
| <a id="afbe3a6e5ade6a95a6f0a41264445f94a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbe3a6e5ade6a95a6f0a41264445f94a">◆ </a></span>Settled</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.Client.IDelivery.Settled</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 true if this delivery has already been settled. </p> |
| |
| </div> |
| </div> |
| <a id="a9c2630b4deb9f5d6cf5076015d48b633"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9c2630b4deb9f5d6cf5076015d48b633">◆ </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_1Client_1_1IDeliveryState.html">IDeliveryState</a> Apache.Qpid.Proton.Client.IDelivery.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>Returns the currently set delivery state for this delivery or null if none set. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/IDelivery.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> |
