| <!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.ITracker 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_1ITracker.html">ITracker</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_1ITracker-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.ITracker 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_1ITracker.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.ITracker:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.png" usemap="#Apache.Qpid.Proton.Client.ITracker_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.ITracker_map" name="Apache.Qpid.Proton.Client.ITracker_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html" alt="Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker" shape="rect" coords="0,56,363,80"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html" alt="Apache.Qpid.Proton.Client.Implementation.ClientTracker" shape="rect" coords="373,56,736,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:a095ae3156ef94e0952f737ceac3dd973"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a095ae3156ef94e0952f737ceac3dd973">Settle</a> ()</td></tr> |
| <tr class="memdesc:a095ae3156ef94e0952f737ceac3dd973"><td class="mdescLeft"> </td><td class="mdescRight">Settles the sent delivery if not performing auto-settlement on the sender. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a095ae3156ef94e0952f737ceac3dd973">More...</a><br /></td></tr> |
| <tr class="separator:a095ae3156ef94e0952f737ceac3dd973"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aedca1571a541765f6ec41a08c1c3b15e"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#aedca1571a541765f6ec41a08c1c3b15e">SettleAsync</a> ()</td></tr> |
| <tr class="memdesc:aedca1571a541765f6ec41a08c1c3b15e"><td class="mdescLeft"> </td><td class="mdescRight">Settles the sent delivery if not performing auto-settlement on the sender and returns a Task that will be completed once any IO operations required by the settlement have completed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#aedca1571a541765f6ec41a08c1c3b15e">More...</a><br /></td></tr> |
| <tr class="separator:aedca1571a541765f6ec41a08c1c3b15e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5b9818b00822971b86a1bc050cf14fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#ad5b9818b00822971b86a1bc050cf14fd">Disposition</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> state, bool settle)</td></tr> |
| <tr class="memdesc:ad5b9818b00822971b86a1bc050cf14fd"><td class="mdescLeft"> </td><td class="mdescRight">Apply the delivery state and optionally settle the sent delivery with the remote <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#ad5b9818b00822971b86a1bc050cf14fd">More...</a><br /></td></tr> |
| <tr class="separator:ad5b9818b00822971b86a1bc050cf14fd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a32c50f1b3f0510215685532cc6012e69"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a32c50f1b3f0510215685532cc6012e69">DispositionAsync</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a> state, bool settle)</td></tr> |
| <tr class="memdesc:a32c50f1b3f0510215685532cc6012e69"><td class="mdescLeft"> </td><td class="mdescRight">Apply the delivery state and optionally settle the sent delivery with the remote. The method returns a Task that will be completed once any required IO operations in order to apply the disposition have been completed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a32c50f1b3f0510215685532cc6012e69">More...</a><br /></td></tr> |
| <tr class="separator:a32c50f1b3f0510215685532cc6012e69"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9db66f503c69ea29bb130513c3de818d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a9db66f503c69ea29bb130513c3de818d">AwaitSettlement</a> ()</td></tr> |
| <tr class="memdesc:a9db66f503c69ea29bb130513c3de818d"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a9db66f503c69ea29bb130513c3de818d">More...</a><br /></td></tr> |
| <tr class="separator:a9db66f503c69ea29bb130513c3de818d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2e75c601866fe7b93e0061be62811aa8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a2e75c601866fe7b93e0061be62811aa8">AwaitSettlement</a> (TimeSpan timeout)</td></tr> |
| <tr class="memdesc:a2e75c601866fe7b93e0061be62811aa8"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a2e75c601866fe7b93e0061be62811aa8">More...</a><br /></td></tr> |
| <tr class="separator:a2e75c601866fe7b93e0061be62811aa8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa24432b8b9d74558f612696df34d790e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#aa24432b8b9d74558f612696df34d790e">AwaitAccepted</a> ()</td></tr> |
| <tr class="memdesc:aa24432b8b9d74558f612696df34d790e"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#aa24432b8b9d74558f612696df34d790e">More...</a><br /></td></tr> |
| <tr class="separator:aa24432b8b9d74558f612696df34d790e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9af052940c0b5750216ff0d70c32e30e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a9af052940c0b5750216ff0d70c32e30e">AwaitAccepted</a> (TimeSpan timeout)</td></tr> |
| <tr class="memdesc:a9af052940c0b5750216ff0d70c32e30e"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a9af052940c0b5750216ff0d70c32e30e">More...</a><br /></td></tr> |
| <tr class="separator:a9af052940c0b5750216ff0d70c32e30e"><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:a354c9337a1ae9a117ef5944312c82bf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISender.html">ISender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a354c9337a1ae9a117ef5944312c82bf0">Sender</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a354c9337a1ae9a117ef5944312c82bf0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent sender instance that sent the delivery that is now being tacked. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a354c9337a1ae9a117ef5944312c82bf0">More...</a><br /></td></tr> |
| <tr class="separator:a354c9337a1ae9a117ef5944312c82bf0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a91a49d0ed822c9a10b07675eb2fcd4a2"><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_1ITracker.html#a91a49d0ed822c9a10b07675eb2fcd4a2">Settled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a91a49d0ed822c9a10b07675eb2fcd4a2"><td class="mdescLeft"> </td><td class="mdescRight">Indicates if the sent delivery has already been locally settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a91a49d0ed822c9a10b07675eb2fcd4a2">More...</a><br /></td></tr> |
| <tr class="separator:a91a49d0ed822c9a10b07675eb2fcd4a2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5afee3ff0bae0c2bd74146cbb736df1f"><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_1ITracker.html#a5afee3ff0bae0c2bd74146cbb736df1f">State</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5afee3ff0bae0c2bd74146cbb736df1f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the currently applied delivery state for the sent delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a5afee3ff0bae0c2bd74146cbb736df1f">More...</a><br /></td></tr> |
| <tr class="separator:a5afee3ff0bae0c2bd74146cbb736df1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a229cc481167a9491729628c25cf89e83"><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_1ITracker.html#a229cc481167a9491729628c25cf89e83">RemoteSettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a229cc481167a9491729628c25cf89e83"><td class="mdescLeft"> </td><td class="mdescRight">Indicates if the sent delivery has already been remotely settled. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#a229cc481167a9491729628c25cf89e83">More...</a><br /></td></tr> |
| <tr class="separator:a229cc481167a9491729628c25cf89e83"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab9d60651a1e7df07498a9cf4f18fe8d9"><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_1ITracker.html#ab9d60651a1e7df07498a9cf4f18fe8d9">RemoteState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab9d60651a1e7df07498a9cf4f18fe8d9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the currently applied delivery state by the remote for the sent delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#ab9d60651a1e7df07498a9cf4f18fe8d9">More...</a><br /></td></tr> |
| <tr class="separator:ab9d60651a1e7df07498a9cf4f18fe8d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac91723620fff0cf7d0458269a7a653b7"><td class="memItemLeft" align="right" valign="top">Task< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#ac91723620fff0cf7d0458269a7a653b7">SettlementTask</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac91723620fff0cf7d0458269a7a653b7"><td class="mdescLeft"> </td><td class="mdescRight">Gets a task that will be completed once the remote has settled the sent delivery, or will indicate an error if the connection fails before the remote can settle. If the sender sent the tracked delivery settled the task returned will already be completed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#ac91723620fff0cf7d0458269a7a653b7">More...</a><br /></td></tr> |
| <tr class="separator:ac91723620fff0cf7d0458269a7a653b7"><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="aa24432b8b9d74558f612696df34d790e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa24432b8b9d74558f612696df34d790e">◆ </a></span>AwaitAccepted() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> Apache.Qpid.Proton.Client.ITracker.AwaitAccepted </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. </p> |
| <p>If the remote send back a delivery state other than accepted then this method will throw an ClientDeliveryStateException to indicate the expected outcome was not achieved. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#ad00925e30f2b66fbf8001baccc55373b">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#a8162292168dfaeceb8d8ab7967cbdfa3">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9af052940c0b5750216ff0d70c32e30e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9af052940c0b5750216ff0d70c32e30e">◆ </a></span>AwaitAccepted() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> Apache.Qpid.Proton.Client.ITracker.AwaitAccepted </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>timeout</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. </p> |
| <p>If the remote send back a delivery state other than accepted then this method will throw an ClientDeliveryStateException to indicate the expected outcome was not achieved. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeout</td><td>The duration to wait for the remote to accept the delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#a5f83c7ffb9e66c878ab47cddc1af5f04">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#a6cdfe1e6f013f0dbdd9316decff90ae7">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9db66f503c69ea29bb130513c3de818d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9db66f503c69ea29bb130513c3de818d">◆ </a></span>AwaitSettlement() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> Apache.Qpid.Proton.Client.ITracker.AwaitSettlement </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#a2ae9648df60cb17f4a4dc837dc6106c0">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#a752c62f0762537d29dd1de074dc2bf1f">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2e75c601866fe7b93e0061be62811aa8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2e75c601866fe7b93e0061be62811aa8">◆ </a></span>AwaitSettlement() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a> Apache.Qpid.Proton.Client.ITracker.AwaitSettlement </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>timeout</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeout</td><td>The duration to wait for the remote to settle the delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#a60587e6c716f9fc7abb109d2197e6cc6">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#a437e2b320c3396261f08b1ca7eb51e2e">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad5b9818b00822971b86a1bc050cf14fd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad5b9818b00822971b86a1bc050cf14fd">◆ </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_1ITracker.html">ITracker</a> Apache.Qpid.Proton.Client.ITracker.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>settle</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Apply the delivery state and optionally settle the sent delivery with the remote </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">state</td><td>The delivery state to apply to the sent delivery</td></tr> |
| <tr><td class="paramname">settle</td><td>Optionally settle the delivery that was sent</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#af4445164318d72984fad0fea6b23b5cd">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#a7772aaf551d21e5776ff43323d1246af">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a32c50f1b3f0510215685532cc6012e69"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a32c50f1b3f0510215685532cc6012e69">◆ </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_1ITracker.html">ITracker</a>> Apache.Qpid.Proton.Client.ITracker.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>settle</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Apply the delivery state and optionally settle the sent delivery with the remote. The method returns a Task that will be completed once any required IO operations in order to apply the disposition have been completed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">state</td><td>The delivery state to apply to the sent delivery</td></tr> |
| <tr><td class="paramname">settle</td><td>Optionally settle the delivery that was sent</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#af30caada505bc200be79e34affd10b12">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#aeae68f9d1c58c202557335ccd40d3e56">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a095ae3156ef94e0952f737ceac3dd973"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a095ae3156ef94e0952f737ceac3dd973">◆ </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_1ITracker.html">ITracker</a> Apache.Qpid.Proton.Client.ITracker.Settle </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Settles the sent delivery if not performing auto-settlement on the sender. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#ac21b05bc0d02bb539ab4f98302bb9a17">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#aef7af53b0231523430e210ec6ed55dd3">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aedca1571a541765f6ec41a08c1c3b15e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aedca1571a541765f6ec41a08c1c3b15e">◆ </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_1ITracker.html">ITracker</a>> Apache.Qpid.Proton.Client.ITracker.SettleAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Settles the sent delivery if not performing auto-settlement on the sender and returns a Task that will be completed once any IO operations required by the settlement have completed. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This tracker instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientTracker.html#a0748bbf4998658c2cdd58628430bc998">Apache.Qpid.Proton.Client.Implementation.ClientTracker</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientNoOpTracker.html#a4ff5fe438fbce165253af1030c0d1b12">Apache.Qpid.Proton.Client.Implementation.ClientNoOpTracker</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a229cc481167a9491729628c25cf89e83"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a229cc481167a9491729628c25cf89e83">◆ </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.ITracker.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>Indicates if the sent delivery has already been remotely settled. </p> |
| |
| </div> |
| </div> |
| <a id="ab9d60651a1e7df07498a9cf4f18fe8d9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab9d60651a1e7df07498a9cf4f18fe8d9">◆ </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.ITracker.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>Retrieve the currently applied delivery state by the remote for the sent delivery. </p> |
| |
| </div> |
| </div> |
| <a id="a354c9337a1ae9a117ef5944312c82bf0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a354c9337a1ae9a117ef5944312c82bf0">◆ </a></span>Sender</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_1ISender.html">ISender</a> Apache.Qpid.Proton.Client.ITracker.Sender</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 sender instance that sent the delivery that is now being tacked. </p> |
| |
| </div> |
| </div> |
| <a id="a91a49d0ed822c9a10b07675eb2fcd4a2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a91a49d0ed822c9a10b07675eb2fcd4a2">◆ </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.ITracker.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>Indicates if the sent delivery has already been locally settled. </p> |
| |
| </div> |
| </div> |
| <a id="ac91723620fff0cf7d0458269a7a653b7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac91723620fff0cf7d0458269a7a653b7">◆ </a></span>SettlementTask</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_1ITracker.html">ITracker</a>> Apache.Qpid.Proton.Client.ITracker.SettlementTask</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>Gets a task that will be completed once the remote has settled the sent delivery, or will indicate an error if the connection fails before the remote can settle. If the sender sent the tracked delivery settled the task returned will already be completed. </p> |
| |
| </div> |
| </div> |
| <a id="a5afee3ff0bae0c2bd74146cbb736df1f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5afee3ff0bae0c2bd74146cbb736df1f">◆ </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.ITracker.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>Retrieve the currently applied delivery state for the sent delivery. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/ITracker.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> |
