| <!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.Utilities.RingQueue< 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_1Utilities.html">Utilities</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">RingQueue</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Utilities.RingQueue< T > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Simple Ring Queue implementation that has an enforced max size value. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Utilities.RingQueue< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.png" alt=""/> |
| </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:a8a15a340df4d92f9a83182d74da110f7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a8a15a340df4d92f9a83182d74da110f7">RingQueue</a> (int queueSize)</td></tr> |
| <tr class="memdesc:a8a15a340df4d92f9a83182d74da110f7"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html" title="Simple Ring Queue implementation that has an enforced max size value.">RingQueue</a> instance with the given fixed queue size. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a8a15a340df4d92f9a83182d74da110f7">More...</a><br /></td></tr> |
| <tr class="separator:a8a15a340df4d92f9a83182d74da110f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af63603dc8ad9a37f53e8659b0e260b88"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#af63603dc8ad9a37f53e8659b0e260b88">RingQueue</a> (IReadOnlyCollection< T > elements)</td></tr> |
| <tr class="memdesc:af63603dc8ad9a37f53e8659b0e260b88"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html" title="Simple Ring Queue implementation that has an enforced max size value.">RingQueue</a> instance with elements of the given collection as the initial values contained in the queue. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#af63603dc8ad9a37f53e8659b0e260b88">More...</a><br /></td></tr> |
| <tr class="separator:af63603dc8ad9a37f53e8659b0e260b88"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab957ec2ddfda0cee30ca41ecb0cf6094"><td class="memItemLeft" align="right" valign="top"><a id="ab957ec2ddfda0cee30ca41ecb0cf6094"></a> |
| IEnumerator< T > </td><td class="memItemRight" valign="bottom"><b>GetEnumerator</b> ()</td></tr> |
| <tr class="separator:ab957ec2ddfda0cee30ca41ecb0cf6094"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adac01c4eb6dcea1bbc75fa681fc101d1"><td class="memItemLeft" align="right" valign="top"><a id="adac01c4eb6dcea1bbc75fa681fc101d1"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>CopyTo</b> (Array array, int index)</td></tr> |
| <tr class="separator:adac01c4eb6dcea1bbc75fa681fc101d1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab43423f52ecb2d855dab99ad295a7462"><td class="memItemLeft" align="right" valign="top"><a id="ab43423f52ecb2d855dab99ad295a7462"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>CopyTo</b> (T[] array, int index)</td></tr> |
| <tr class="separator:ab43423f52ecb2d855dab99ad295a7462"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a22f0da7a59e5a96d426dd4e328c90c56"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a22f0da7a59e5a96d426dd4e328c90c56">IsEmpty</a> ()</td></tr> |
| <tr class="memdesc:a22f0da7a59e5a96d426dd4e328c90c56"><td class="mdescLeft"> </td><td class="mdescRight">Checks if this queue is empty or not. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a22f0da7a59e5a96d426dd4e328c90c56">More...</a><br /></td></tr> |
| <tr class="separator:a22f0da7a59e5a96d426dd4e328c90c56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8384098feddd9523c601752f65ab2af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#ad8384098feddd9523c601752f65ab2af">Clear</a> ()</td></tr> |
| <tr class="memdesc:ad8384098feddd9523c601752f65ab2af"><td class="mdescLeft"> </td><td class="mdescRight">Clears all elements from this queue and resets to an empty state. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#ad8384098feddd9523c601752f65ab2af">More...</a><br /></td></tr> |
| <tr class="separator:ad8384098feddd9523c601752f65ab2af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a336373955b0102012026afdd8fc3af9d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a336373955b0102012026afdd8fc3af9d">Offer</a> (T e)</td></tr> |
| <tr class="memdesc:a336373955b0102012026afdd8fc3af9d"><td class="mdescLeft"> </td><td class="mdescRight">Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a336373955b0102012026afdd8fc3af9d">More...</a><br /></td></tr> |
| <tr class="separator:a336373955b0102012026afdd8fc3af9d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81ddf89e6cb1923853ea117740703a0c"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a81ddf89e6cb1923853ea117740703a0c">Poll</a> ()</td></tr> |
| <tr class="memdesc:a81ddf89e6cb1923853ea117740703a0c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value at the head of the queue if one is present or returns the default value for the type contained in the queue if empty. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a81ddf89e6cb1923853ea117740703a0c">More...</a><br /></td></tr> |
| <tr class="separator:a81ddf89e6cb1923853ea117740703a0c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74d12a0c461d38a76587a47512948c24"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a74d12a0c461d38a76587a47512948c24">Poll</a> (Func< T > createOnEmpty)</td></tr> |
| <tr class="memdesc:a74d12a0c461d38a76587a47512948c24"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves and removes the head of this ring queue, and if the queue is currently empty a new instance of the queue type is provided by invoking the given function to supply a default value. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a74d12a0c461d38a76587a47512948c24">More...</a><br /></td></tr> |
| <tr class="separator:a74d12a0c461d38a76587a47512948c24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5761c20c75c65ed0103276c02cded078"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a5761c20c75c65ed0103276c02cded078">Peek</a> ()</td></tr> |
| <tr class="separator:a5761c20c75c65ed0103276c02cded078"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b3087e8943900410702d9e3a48317fa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a5b3087e8943900410702d9e3a48317fa">Contains</a> (T value)</td></tr> |
| <tr class="memdesc:a5b3087e8943900410702d9e3a48317fa"><td class="mdescLeft"> </td><td class="mdescRight">Search the queue for the specified value and returns true if found. <a href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html#a5b3087e8943900410702d9e3a48317fa">More...</a><br /></td></tr> |
| <tr class="separator:a5b3087e8943900410702d9e3a48317fa"><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:a45b17775f3964ae1943f6c2481630657"><td class="memItemLeft" align="right" valign="top"><a id="a45b17775f3964ae1943f6c2481630657"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>Count</b><code> [get]</code></td></tr> |
| <tr class="separator:a45b17775f3964ae1943f6c2481630657"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a151c561c9d9bcdcd2cb245695ca4be3a"><td class="memItemLeft" align="right" valign="top"><a id="a151c561c9d9bcdcd2cb245695ca4be3a"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsSynchronized</b><code> [get]</code></td></tr> |
| <tr class="separator:a151c561c9d9bcdcd2cb245695ca4be3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3b531fc67358d303520255bc675bb666"><td class="memItemLeft" align="right" valign="top"><a id="a3b531fc67358d303520255bc675bb666"></a> |
| object </td><td class="memItemRight" valign="bottom"><b>SyncRoot</b><code> [get]</code></td></tr> |
| <tr class="separator:a3b531fc67358d303520255bc675bb666"><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 Ring Queue implementation that has an enforced max size value. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>The type contained in the Queue</td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a8a15a340df4d92f9a83182d74da110f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a15a340df4d92f9a83182d74da110f7">◆ </a></span>RingQueue() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">RingQueue</a> </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>queueSize</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>Creates a new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html" title="Simple Ring Queue implementation that has an enforced max size value.">RingQueue</a> instance with the given fixed queue size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">queueSize</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af63603dc8ad9a37f53e8659b0e260b88"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af63603dc8ad9a37f53e8659b0e260b88">◆ </a></span>RingQueue() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">RingQueue</a> </td> |
| <td>(</td> |
| <td class="paramtype">IReadOnlyCollection< T > </td> |
| <td class="paramname"><em>elements</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>Create a new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html" title="Simple Ring Queue implementation that has an enforced max size value.">RingQueue</a> instance with elements of the given collection as the initial values contained in the queue. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">elements</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad8384098feddd9523c601752f65ab2af"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad8384098feddd9523c601752f65ab2af">◆ </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_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</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>Clears all elements from this queue and resets to an empty state. </p> |
| |
| </div> |
| </div> |
| <a id="a5b3087e8943900410702d9e3a48317fa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5b3087e8943900410702d9e3a48317fa">◆ </a></span>Contains()</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="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.Contains </td> |
| <td>(</td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>value</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>Search the queue for the specified value and returns true if found. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value</td><td>The value whose presence is being queried</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the queue contains the given value.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a22f0da7a59e5a96d426dd4e328c90c56"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a22f0da7a59e5a96d426dd4e328c90c56">◆ </a></span>IsEmpty()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.IsEmpty </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if this queue is empty or not. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the queue has no elements</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a336373955b0102012026afdd8fc3af9d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a336373955b0102012026afdd8fc3af9d">◆ </a></span>Offer()</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="classApache_1_1Qpid_1_1Proton_1_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.Offer </td> |
| <td>(</td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>e</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>Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">e</td><td>The value to insert into the queue</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the element was inserted successfully</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5761c20c75c65ed0103276c02cded078"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5761c20c75c65ed0103276c02cded078">◆ </a></span>Peek()</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_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.Peek </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></p> |
| <dl class="section return"><dt>Returns</dt><dd>The head of the queue or the default value contained type</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a81ddf89e6cb1923853ea117740703a0c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a81ddf89e6cb1923853ea117740703a0c">◆ </a></span>Poll() <span class="overload">[1/2]</span></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_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.Poll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the value at the head of the queue if one is present or returns the default value for the type contained in the queue if empty. </p> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| </div> |
| </div> |
| <a id="a74d12a0c461d38a76587a47512948c24"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a74d12a0c461d38a76587a47512948c24">◆ </a></span>Poll() <span class="overload">[2/2]</span></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_1Utilities_1_1RingQueue.html">Apache.Qpid.Proton.Utilities.RingQueue</a>< T >.Poll </td> |
| <td>(</td> |
| <td class="paramtype">Func< T > </td> |
| <td class="paramname"><em>createOnEmpty</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>Retrieves and removes the head of this ring queue, and if the queue is currently empty a new instance of the queue type is provided by invoking the given function to supply a default value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">createOnEmpty</td><td>Supplier function for value when empty</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A value from the queue or a supplied value</dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Utilities/RingQueue.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> |
