| <!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.Implementation.ClientStreamDelivery Class 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="namespaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation.html">Implementation</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html">ClientStreamDelivery</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The stream delivery type manages the underlying state of an incoming streaming message delivery and provides the stream type used to read and block for reads when not all requested message data has arrived. The delivery will also manage settlement of a streaming delivery and apply receiver configuration rules like auto settlement to the delivery as incoming portions of the message arrive. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.png" usemap="#Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery_map" name="Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html" title="A specialized delivery type that is returned from the stream receiver which can be used to read incom..." alt="Apache.Qpid.Proton.Client.IStreamDelivery" shape="rect" coords="0,0,373,24"/> |
| </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:a1ff5d41191bb68ec51d7ffdb84114643"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiverMessage.html">IStreamReceiverMessage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a1ff5d41191bb68ec51d7ffdb84114643">Message</a> ()</td></tr> |
| <tr class="memdesc:a1ff5d41191bb68ec51d7ffdb84114643"><td class="mdescLeft"> </td><td class="mdescRight">Returns a stream receiver message type that will perform a decode of message payload as portions of the streamed message arrive. The message API is inherently a blocking API as the decoder will need to wait in some cases to decode a full section the incoming message when it is requested. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a1ff5d41191bb68ec51d7ffdb84114643">More...</a><br /></td></tr> |
| <tr class="separator:a1ff5d41191bb68ec51d7ffdb84114643"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2443b2d086003373de9c2a0e145312dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a2443b2d086003373de9c2a0e145312dd">Accept</a> ()</td></tr> |
| <tr class="memdesc:a2443b2d086003373de9c2a0e145312dd"><td class="mdescLeft"> </td><td class="mdescRight">Accepts and settles this delivery. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a2443b2d086003373de9c2a0e145312dd">More...</a><br /></td></tr> |
| <tr class="separator:a2443b2d086003373de9c2a0e145312dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad364b2fb21e0a42a85a4d2d397a4fc26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#ad364b2fb21e0a42a85a4d2d397a4fc26">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:ad364b2fb21e0a42a85a4d2d397a4fc26"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#ad364b2fb21e0a42a85a4d2d397a4fc26">More...</a><br /></td></tr> |
| <tr class="separator:ad364b2fb21e0a42a85a4d2d397a4fc26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ff2c30ca49ae6bf74f1615bd6f7ad7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a9ff2c30ca49ae6bf74f1615bd6f7ad7b">Modified</a> (bool deliveryFailed, bool undeliverableHere)</td></tr> |
| <tr class="memdesc:a9ff2c30ca49ae6bf74f1615bd6f7ad7b"><td class="mdescLeft"> </td><td class="mdescRight">Modifies and settles the delivery applying the failure and routing options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a9ff2c30ca49ae6bf74f1615bd6f7ad7b">More...</a><br /></td></tr> |
| <tr class="separator:a9ff2c30ca49ae6bf74f1615bd6f7ad7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a747d83557ed3896cb3d515de09b813"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a0a747d83557ed3896cb3d515de09b813">Reject</a> (string condition, string description)</td></tr> |
| <tr class="memdesc:a0a747d83557ed3896cb3d515de09b813"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a0a747d83557ed3896cb3d515de09b813">More...</a><br /></td></tr> |
| <tr class="separator:a0a747d83557ed3896cb3d515de09b813"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9c57dd2ef6a151b60eafbb241d1fb450"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a9c57dd2ef6a151b60eafbb241d1fb450">Release</a> ()</td></tr> |
| <tr class="memdesc:a9c57dd2ef6a151b60eafbb241d1fb450"><td class="mdescLeft"> </td><td class="mdescRight">Releases and settles this delivery. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a9c57dd2ef6a151b60eafbb241d1fb450">More...</a><br /></td></tr> |
| <tr class="separator:a9c57dd2ef6a151b60eafbb241d1fb450"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a006c1e16b1d986488e1aefcd1b7e5cdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a006c1e16b1d986488e1aefcd1b7e5cdb">Settle</a> ()</td></tr> |
| <tr class="memdesc:a006c1e16b1d986488e1aefcd1b7e5cdb"><td class="mdescLeft"> </td><td class="mdescRight">Settles the delivery with the remote which prevents any further delivery state updates. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a006c1e16b1d986488e1aefcd1b7e5cdb">More...</a><br /></td></tr> |
| <tr class="separator:a006c1e16b1d986488e1aefcd1b7e5cdb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a816f777393ee4c846c405baab9febebd"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a816f777393ee4c846c405baab9febebd">AcceptAsync</a> ()</td></tr> |
| <tr class="memdesc:a816f777393ee4c846c405baab9febebd"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a816f777393ee4c846c405baab9febebd">More...</a><br /></td></tr> |
| <tr class="separator:a816f777393ee4c846c405baab9febebd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa66476ce93e39df064c770d9a075254e"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#aa66476ce93e39df064c770d9a075254e">ReleaseAsync</a> ()</td></tr> |
| <tr class="memdesc:aa66476ce93e39df064c770d9a075254e"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#aa66476ce93e39df064c770d9a075254e">More...</a><br /></td></tr> |
| <tr class="separator:aa66476ce93e39df064c770d9a075254e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6e81a41fe04f5f18e63e54db687f33d"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#aa6e81a41fe04f5f18e63e54db687f33d">RejectAsync</a> (string condition, string description)</td></tr> |
| <tr class="memdesc:aa6e81a41fe04f5f18e63e54db687f33d"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#aa6e81a41fe04f5f18e63e54db687f33d">More...</a><br /></td></tr> |
| <tr class="separator:aa6e81a41fe04f5f18e63e54db687f33d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a72474444174596cf470f5be90fcf9b05"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a72474444174596cf470f5be90fcf9b05">ModifiedAsync</a> (bool deliveryFailed, bool undeliverableHere)</td></tr> |
| <tr class="memdesc:a72474444174596cf470f5be90fcf9b05"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a72474444174596cf470f5be90fcf9b05">More...</a><br /></td></tr> |
| <tr class="separator:a72474444174596cf470f5be90fcf9b05"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaaffcbe046418dcdcc35351cd8698cf9"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#aaaffcbe046418dcdcc35351cd8698cf9">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:aaaffcbe046418dcdcc35351cd8698cf9"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#aaaffcbe046418dcdcc35351cd8698cf9">More...</a><br /></td></tr> |
| <tr class="separator:aaaffcbe046418dcdcc35351cd8698cf9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96abbf5bee4264136bc0e51d5a4dc0da"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a96abbf5bee4264136bc0e51d5a4dc0da">SettleAsync</a> ()</td></tr> |
| <tr class="memdesc:a96abbf5bee4264136bc0e51d5a4dc0da"><td class="mdescLeft"> </td><td class="mdescRight">Settles the delivery with the remote which prevents any further delivery state updates asynchronously. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamDelivery.html#a96abbf5bee4264136bc0e51d5a4dc0da">More...</a><br /></td></tr> |
| <tr class="separator:a96abbf5bee4264136bc0e51d5a4dc0da"><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:ab664002123425f358928b7b4501d994b"><td class="memItemLeft" align="right" valign="top"><a id="ab664002123425f358928b7b4501d994b"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiver.html">IStreamReceiver</a> </td><td class="memItemRight" valign="bottom"><b>Receiver</b><code> [get]</code></td></tr> |
| <tr class="separator:ab664002123425f358928b7b4501d994b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a597a34f1d808b09f0cf8e61da4ad8eea"><td class="memItemLeft" align="right" valign="top"><a id="a597a34f1d808b09f0cf8e61da4ad8eea"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>Aborted</b><code> [get]</code></td></tr> |
| <tr class="separator:a597a34f1d808b09f0cf8e61da4ad8eea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f6d62e4f1d2630827ba680ebbbd4dae"><td class="memItemLeft" align="right" valign="top"><a id="a6f6d62e4f1d2630827ba680ebbbd4dae"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>Completed</b><code> [get]</code></td></tr> |
| <tr class="separator:a6f6d62e4f1d2630827ba680ebbbd4dae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a45eb187a6a4973a25f5eb9179018adc9"><td class="memItemLeft" align="right" valign="top"><a id="a45eb187a6a4973a25f5eb9179018adc9"></a> |
| uint </td><td class="memItemRight" valign="bottom"><b>MessageFormat</b><code> [get]</code></td></tr> |
| <tr class="separator:a45eb187a6a4973a25f5eb9179018adc9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa783a5cd302d40b5372526ebd3acee09"><td class="memItemLeft" align="right" valign="top"><a id="aa783a5cd302d40b5372526ebd3acee09"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>Settled</b><code> [get]</code></td></tr> |
| <tr class="separator:aa783a5cd302d40b5372526ebd3acee09"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa754ca3b594b9ec29106031a775934d9"><td class="memItemLeft" align="right" valign="top"><a id="aa754ca3b594b9ec29106031a775934d9"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><b>State</b><code> [get]</code></td></tr> |
| <tr class="separator:aa754ca3b594b9ec29106031a775934d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5fb636fcb3af0cb68bee0185ce52b917"><td class="memItemLeft" align="right" valign="top"><a id="a5fb636fcb3af0cb68bee0185ce52b917"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>RemoteSettled</b><code> [get]</code></td></tr> |
| <tr class="separator:a5fb636fcb3af0cb68bee0185ce52b917"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8a45c9725b425208a213aa28f968e010"><td class="memItemLeft" align="right" valign="top"><a id="a8a45c9725b425208a213aa28f968e010"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> </td><td class="memItemRight" valign="bottom"><b>RemoteState</b><code> [get]</code></td></tr> |
| <tr class="separator:a8a45c9725b425208a213aa28f968e010"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8222b7a48b11164cde21c1ae956bf169"><td class="memItemLeft" align="right" valign="top"><a id="a8222b7a48b11164cde21c1ae956bf169"></a> |
| IReadOnlyDictionary< string, object >? </td><td class="memItemRight" valign="bottom"><b>Annotations</b><code> [get]</code></td></tr> |
| <tr class="separator:a8222b7a48b11164cde21c1ae956bf169"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa017053e90477e7b71fbd7d3aef7a9ce"><td class="memItemLeft" align="right" valign="top"><a id="aa017053e90477e7b71fbd7d3aef7a9ce"></a> |
| Stream </td><td class="memItemRight" valign="bottom"><b>RawInputStream</b><code> [get]</code></td></tr> |
| <tr class="separator:aa017053e90477e7b71fbd7d3aef7a9ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">Apache.Qpid.Proton.Client.IStreamDelivery</a></td></tr> |
| <tr class="memitem:abbd1ed30b2cb8d026a22c5f8640b90d2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiver.html">IStreamReceiver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#abbd1ed30b2cb8d026a22c5f8640b90d2">Receiver</a><code> [get]</code></td></tr> |
| <tr class="memdesc:abbd1ed30b2cb8d026a22c5f8640b90d2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent streaming receiver instance where this delivery arrived. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#abbd1ed30b2cb8d026a22c5f8640b90d2">More...</a><br /></td></tr> |
| <tr class="separator:abbd1ed30b2cb8d026a22c5f8640b90d2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3ce8cd6ae387870e26c5cdf353ac5b6 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#af3ce8cd6ae387870e26c5cdf353ac5b6">MessageFormat</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af3ce8cd6ae387870e26c5cdf353ac5b6 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#af3ce8cd6ae387870e26c5cdf353ac5b6">More...</a><br /></td></tr> |
| <tr class="separator:af3ce8cd6ae387870e26c5cdf353ac5b6 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71298633544902344067e360c0e4eb48 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a71298633544902344067e360c0e4eb48">Annotations</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a71298633544902344067e360c0e4eb48 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a71298633544902344067e360c0e4eb48">More...</a><br /></td></tr> |
| <tr class="separator:a71298633544902344067e360c0e4eb48 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0d37b6bc9e2bbfdc3f9de7d72ba1f08 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#ae0d37b6bc9e2bbfdc3f9de7d72ba1f08">RawInputStream</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae0d37b6bc9e2bbfdc3f9de7d72ba1f08 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#ae0d37b6bc9e2bbfdc3f9de7d72ba1f08">More...</a><br /></td></tr> |
| <tr class="separator:ae0d37b6bc9e2bbfdc3f9de7d72ba1f08 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92dabadce0e5445661d9ab9b13cf7049 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a92dabadce0e5445661d9ab9b13cf7049">Settled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a92dabadce0e5445661d9ab9b13cf7049 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a92dabadce0e5445661d9ab9b13cf7049">More...</a><br /></td></tr> |
| <tr class="separator:a92dabadce0e5445661d9ab9b13cf7049 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3cfd1d03811c4fcebee48a92e3eacadc inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a3cfd1d03811c4fcebee48a92e3eacadc">State</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3cfd1d03811c4fcebee48a92e3eacadc inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a3cfd1d03811c4fcebee48a92e3eacadc">More...</a><br /></td></tr> |
| <tr class="separator:a3cfd1d03811c4fcebee48a92e3eacadc inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a85ddf8b6020b809d8602dbbdfe7d500b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a85ddf8b6020b809d8602dbbdfe7d500b">RemoteSettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a85ddf8b6020b809d8602dbbdfe7d500b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a85ddf8b6020b809d8602dbbdfe7d500b">More...</a><br /></td></tr> |
| <tr class="separator:a85ddf8b6020b809d8602dbbdfe7d500b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afad13b6386659d2deabd22aa5214cc87 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#afad13b6386659d2deabd22aa5214cc87">RemoteState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afad13b6386659d2deabd22aa5214cc87 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#afad13b6386659d2deabd22aa5214cc87">More...</a><br /></td></tr> |
| <tr class="separator:afad13b6386659d2deabd22aa5214cc87 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81f25b6ff124480ea761f3ed76cd75e9 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a81f25b6ff124480ea761f3ed76cd75e9">Aborted</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a81f25b6ff124480ea761f3ed76cd75e9 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the remote has aborted this incoming streaming delivery and no more bytes are available for read from the remote. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a81f25b6ff124480ea761f3ed76cd75e9">More...</a><br /></td></tr> |
| <tr class="separator:a81f25b6ff124480ea761f3ed76cd75e9 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b0fd959208e6a51103af3c9873b2b7c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><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_1IStreamDelivery.html#a5b0fd959208e6a51103af3c9873b2b7c">Completed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5b0fd959208e6a51103af3c9873b2b7c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the remote has completed the send of all portions of the streaming delivery payload and there are no more incoming bytes expected or allowed for this delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a5b0fd959208e6a51103af3c9873b2b7c">More...</a><br /></td></tr> |
| <tr class="separator:a5b0fd959208e6a51103af3c9873b2b7c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The stream delivery type manages the underlying state of an incoming streaming message delivery and provides the stream type used to read and block for reads when not all requested message data has arrived. The delivery will also manage settlement of a streaming delivery and apply receiver configuration rules like auto settlement to the delivery as incoming portions of the message arrive. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2443b2d086003373de9c2a0e145312dd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2443b2d086003373de9c2a0e145312dd">◆ </a></span>Accept()</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_1IStreamDelivery.html">IStreamDelivery</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.Accept </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a450fbf6b6e7ec36da9df7a8dc711c94e">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a816f777393ee4c846c405baab9febebd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a816f777393ee4c846c405baab9febebd">◆ </a></span>AcceptAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a>> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.AcceptAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#ae3fad5ebf7cb8d6f92fa600f55631732">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad364b2fb21e0a42a85a4d2d397a4fc26"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad364b2fb21e0a42a85a4d2d397a4fc26">◆ </a></span>Disposition()</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_1IStreamDelivery.html">IStreamDelivery</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a966021332a7b5e3b4be731e4b25a5598">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aaaffcbe046418dcdcc35351cd8698cf9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaaffcbe046418dcdcc35351cd8698cf9">◆ </a></span>DispositionAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a>> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a700939ca2b7a76c3f3f0c9e6fb852e82">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a1ff5d41191bb68ec51d7ffdb84114643"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1ff5d41191bb68ec51d7ffdb84114643">◆ </a></span>Message()</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_1IStreamReceiverMessage.html">IStreamReceiverMessage</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.Message </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a stream receiver message type that will perform a decode of message payload as portions of the streamed message arrive. The message API is inherently a blocking API as the decoder will need to wait in some cases to decode a full section the incoming message when it is requested. </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a2b1b9ebe0d394abae10fac89f2aac5a6">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9ff2c30ca49ae6bf74f1615bd6f7ad7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ff2c30ca49ae6bf74f1615bd6f7ad7b">◆ </a></span>Modified()</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_1IStreamDelivery.html">IStreamDelivery</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a3b36f94a66143edec8e7012445aa5d9f">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a72474444174596cf470f5be90fcf9b05"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a72474444174596cf470f5be90fcf9b05">◆ </a></span>ModifiedAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a>> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#aa2581b65a365b0ba8a04fccf4ae8290f">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0a747d83557ed3896cb3d515de09b813"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0a747d83557ed3896cb3d515de09b813">◆ </a></span>Reject()</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_1IStreamDelivery.html">IStreamDelivery</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a8885f490e27e9563b873e7e522617139">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa6e81a41fe04f5f18e63e54db687f33d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6e81a41fe04f5f18e63e54db687f33d">◆ </a></span>RejectAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a>> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#ae602c83d130c1e369d9bdba5e9076610">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9c57dd2ef6a151b60eafbb241d1fb450"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9c57dd2ef6a151b60eafbb241d1fb450">◆ </a></span>Release()</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_1IStreamDelivery.html">IStreamDelivery</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.Release </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a879b3c1cb872056407bd74b1013d5dae">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa66476ce93e39df064c770d9a075254e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa66476ce93e39df064c770d9a075254e">◆ </a></span>ReleaseAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a>> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.ReleaseAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a4c10579d1724434befb2776c9e471106">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a006c1e16b1d986488e1aefcd1b7e5cdb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a006c1e16b1d986488e1aefcd1b7e5cdb">◆ </a></span>Settle()</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_1IStreamDelivery.html">IStreamDelivery</a> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.Settle </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#a8d05e2a785f287766c9868f3b1dd81ba">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a96abbf5bee4264136bc0e51d5a4dc0da"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96abbf5bee4264136bc0e51d5a4dc0da">◆ </a></span>SettleAsync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Task<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a>> Apache.Qpid.Proton.Client.Implementation.ClientStreamDelivery.SettleAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#af65a8a1819a8c2b7c7a1481fa454f269">Apache.Qpid.Proton.Client.IStreamDelivery</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Implementation/ClientStreamDelivery.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> |
