| <!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.FifoDeliveryQueue< T > Class 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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">FifoDeliveryQueue</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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Simple first in / first out delivery queue with no reordering for priority or other criteria. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.png" usemap="#Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue_3C_20T_20_3E_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue_3C_20T_20_3E_map" name="Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue_3C_20T_20_3E_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html" title="A generic delivery queue used to hold messages or other delivery objects that need to be consumed in ..." alt="Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T >" shape="rect" coords="0,0,350,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a5a8f04721ebb6e02ce0cd84cb1c5adcd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a5a8f04721ebb6e02ce0cd84cb1c5adcd">Clear</a> ()</td></tr> |
| <tr class="memdesc:a5a8f04721ebb6e02ce0cd84cb1c5adcd"><td class="mdescLeft"> </td><td class="mdescRight">Purge all currently queued deliveries from this delivery queue. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a5a8f04721ebb6e02ce0cd84cb1c5adcd">More...</a><br /></td></tr> |
| <tr class="separator:a5a8f04721ebb6e02ce0cd84cb1c5adcd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acbafc3e5884057d38e27e397aaa1777b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#acbafc3e5884057d38e27e397aaa1777b">Close</a> ()</td></tr> |
| <tr class="memdesc:acbafc3e5884057d38e27e397aaa1777b"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#acbafc3e5884057d38e27e397aaa1777b">More...</a><br /></td></tr> |
| <tr class="separator:acbafc3e5884057d38e27e397aaa1777b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad4c80b5eeb7be521c57294a2a9a994ed"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#ad4c80b5eeb7be521c57294a2a9a994ed">Dequeue</a> (TimeSpan timeout)</td></tr> |
| <tr class="memdesc:ad4c80b5eeb7be521c57294a2a9a994ed"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#ad4c80b5eeb7be521c57294a2a9a994ed">More...</a><br /></td></tr> |
| <tr class="separator:ad4c80b5eeb7be521c57294a2a9a994ed"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afc8f7b9ae17ccc18836cb455f6a44bae"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#afc8f7b9ae17ccc18836cb455f6a44bae">DequeueNoWait</a> ()</td></tr> |
| <tr class="memdesc:afc8f7b9ae17ccc18836cb455f6a44bae"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#afc8f7b9ae17ccc18836cb455f6a44bae">More...</a><br /></td></tr> |
| <tr class="separator:afc8f7b9ae17ccc18836cb455f6a44bae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0878f2ffe056788860e9df0ad0b00bd7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a0878f2ffe056788860e9df0ad0b00bd7">Enqueue</a> (T delivery)</td></tr> |
| <tr class="memdesc:a0878f2ffe056788860e9df0ad0b00bd7"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given delivery to the end of the delivery queue. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a0878f2ffe056788860e9df0ad0b00bd7">More...</a><br /></td></tr> |
| <tr class="separator:a0878f2ffe056788860e9df0ad0b00bd7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ff9ba3807ca63e9b04c5f2ec43d3839"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a6ff9ba3807ca63e9b04c5f2ec43d3839">EnqueueFront</a> (T delivery)</td></tr> |
| <tr class="memdesc:a6ff9ba3807ca63e9b04c5f2ec43d3839"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given delivery to the front of the delivery queue. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a6ff9ba3807ca63e9b04c5f2ec43d3839">More...</a><br /></td></tr> |
| <tr class="separator:a6ff9ba3807ca63e9b04c5f2ec43d3839"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2d57f3725b89c34ef51c53cc730baf5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a2d57f3725b89c34ef51c53cc730baf5b">Start</a> ()</td></tr> |
| <tr class="memdesc:a2d57f3725b89c34ef51c53cc730baf5b"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#a2d57f3725b89c34ef51c53cc730baf5b">More...</a><br /></td></tr> |
| <tr class="separator:a2d57f3725b89c34ef51c53cc730baf5b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb204185acd1efd36de1e1987093d70c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#abb204185acd1efd36de1e1987093d70c">Stop</a> ()</td></tr> |
| <tr class="memdesc:abb204185acd1efd36de1e1987093d70c"><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="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html#abb204185acd1efd36de1e1987093d70c">More...</a><br /></td></tr> |
| <tr class="separator:abb204185acd1efd36de1e1987093d70c"><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:a12f76dcbb72b32bb777c6cc224a4afc3"><td class="memItemLeft" align="right" valign="top"><a id="a12f76dcbb72b32bb777c6cc224a4afc3"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsRunning</b><code> [get]</code></td></tr> |
| <tr class="separator:a12f76dcbb72b32bb777c6cc224a4afc3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a94779c3c88582f4fda3d453e852210b1"><td class="memItemLeft" align="right" valign="top"><a id="a94779c3c88582f4fda3d453e852210b1"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsClosed</b><code> [get]</code></td></tr> |
| <tr class="separator:a94779c3c88582f4fda3d453e852210b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abfe7a500bc1d6fdd9d6266d87c3f8619"><td class="memItemLeft" align="right" valign="top"><a id="abfe7a500bc1d6fdd9d6266d87c3f8619"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsEmpty</b><code> [get]</code></td></tr> |
| <tr class="separator:abfe7a500bc1d6fdd9d6266d87c3f8619"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace011a91fdb0631590c50b12057cb58f"><td class="memItemLeft" align="right" valign="top"><a id="ace011a91fdb0631590c50b12057cb58f"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>Count</b><code> [get]</code></td></tr> |
| <tr class="separator:ace011a91fdb0631590c50b12057cb58f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a></td></tr> |
| <tr class="memitem:a319b3d3ea064990912142bfec114e48f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61d8dcdc363718cb686a9a10a1d6020a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c090438916dacc5ce9c8bae6b242910 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adbce9b564bee5ce88b82e4fbe8f735d7 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><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 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Simple first in / first out delivery queue with no reordering for priority or other criteria. </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="a5a8f04721ebb6e02ce0cd84cb1c5adcd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5a8f04721ebb6e02ce0cd84cb1c5adcd">◆ </a></span>Clear()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.Clear </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Purge all currently queued deliveries from this delivery queue. </p> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#af7afec02d7593c5b787f9b219843a8b2">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="acbafc3e5884057d38e27e397aaa1777b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acbafc3e5884057d38e27e397aaa1777b">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a36c7cae7edd551834ee2f3bc58b40064">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad4c80b5eeb7be521c57294a2a9a994ed"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad4c80b5eeb7be521c57294a2a9a994ed">◆ </a></span>Dequeue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.Dequeue </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>timeout</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a2f2c7f62baa4e0cd250e1ce1cfada763">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="afc8f7b9ae17ccc18836cb455f6a44bae"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc8f7b9ae17ccc18836cb455f6a44bae">◆ </a></span>DequeueNoWait()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.DequeueNoWait </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#ab40d4dd2ec183b88d7b5070472b89199">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0878f2ffe056788860e9df0ad0b00bd7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0878f2ffe056788860e9df0ad0b00bd7">◆ </a></span>Enqueue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.Enqueue </td> |
| <td>(</td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>delivery</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds the given delivery to the end of the delivery queue. </p> |
| <p>The Delivery to add to the Queue</p> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a72fe10bf87e0bb0e610ea609a109b531">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6ff9ba3807ca63e9b04c5f2ec43d3839"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6ff9ba3807ca63e9b04c5f2ec43d3839">◆ </a></span>EnqueueFront()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.EnqueueFront </td> |
| <td>(</td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>delivery</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds the given delivery to the front of the delivery queue. </p> |
| <p>The Delivery to add to the Queue</p> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a9a9b9e8ac6f09a76ff3ebf3b60474173">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2d57f3725b89c34ef51c53cc730baf5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2d57f3725b89c34ef51c53cc730baf5b">◆ </a></span>Start()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.Start </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#a0ba671b9e2fd1b24b904fa0893f5b3ec">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="abb204185acd1efd36de1e1987093d70c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abb204185acd1efd36de1e1987093d70c">◆ </a></span>Stop()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1FifoDeliveryQueue.html">Apache.Qpid.Proton.Client.Utilities.FifoDeliveryQueue</a>< T >.Stop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Utilities_1_1IDeliveryQueue.html#aa95cdedc73312f1b6f3bd222e4971845">Apache.Qpid.Proton.Client.Utilities.IDeliveryQueue< T ></a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Utilities/FifoDeliveryQueue.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> |
