| <!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.IReceiver 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_1IReceiver.html">IReceiver</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_1IReceiver-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.IReceiver Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A single AMQP receiver instance. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.IReceiver:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.png" usemap="#Apache.Qpid.Proton.Client.IReceiver_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.IReceiver_map" name="Apache.Qpid.Proton.Client.IReceiver_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html" alt="Apache.Qpid.Proton.Client.ILink< IReceiver >" shape="rect" coords="0,56,337,80"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html" title="Client receiver implementation which provides a wrapper around the proton receiver link and processes..." alt="Apache.Qpid.Proton.Client.Implementation.ClientReceiver" shape="rect" coords="0,168,337,192"/> |
| </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:a965da284bdb4def86451b896e8ca58e9"><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_1IReceiver.html#a965da284bdb4def86451b896e8ca58e9">AddCredit</a> (uint credit)</td></tr> |
| <tr class="memdesc:a965da284bdb4def86451b896e8ca58e9"><td class="mdescLeft"> </td><td class="mdescRight">Adds credit to the Receiver link for use when there receiver has not been configured with with a credit window. When credit window is configured credit replenishment is automatic and calling this method will result in an exception indicating that the operation is invalid. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#a965da284bdb4def86451b896e8ca58e9">More...</a><br /></td></tr> |
| <tr class="separator:a965da284bdb4def86451b896e8ca58e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6edce24222af437c08270ef9bcc09a5"><td class="memItemLeft" align="right" valign="top">Task< <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_1IReceiver.html#aa6edce24222af437c08270ef9bcc09a5">AddCreditAsync</a> (uint credit)</td></tr> |
| <tr class="memdesc:aa6edce24222af437c08270ef9bcc09a5"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously Adds credit to the Receiver link for use when there receiver has not been configured with with a credit window. When credit window is configured credit replenishment is automatic and calling this method will result in an exception indicating that the operation is invalid. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#aa6edce24222af437c08270ef9bcc09a5">More...</a><br /></td></tr> |
| <tr class="separator:aa6edce24222af437c08270ef9bcc09a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63215ee7a017f6871d483c68b31c8567"><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_1IReceiver.html#a63215ee7a017f6871d483c68b31c8567">Receive</a> ()</td></tr> |
| <tr class="memdesc:a63215ee7a017f6871d483c68b31c8567"><td class="mdescLeft"> </td><td class="mdescRight">Blocking receive method that waits forever for the remote to provide a delivery for consumption. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#a63215ee7a017f6871d483c68b31c8567">More...</a><br /></td></tr> |
| <tr class="separator:a63215ee7a017f6871d483c68b31c8567"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d7996145520ea9c47953199b1550e8a"><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_1IReceiver.html#a6d7996145520ea9c47953199b1550e8a">Receive</a> (TimeSpan timeout)</td></tr> |
| <tr class="memdesc:a6d7996145520ea9c47953199b1550e8a"><td class="mdescLeft"> </td><td class="mdescRight">Blocking receive method that waits for the specified time period for the remote to provide a delivery for consumption before returning null if none was received. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#a6d7996145520ea9c47953199b1550e8a">More...</a><br /></td></tr> |
| <tr class="separator:a6d7996145520ea9c47953199b1550e8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a744c014c34315bcd333cce1ae61e863c"><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_1IReceiver.html#a744c014c34315bcd333cce1ae61e863c">TryReceive</a> ()</td></tr> |
| <tr class="memdesc:a744c014c34315bcd333cce1ae61e863c"><td class="mdescLeft"> </td><td class="mdescRight">A mostly Non-blocking receive method that either returns a delivery if one is immediately available or returns null if none is currently at hand. It is possible that this method will block for short time intervals while acquiring and releasing internal locks. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#a744c014c34315bcd333cce1ae61e863c">More...</a><br /></td></tr> |
| <tr class="separator:a744c014c34315bcd333cce1ae61e863c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adb1d0a14e0954bfa21de6535c9f01f57"><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_1IReceiver.html#adb1d0a14e0954bfa21de6535c9f01f57">ReceiveAsync</a> ()</td></tr> |
| <tr class="memdesc:adb1d0a14e0954bfa21de6535c9f01f57"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous receive method that waits forever for the remote to provide a delivery for consumption and when a delivery is available the returned Task will be completed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#adb1d0a14e0954bfa21de6535c9f01f57">More...</a><br /></td></tr> |
| <tr class="separator:adb1d0a14e0954bfa21de6535c9f01f57"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a786410323d2d2a4d66738d5e1489f6bd"><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_1IReceiver.html#a786410323d2d2a4d66738d5e1489f6bd">ReceiveAsync</a> (TimeSpan timeout)</td></tr> |
| <tr class="memdesc:a786410323d2d2a4d66738d5e1489f6bd"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous receive method that returns a Task that will be completed after the specified time period if the remote to provides a delivery for consumption before completing with null if none was received. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#a786410323d2d2a4d66738d5e1489f6bd">More...</a><br /></td></tr> |
| <tr class="separator:a786410323d2d2a4d66738d5e1489f6bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f3565cebe3f1fbfaf539e1d0e86f2cd"><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_1IReceiver.html#a3f3565cebe3f1fbfaf539e1d0e86f2cd">TryReceiveAsync</a> ()</td></tr> |
| <tr class="memdesc:a3f3565cebe3f1fbfaf539e1d0e86f2cd"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous receive method that returns a Task which will be completed either with a currently available delivery or with null to indicate there are no queued deliveries. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#a3f3565cebe3f1fbfaf539e1d0e86f2cd">More...</a><br /></td></tr> |
| <tr class="separator:a3f3565cebe3f1fbfaf539e1d0e86f2cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5f2688a0b37850020150ccbbc4b196c"><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_1IReceiver.html#ad5f2688a0b37850020150ccbbc4b196c">Drain</a> ()</td></tr> |
| <tr class="memdesc:ad5f2688a0b37850020150ccbbc4b196c"><td class="mdescLeft"> </td><td class="mdescRight">Requests the remote to drain previously granted credit for this receiver link. The remote will either send all available deliveries up to the currently granted link credit or will report it has none to send an link credit will be set to zero. This method will block until the remote answers the drain request or the configured drain timeout expires. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#ad5f2688a0b37850020150ccbbc4b196c">More...</a><br /></td></tr> |
| <tr class="separator:ad5f2688a0b37850020150ccbbc4b196c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac351fe0ca65d03582f4c823b2462d851"><td class="memItemLeft" align="right" valign="top">Task< <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_1IReceiver.html#ac351fe0ca65d03582f4c823b2462d851">DrainAsync</a> ()</td></tr> |
| <tr class="memdesc:ac351fe0ca65d03582f4c823b2462d851"><td class="mdescLeft"> </td><td class="mdescRight">Requests the remote to drain previously granted credit for this receiver link. The remote will either send all available deliveries up to the currently granted link credit or will report it has none to send an link credit will be set to zero. The caller can wait on the returned task which will be signalled either after the remote reports drained or once the configured drain timeout is reached. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#ac351fe0ca65d03582f4c823b2462d851">More...</a><br /></td></tr> |
| <tr class="separator:ac351fe0ca65d03582f4c823b2462d851"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html">Apache.Qpid.Proton.Client.ILink< IReceiver ></a></td></tr> |
| <tr class="memitem:a228d7c08a2e78d41ebc8742f57281417 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a228d7c08a2e78d41ebc8742f57281417">Close</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr> |
| <tr class="memdesc:a228d7c08a2e78d41ebc8742f57281417 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Initiates a close of the link and awaits a response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the link resources. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a228d7c08a2e78d41ebc8742f57281417">More...</a><br /></td></tr> |
| <tr class="separator:a228d7c08a2e78d41ebc8742f57281417 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4caa12237d5e8fc736bc1ba0c541f47f inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a4caa12237d5e8fc736bc1ba0c541f47f">Detach</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr> |
| <tr class="memdesc:a4caa12237d5e8fc736bc1ba0c541f47f inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Initiates a detach of the link and awaits a response from the remote that indicates completion of the detach operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the link resources. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a4caa12237d5e8fc736bc1ba0c541f47f">More...</a><br /></td></tr> |
| <tr class="separator:a4caa12237d5e8fc736bc1ba0c541f47f inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a513455e79843acd6dc01952853a2a1eb inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">Task< Role > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a513455e79843acd6dc01952853a2a1eb">CloseAsync</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr> |
| <tr class="memdesc:a513455e79843acd6dc01952853a2a1eb inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Initiates a close of the link and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the sender will be cleaned up and the Task signalled indicating completion. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a513455e79843acd6dc01952853a2a1eb">More...</a><br /></td></tr> |
| <tr class="separator:a513455e79843acd6dc01952853a2a1eb inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aad772a1fb032480d67568d171f3c6ab8 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">Task< Role > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#aad772a1fb032480d67568d171f3c6ab8">DetachAsync</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr> |
| <tr class="memdesc:aad772a1fb032480d67568d171f3c6ab8 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Initiates a detach of the link and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the detach operation. If the response from the remote exceeds the configure close timeout the sender will be cleaned up and the Task signalled indicating completion. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#aad772a1fb032480d67568d171f3c6ab8">More...</a><br /></td></tr> |
| <tr class="separator:aad772a1fb032480d67568d171f3c6ab8 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><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:ab10ec2e9cfbf7ddd9995d60552b33636"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#ab10ec2e9cfbf7ddd9995d60552b33636">QueuedDeliveries</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab10ec2e9cfbf7ddd9995d60552b33636"><td class="mdescLeft"> </td><td class="mdescRight">A count of the currently queued deliveries which can be read immediately without blocking a call to receive. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#ab10ec2e9cfbf7ddd9995d60552b33636">More...</a><br /></td></tr> |
| <tr class="separator:ab10ec2e9cfbf7ddd9995d60552b33636"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html">Apache.Qpid.Proton.Client.ILink< IReceiver ></a></td></tr> |
| <tr class="memitem:a1d69faec32b3de693e22e6279ba158ac inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IClient.html">IClient</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a1d69faec32b3de693e22e6279ba158ac">Client</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1d69faec32b3de693e22e6279ba158ac inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent client instance that hosts this link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a1d69faec32b3de693e22e6279ba158ac">More...</a><br /></td></tr> |
| <tr class="separator:a1d69faec32b3de693e22e6279ba158ac inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb317c6a972e1ba829e993ad700132ce inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IConnection.html">IConnection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#acb317c6a972e1ba829e993ad700132ce">Connection</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acb317c6a972e1ba829e993ad700132ce inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent connection instance that hosts this link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#acb317c6a972e1ba829e993ad700132ce">More...</a><br /></td></tr> |
| <tr class="separator:acb317c6a972e1ba829e993ad700132ce inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a627cdff32fb7042573e3c810919f3e14 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISession.html">ISession</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a627cdff32fb7042573e3c810919f3e14">Session</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a627cdff32fb7042573e3c810919f3e14 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent session instance that created this link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a627cdff32fb7042573e3c810919f3e14">More...</a><br /></td></tr> |
| <tr class="separator:a627cdff32fb7042573e3c810919f3e14 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2006624670b65d75c368ea4c6701355d inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a2006624670b65d75c368ea4c6701355d">Address</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2006624670b65d75c368ea4c6701355d inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the address that the link instance will send message objects to. The value returned from this method is controlled by the configuration that was used to create the link. </p><ul> |
| <li> |
| If the link is configured as an anonymous link then this method returns null. </li> |
| <li> |
| If the link was created with the dynamic link methods then the method will return the dynamically created address once the remote has attached its end of the link link. Due to the need to await the remote peer to populate the dynamic address this method will block until the open of the link link has completed. </li> |
| <li> |
| If neither of the above is true then the address returned is the address passed to the original address value passed to one of the open link methods. </li> |
| </ul> |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a2006624670b65d75c368ea4c6701355d">More...</a><br /></td></tr> |
| <tr class="separator:a2006624670b65d75c368ea4c6701355d inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9f1623883c42f02a1bb990fd91cdfff8 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISource.html">ISource</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a9f1623883c42f02a1bb990fd91cdfff8">Source</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9f1623883c42f02a1bb990fd91cdfff8 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns an immutable view of the remote Source object assigned to this link link. If the attach has not completed yet this method will block to await the attach response which carries the remote source. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a9f1623883c42f02a1bb990fd91cdfff8">More...</a><br /></td></tr> |
| <tr class="separator:a9f1623883c42f02a1bb990fd91cdfff8 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a697531042f2cafdbde67990c3a1d08f5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITarget.html">ITarget</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a697531042f2cafdbde67990c3a1d08f5">Target</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a697531042f2cafdbde67990c3a1d08f5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns an immutable view of the remote Target object assigned to this link link. If the attach has not completed yet this method will block to await the attach response which carries the remote target. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a697531042f2cafdbde67990c3a1d08f5">More...</a><br /></td></tr> |
| <tr class="separator:a697531042f2cafdbde67990c3a1d08f5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a333a8e9f74d1630eff1ed374aabe0b88 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><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_1ILink.html#a333a8e9f74d1630eff1ed374aabe0b88">Properties</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a333a8e9f74d1630eff1ed374aabe0b88 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the properties that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote properties. If the remote provides no properties this method will return null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a333a8e9f74d1630eff1ed374aabe0b88">More...</a><br /></td></tr> |
| <tr class="separator:a333a8e9f74d1630eff1ed374aabe0b88 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95fdfaad4b7b09dd8226d5adeac91271 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">IReadOnlyCollection< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a95fdfaad4b7b09dd8226d5adeac91271">OfferedCapabilities</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a95fdfaad4b7b09dd8226d5adeac91271 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the offered capabilities that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote offered capabilities. If the remote provides no offered capabilities this method will return null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a95fdfaad4b7b09dd8226d5adeac91271">More...</a><br /></td></tr> |
| <tr class="separator:a95fdfaad4b7b09dd8226d5adeac91271 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab953057eb2f7491aae452abac4168dbf inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">IReadOnlyCollection< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#ab953057eb2f7491aae452abac4168dbf">DesiredCapabilities</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab953057eb2f7491aae452abac4168dbf inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns the desired capabilities that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote desired capabilities. If the remote provides no desired capabilities this method will return null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#ab953057eb2f7491aae452abac4168dbf">More...</a><br /></td></tr> |
| <tr class="separator:ab953057eb2f7491aae452abac4168dbf inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a967c89aa8ef28800557af66c1b993d7c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="memItemLeft" align="right" valign="top">Task< Role > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a967c89aa8ef28800557af66c1b993d7c">OpenTask</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a967c89aa8ef28800557af66c1b993d7c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">When a link is created and returned to the client application it may not be remotely opened yet and if the client needs to wait for completion of the open before proceeding the open task can be fetched and waited upon. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#a967c89aa8ef28800557af66c1b993d7c">More...</a><br /></td></tr> |
| <tr class="separator:a967c89aa8ef28800557af66c1b993d7c inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink"><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 receiver instance. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a965da284bdb4def86451b896e8ca58e9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a965da284bdb4def86451b896e8ca58e9">◆ </a></span>AddCredit()</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_1IReceiver.html">IReceiver</a> Apache.Qpid.Proton.Client.IReceiver.AddCredit </td> |
| <td>(</td> |
| <td class="paramtype">uint </td> |
| <td class="paramname"><em>credit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds credit to the Receiver link for use when there receiver has not been configured with with a credit window. When credit window is configured credit replenishment is automatic and calling this method will result in an exception indicating that the operation is invalid. </p> |
| <p>If the Receiver is draining and this method is called an exception will be thrown to indicate that credit cannot be replenished until the remote has drained the existing link credit.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">credit</td><td>The amount of new credit to add to the existing credit if any</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This receiver instance.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa6edce24222af437c08270ef9bcc09a5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6edce24222af437c08270ef9bcc09a5">◆ </a></span>AddCreditAsync()</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_1IReceiver.html">IReceiver</a>> Apache.Qpid.Proton.Client.IReceiver.AddCreditAsync </td> |
| <td>(</td> |
| <td class="paramtype">uint </td> |
| <td class="paramname"><em>credit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Asynchronously Adds credit to the Receiver link for use when there receiver has not been configured with with a credit window. When credit window is configured credit replenishment is automatic and calling this method will result in an exception indicating that the operation is invalid. </p> |
| <p>If the Receiver is draining and this method is called an exception will be thrown to indicate that credit cannot be replenished until the remote has drained the existing link credit.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">credit</td><td>The amount of new credit to add to the existing credit if any</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This receiver instance.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad5f2688a0b37850020150ccbbc4b196c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad5f2688a0b37850020150ccbbc4b196c">◆ </a></span>Drain()</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_1IReceiver.html">IReceiver</a> Apache.Qpid.Proton.Client.IReceiver.Drain </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Requests the remote to drain previously granted credit for this receiver link. The remote will either send all available deliveries up to the currently granted link credit or will report it has none to send an link credit will be set to zero. This method will block until the remote answers the drain request or the configured drain timeout expires. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This receiver instance once the remote reports drain completed</dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac351fe0ca65d03582f4c823b2462d851"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac351fe0ca65d03582f4c823b2462d851">◆ </a></span>DrainAsync()</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_1IReceiver.html">IReceiver</a>> Apache.Qpid.Proton.Client.IReceiver.DrainAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Requests the remote to drain previously granted credit for this receiver link. The remote will either send all available deliveries up to the currently granted link credit or will report it has none to send an link credit will be set to zero. The caller can wait on the returned task which will be signalled either after the remote reports drained or once the configured drain timeout is reached. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that will be completed when the remote reports drained.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a63215ee7a017f6871d483c68b31c8567"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a63215ee7a017f6871d483c68b31c8567">◆ </a></span>Receive() <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_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IReceiver.Receive </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Blocking receive method that waits forever for the remote to provide a delivery for consumption. </p> |
| <p>Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The next available delivery</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html#a992de99a143960adc187f25ecd0643e3">Apache.Qpid.Proton.Client.Implementation.ClientReceiver</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6d7996145520ea9c47953199b1550e8a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6d7996145520ea9c47953199b1550e8a">◆ </a></span>Receive() <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_1IDelivery.html">IDelivery</a> Apache.Qpid.Proton.Client.IReceiver.Receive </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>Blocking receive method that waits for the specified time period for the remote to provide a delivery for consumption before returning null if none was received. </p> |
| <p>Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The next available delivery or null if the time span elapses</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html#a55789b99206998e4b8b58bf350260774">Apache.Qpid.Proton.Client.Implementation.ClientReceiver</a>.</p> |
| |
| </div> |
| </div> |
| <a id="adb1d0a14e0954bfa21de6535c9f01f57"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adb1d0a14e0954bfa21de6535c9f01f57">◆ </a></span>ReceiveAsync() <span class="overload">[1/2]</span></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.IReceiver.ReceiveAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Asynchronous receive method that waits forever for the remote to provide a delivery for consumption and when a delivery is available the returned Task will be completed. </p> |
| <p>Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The next available delivery</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html#af65ffecc27169d11f94c5db6b87cb8b4">Apache.Qpid.Proton.Client.Implementation.ClientReceiver</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a786410323d2d2a4d66738d5e1489f6bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a786410323d2d2a4d66738d5e1489f6bd">◆ </a></span>ReceiveAsync() <span class="overload">[2/2]</span></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.IReceiver.ReceiveAsync </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>Asynchronous receive method that returns a Task that will be completed after the specified time period if the remote to provides a delivery for consumption before completing with null if none was received. </p> |
| <p>Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The next available delivery or null if the time span elapses</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html#a20eba20bf3e8d4438567c2524d7d9a53">Apache.Qpid.Proton.Client.Implementation.ClientReceiver</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a744c014c34315bcd333cce1ae61e863c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a744c014c34315bcd333cce1ae61e863c">◆ </a></span>TryReceive()</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.IReceiver.TryReceive </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A mostly Non-blocking receive method that either returns a delivery if one is immediately available or returns null if none is currently at hand. It is possible that this method will block for short time intervals while acquiring and releasing internal locks. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A delivery if one is immediately available or null if not</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html#a5bcb4bdd72e1e5fe6f2d95af5066839c">Apache.Qpid.Proton.Client.Implementation.ClientReceiver</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a3f3565cebe3f1fbfaf539e1d0e86f2cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f3565cebe3f1fbfaf539e1d0e86f2cd">◆ </a></span>TryReceiveAsync()</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.IReceiver.TryReceiveAsync </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Asynchronous receive method that returns a Task which will be completed either with a currently available delivery or with null to indicate there are no queued deliveries. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A Task that completes with a delivery if one is immediately available or null if not</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientReceiver.html#a0eda2a8ede4dc4cfc26a2407d91a0cc1">Apache.Qpid.Proton.Client.Implementation.ClientReceiver</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ab10ec2e9cfbf7ddd9995d60552b33636"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab10ec2e9cfbf7ddd9995d60552b33636">◆ </a></span>QueuedDeliveries</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.IReceiver.QueuedDeliveries</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>A count of the currently queued deliveries which can be read immediately without blocking a call to receive. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/IReceiver.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> |
