| <!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.Utilities.IDeliveryQueue< T > Interface Template 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_1Utilities.html">Utilities</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">IDeliveryQueue</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_1Utilities_1_1IDeliveryQueue-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T > Interface Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A generic delivery queue used to hold messages or other delivery objects that need to be consumed in order and also provides put-back options for redelivery scenarios. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.png" usemap="#Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue_3C_20T_20_3E_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue_3C_20T_20_3E_map" name="Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue_3C_20T_20_3E_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html" title="Simple first in / first out delivery queue with no reordering for priority or other criteria." alt="Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T >" shape="rect" coords="0,56,350,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:a72fe10bf87e0bb0e610ea609a109b531"><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_1Utilities_1_1IDeliveryQueue.html#a72fe10bf87e0bb0e610ea609a109b531">Enqueue</a> (T delivery)</td></tr> |
| <tr class="memdesc:a72fe10bf87e0bb0e610ea609a109b531"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given delivery to the end of the delivery queue. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a72fe10bf87e0bb0e610ea609a109b531">More...</a><br /></td></tr> |
| <tr class="separator:a72fe10bf87e0bb0e610ea609a109b531"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9a9b9e8ac6f09a76ff3ebf3b60474173"><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_1Utilities_1_1IDeliveryQueue.html#a9a9b9e8ac6f09a76ff3ebf3b60474173">EnqueueFront</a> (T delivery)</td></tr> |
| <tr class="memdesc:a9a9b9e8ac6f09a76ff3ebf3b60474173"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given delivery to the front of the delivery queue. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a9a9b9e8ac6f09a76ff3ebf3b60474173">More...</a><br /></td></tr> |
| <tr class="separator:a9a9b9e8ac6f09a76ff3ebf3b60474173"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2f2c7f62baa4e0cd250e1ce1cfada763"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a2f2c7f62baa4e0cd250e1ce1cfada763">Dequeue</a> (TimeSpan timeout)</td></tr> |
| <tr class="memdesc:a2f2c7f62baa4e0cd250e1ce1cfada763"><td class="mdescLeft"> </td><td class="mdescRight">Used to get the next available Delivery. The amount of time this method blocks is based on the timeout value that is supplied to it. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a2f2c7f62baa4e0cd250e1ce1cfada763">More...</a><br /></td></tr> |
| <tr class="separator:a2f2c7f62baa4e0cd250e1ce1cfada763"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab40d4dd2ec183b88d7b5070472b89199"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#ab40d4dd2ec183b88d7b5070472b89199">DequeueNoWait</a> ()</td></tr> |
| <tr class="memdesc:ab40d4dd2ec183b88d7b5070472b89199"><td class="mdescLeft"> </td><td class="mdescRight">Dequeue and return the next available delivery if one is available without the need to block, otherwise returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#ab40d4dd2ec183b88d7b5070472b89199">More...</a><br /></td></tr> |
| <tr class="separator:ab40d4dd2ec183b88d7b5070472b89199"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0ba671b9e2fd1b24b904fa0893f5b3ec"><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_1Utilities_1_1IDeliveryQueue.html#a0ba671b9e2fd1b24b904fa0893f5b3ec">Start</a> ()</td></tr> |
| <tr class="memdesc:a0ba671b9e2fd1b24b904fa0893f5b3ec"><td class="mdescLeft"> </td><td class="mdescRight">Starts the Queue and makes it available for dequeue operations, a non-started queue will always return null for any dequeue operations but will accept new queued deliveries for later dequeue when started. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a0ba671b9e2fd1b24b904fa0893f5b3ec">More...</a><br /></td></tr> |
| <tr class="separator:a0ba671b9e2fd1b24b904fa0893f5b3ec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa95cdedc73312f1b6f3bd222e4971845"><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_1Utilities_1_1IDeliveryQueue.html#aa95cdedc73312f1b6f3bd222e4971845">Stop</a> ()</td></tr> |
| <tr class="memdesc:aa95cdedc73312f1b6f3bd222e4971845"><td class="mdescLeft"> </td><td class="mdescRight">Stops the delivery Queue which wakes any current waiters and prevents any future calls to dequeue a delivery from blocking. New incoming deliveries can still be queued in this state. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#aa95cdedc73312f1b6f3bd222e4971845">More...</a><br /></td></tr> |
| <tr class="separator:aa95cdedc73312f1b6f3bd222e4971845"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36c7cae7edd551834ee2f3bc58b40064"><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_1Utilities_1_1IDeliveryQueue.html#a36c7cae7edd551834ee2f3bc58b40064">Close</a> ()</td></tr> |
| <tr class="memdesc:a36c7cae7edd551834ee2f3bc58b40064"><td class="mdescLeft"> </td><td class="mdescRight">Close the delivery Queue and purge any current deliveries and wakes all waiters currently blocked on a dequeue call. Once closed a delivery queue cannot be started again and no new deliveries can be queued. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a36c7cae7edd551834ee2f3bc58b40064">More...</a><br /></td></tr> |
| <tr class="separator:a36c7cae7edd551834ee2f3bc58b40064"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af7afec02d7593c5b787f9b219843a8b2"><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_1Utilities_1_1IDeliveryQueue.html#af7afec02d7593c5b787f9b219843a8b2">Clear</a> ()</td></tr> |
| <tr class="memdesc:af7afec02d7593c5b787f9b219843a8b2"><td class="mdescLeft"> </td><td class="mdescRight">Purge all currently queued deliveries from this delivery queue. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#af7afec02d7593c5b787f9b219843a8b2">More...</a><br /></td></tr> |
| <tr class="separator:af7afec02d7593c5b787f9b219843a8b2"><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:a319b3d3ea064990912142bfec114e48f"><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_1Utilities_1_1IDeliveryQueue.html#a319b3d3ea064990912142bfec114e48f">Count</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a319b3d3ea064990912142bfec114e48f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of queued deliveries current held in this delivery queue. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a319b3d3ea064990912142bfec114e48f">More...</a><br /></td></tr> |
| <tr class="separator:a319b3d3ea064990912142bfec114e48f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61d8dcdc363718cb686a9a10a1d6020a"><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_1Utilities_1_1IDeliveryQueue.html#a61d8dcdc363718cb686a9a10a1d6020a">IsEmpty</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a61d8dcdc363718cb686a9a10a1d6020a"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the delivery queue is currently empty or not. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a61d8dcdc363718cb686a9a10a1d6020a">More...</a><br /></td></tr> |
| <tr class="separator:a61d8dcdc363718cb686a9a10a1d6020a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c090438916dacc5ce9c8bae6b242910"><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_1Utilities_1_1IDeliveryQueue.html#a4c090438916dacc5ce9c8bae6b242910">IsRunning</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4c090438916dacc5ce9c8bae6b242910"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the queue has been stopped or closed, if not then the queue is in a running state. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a4c090438916dacc5ce9c8bae6b242910">More...</a><br /></td></tr> |
| <tr class="separator:a4c090438916dacc5ce9c8bae6b242910"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adbce9b564bee5ce88b82e4fbe8f735d7"><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_1Utilities_1_1IDeliveryQueue.html#adbce9b564bee5ce88b82e4fbe8f735d7">IsClosed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adbce9b564bee5ce88b82e4fbe8f735d7"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the queue has been closed or is still available for use. When this method returns false this queue can still be in a stopped state and may not be returning deliveries. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#adbce9b564bee5ce88b82e4fbe8f735d7">More...</a><br /></td></tr> |
| <tr class="separator:adbce9b564bee5ce88b82e4fbe8f735d7"><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 generic delivery queue used to hold messages or other delivery objects that need to be consumed in order and also provides put-back options for redelivery scenarios. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>The type of delivery object this Queue manages</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <div class="typeconstraint"> |
| <dl><dt><b>Type Constraints</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>class</em></td><td> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="af7afec02d7593c5b787f9b219843a8b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af7afec02d7593c5b787f9b219843a8b2">◆ </a></span>Clear()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Clear </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Purge all currently queued deliveries from this delivery queue. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a5a8f04721ebb6e02ce0cd84cb1c5adcd">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a36c7cae7edd551834ee2f3bc58b40064"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a36c7cae7edd551834ee2f3bc58b40064">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Close the delivery Queue and purge any current deliveries and wakes all waiters currently blocked on a dequeue call. Once closed a delivery queue cannot be started again and no new deliveries can be queued. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#acbafc3e5884057d38e27e397aaa1777b">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2f2c7f62baa4e0cd250e1ce1cfada763"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2f2c7f62baa4e0cd250e1ce1cfada763">◆ </a></span>Dequeue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Dequeue </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>Used to get the next available Delivery. The amount of time this method blocks is based on the timeout value that is supplied to it. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeout</td><td>The time to wait for a delivery to arrive</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The next delivery in the Queue if one arrives within the time span</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">ThreadInterruptedException</td><td>If the waiting thread is interrupted</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#ad4c80b5eeb7be521c57294a2a9a994ed">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ab40d4dd2ec183b88d7b5070472b89199"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab40d4dd2ec183b88d7b5070472b89199">◆ </a></span>DequeueNoWait()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.DequeueNoWait </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Dequeue and return the next available delivery if one is available without the need to block, otherwise returns null. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The next available delivery or null if none ready</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#afc8f7b9ae17ccc18836cb455f6a44bae">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a72fe10bf87e0bb0e610ea609a109b531"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a72fe10bf87e0bb0e610ea609a109b531">◆ </a></span>Enqueue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Enqueue </td> |
| <td>(</td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>delivery</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds the given delivery to the end of the delivery queue. </p> |
| <p>The Delivery to add to the Queue</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a0878f2ffe056788860e9df0ad0b00bd7">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9a9b9e8ac6f09a76ff3ebf3b60474173"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9a9b9e8ac6f09a76ff3ebf3b60474173">◆ </a></span>EnqueueFront()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.EnqueueFront </td> |
| <td>(</td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>delivery</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds the given delivery to the front of the delivery queue. </p> |
| <p>The Delivery to add to the Queue</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a6ff9ba3807ca63e9b04c5f2ec43d3839">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0ba671b9e2fd1b24b904fa0893f5b3ec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0ba671b9e2fd1b24b904fa0893f5b3ec">◆ </a></span>Start()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Start </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Starts the Queue and makes it available for dequeue operations, a non-started queue will always return null for any dequeue operations but will accept new queued deliveries for later dequeue when started. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a2d57f3725b89c34ef51c53cc730baf5b">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa95cdedc73312f1b6f3bd222e4971845"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa95cdedc73312f1b6f3bd222e4971845">◆ </a></span>Stop()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Stop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stops the delivery Queue which wakes any current waiters and prevents any future calls to dequeue a delivery from blocking. New incoming deliveries can still be queued in this state. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#abb204185acd1efd36de1e1987093d70c">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a319b3d3ea064990912142bfec114e48f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a319b3d3ea064990912142bfec114e48f">◆ </a></span>Count</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.Count</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>Retrieves the number of queued deliveries current held in this delivery queue. </p> |
| |
| </div> |
| </div> |
| <a id="adbce9b564bee5ce88b82e4fbe8f735d7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adbce9b564bee5ce88b82e4fbe8f735d7">◆ </a></span>IsClosed</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.IsClosed</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the queue has been closed or is still available for use. When this method returns false this queue can still be in a stopped state and may not be returning deliveries. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the queue is currently not closed</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a61d8dcdc363718cb686a9a10a1d6020a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a61d8dcdc363718cb686a9a10a1d6020a">◆ </a></span>IsEmpty</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.IsEmpty</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the delivery queue is currently empty or not. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if there are no currently queued deliveries</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4c090438916dacc5ce9c8bae6b242910"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4c090438916dacc5ce9c8bae6b242910">◆ </a></span>IsRunning</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue</a>< T >.IsRunning</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the queue has been stopped or closed, if not then the queue is in a running state. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the queue is currently not stopped or closed</dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Utilities/IDeliveryQueue.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> |