310 lines
23 KiB

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>tbb::concurrent_bounded_queue&lt; T, A &gt; Class Template Reference</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.4.7 -->
  8. <div class="tabs">
  9. <ul>
  10. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  13. <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
  14. <li><a href="files.html"><span>Files</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16. </ul></div>
  17. <div class="tabs">
  18. <ul>
  19. <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  20. <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  21. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  22. </ul></div>
  23. <div class="nav">
  24. <a class="el" href="a00428.html">tbb</a>::<a class="el" href="a00280.html">concurrent_bounded_queue</a></div>
  25. <h1>tbb::concurrent_bounded_queue&lt; T, A &gt; Class Template Reference<br>
  26. <small>
  27. [<a class="el" href="a00442.html">Containers</a>]</small>
  28. </h1><!-- doxytag: class="tbb::concurrent_bounded_queue" -->A high-performance thread-safe blocking concurrent bounded queue.
  29. <a href="#_details">More...</a>
  30. <p>
  31. <code>#include &lt;concurrent_queue.h&gt;</code>
  32. <p>
  33. <p>Inheritance diagram for tbb::concurrent_bounded_queue&lt; T, A &gt;:
  34. <p><center><img src="a00280.png" usemap="#tbb::concurrent_bounded_queue< T, A >_map" border="0" alt=""></center>
  35. <map name="tbb::concurrent_bounded_queue< T, A >_map">
  36. <area href="a00287.html" alt="tbb::deprecated::concurrent_queue< T, A >" shape="rect" coords="0,56,257,80">
  37. </map>
  38. <a href="a00036.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  39. <tr><td></td></tr>
  40. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  41. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98245517a931e5893f6601e66c51fc75"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::value_type" ref="98245517a931e5893f6601e66c51fc75" args="" -->
  42. typedef T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#98245517a931e5893f6601e66c51fc75">value_type</a></td></tr>
  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Element type in the queue. <br></td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e2726fccf6d975dc1071608cc0bbf90"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::allocator_type" ref="2e2726fccf6d975dc1071608cc0bbf90" args="" -->
  45. typedef A&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a></td></tr>
  46. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocator type. <br></td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dcd44ca6a88c0dc7a847a47a10811f0c"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::reference" ref="dcd44ca6a88c0dc7a847a47a10811f0c" args="" -->
  48. typedef T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#dcd44ca6a88c0dc7a847a47a10811f0c">reference</a></td></tr>
  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference type. <br></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="796713d0b9ba93a4721cbe13e4474068"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::const_reference" ref="796713d0b9ba93a4721cbe13e4474068" args="" -->
  51. typedef const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#796713d0b9ba93a4721cbe13e4474068">const_reference</a></td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Const reference type. <br></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::ptrdiff_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a></td></tr>
  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Integral type for representing size of the queue. <a href="#a80e4c11dbb324e4b92a24a77bbcde68"></a><br></td></tr>
  55. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b45c91297e69515d83d5eef85ae1f49"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::difference_type" ref="4b45c91297e69515d83d5eef85ae1f49" args="" -->
  56. typedef std::ptrdiff_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#4b45c91297e69515d83d5eef85ae1f49">difference_type</a></td></tr>
  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Difference type for iterator. <br></td></tr>
  58. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aeea2ad38b7e7fc2866f063dfed24c52"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::iterator" ref="aeea2ad38b7e7fc2866f063dfed24c52" args="" -->
  59. typedef internal::concurrent_queue_iterator&lt;<br>
  60. <a class="el" href="a00280.html">concurrent_bounded_queue</a>,<br>
  61. T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>iterator</b></td></tr>
  62. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0edd1a90e6ffa503bac1c4027116dbff"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::const_iterator" ref="0edd1a90e6ffa503bac1c4027116dbff" args="" -->
  63. typedef internal::concurrent_queue_iterator&lt;<br>
  64. <a class="el" href="a00280.html">concurrent_bounded_queue</a>,<br>
  65. const T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b></td></tr>
  66. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  67. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e3525226732963ff0f13e89d8e6dab5b"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::concurrent_bounded_queue" ref="e3525226732963ff0f13e89d8e6dab5b" args="(const allocator_type &amp;a=allocator_type())" -->
  68. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#e3525226732963ff0f13e89d8e6dab5b">concurrent_bounded_queue</a> (const <a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a> &amp;a=<a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a>())</td></tr>
  69. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct empty queue. <br></td></tr>
  70. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b7fb414d2eaa8a7f5d68fc4cd63ac50"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::concurrent_bounded_queue" ref="7b7fb414d2eaa8a7f5d68fc4cd63ac50" args="(const concurrent_bounded_queue &amp;src, const allocator_type &amp;a=allocator_type())" -->
  71. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#7b7fb414d2eaa8a7f5d68fc4cd63ac50">concurrent_bounded_queue</a> (const <a class="el" href="a00280.html">concurrent_bounded_queue</a> &amp;src, const <a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a> &amp;a=<a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a>())</td></tr>
  72. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
  73. <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="a5e04dcd7db9fd9b583b4e7df832246a"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::concurrent_bounded_queue" ref="a5e04dcd7db9fd9b583b4e7df832246a" args="(InputIterator begin, InputIterator end, const allocator_type &amp;a=allocator_type())" -->
  74. template&lt;typename InputIterator&gt; </td></tr>
  75. <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00280.html#a5e04dcd7db9fd9b583b4e7df832246a">concurrent_bounded_queue</a> (InputIterator begin, InputIterator end, const <a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a> &amp;a=<a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a>())</td></tr>
  76. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[begin,end) constructor <br></td></tr>
  77. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acaf5b510dc0dfc7780b8c956cf773cf"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::~concurrent_bounded_queue" ref="acaf5b510dc0dfc7780b8c956cf773cf" args="()" -->
  78. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#acaf5b510dc0dfc7780b8c956cf773cf">~concurrent_bounded_queue</a> ()</td></tr>
  79. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy queue. <br></td></tr>
  80. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ceb08c743b11ba88c878e73fff8af20b"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::push" ref="ceb08c743b11ba88c878e73fff8af20b" args="(const T &amp;source)" -->
  81. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#ceb08c743b11ba88c878e73fff8af20b">push</a> (const T &amp;source)</td></tr>
  82. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enqueue an item at tail of queue. <br></td></tr>
  83. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#41f4c6bd7a82ab070e840bbf81b0b123">pop</a> (T &amp;destination)</td></tr>
  84. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dequeue item from head of queue. <a href="#41f4c6bd7a82ab070e840bbf81b0b123"></a><br></td></tr>
  85. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86c77a6c1317239405968f5afc7b10d3"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::abort" ref="86c77a6c1317239405968f5afc7b10d3" args="()" -->
  86. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#86c77a6c1317239405968f5afc7b10d3">abort</a> ()</td></tr>
  87. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abort all pending queue operations. <br></td></tr>
  88. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#2bd6232531279fb3ccbd296bea23066b">try_push</a> (const T &amp;source)</td></tr>
  89. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enqueue an item at tail of queue if queue is not already full. <a href="#2bd6232531279fb3ccbd296bea23066b"></a><br></td></tr>
  90. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#0ca487019bbb00a196442aff78a1e4f7">try_pop</a> (T &amp;destination)</td></tr>
  91. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempt to dequeue an item from head of queue. <a href="#0ca487019bbb00a196442aff78a1e4f7"></a><br></td></tr>
  92. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#7dc14d1a579a4cccda9f857585e1768d">size</a> () const </td></tr>
  93. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return number of pushes minus number of pops. <a href="#7dc14d1a579a4cccda9f857585e1768d"></a><br></td></tr>
  94. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f64924f2ee9225c368a270fc3c394db9"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::empty" ref="f64924f2ee9225c368a270fc3c394db9" args="() const " -->
  95. bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#f64924f2ee9225c368a270fc3c394db9">empty</a> () const </td></tr>
  96. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Equivalent to <a class="el" href="a00280.html#7dc14d1a579a4cccda9f857585e1768d">size()</a>&lt;=0. <br></td></tr>
  97. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2888b3e4e837d7e03f2c731963a402b"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::capacity" ref="b2888b3e4e837d7e03f2c731963a402b" args="() const " -->
  98. <a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#b2888b3e4e837d7e03f2c731963a402b">capacity</a> () const </td></tr>
  99. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum number of allowed elements. <br></td></tr>
  100. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#f3c6c934f85fd02aedbc83a16943193b">set_capacity</a> (<a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a> new_capacity)</td></tr>
  101. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the capacity. <a href="#f3c6c934f85fd02aedbc83a16943193b"></a><br></td></tr>
  102. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="415eb87e53b1c6a266de06ecbc490d16"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::get_allocator" ref="415eb87e53b1c6a266de06ecbc490d16" args="() const " -->
  103. <a class="el" href="a00280.html#2e2726fccf6d975dc1071608cc0bbf90">allocator_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#415eb87e53b1c6a266de06ecbc490d16">get_allocator</a> () const </td></tr>
  104. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return allocator object <br></td></tr>
  105. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="90b31e2954c6e4596c7900435a5f4bc1"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::clear" ref="90b31e2954c6e4596c7900435a5f4bc1" args="()" -->
  106. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html#90b31e2954c6e4596c7900435a5f4bc1">clear</a> ()</td></tr>
  107. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">clear the queue. not thread-safe. <br></td></tr>
  108. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a2637188e104503ac2c0dff633014e8"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::unsafe_begin" ref="5a2637188e104503ac2c0dff633014e8" args="()" -->
  109. iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>unsafe_begin</b> ()</td></tr>
  110. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7267334ef11087c76c810abb9d5cbc2"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::unsafe_end" ref="c7267334ef11087c76c810abb9d5cbc2" args="()" -->
  111. iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>unsafe_end</b> ()</td></tr>
  112. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8be757841d0bbf7744508aaf6a141d08"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::unsafe_begin" ref="8be757841d0bbf7744508aaf6a141d08" args="() const " -->
  113. const_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>unsafe_begin</b> () const </td></tr>
  114. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3aac91d288bf227d9d06717b44ef28f7"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::unsafe_end" ref="3aac91d288bf227d9d06717b44ef28f7" args="() const " -->
  115. const_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>unsafe_end</b> () const </td></tr>
  116. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  117. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05bffad9626d51abbd4bb82ae2a1cceb"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::internal::concurrent_queue_iterator" ref="05bffad9626d51abbd4bb82ae2a1cceb" args="" -->
  118. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>internal::concurrent_queue_iterator</b></td></tr>
  119. <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  120. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>destroyer</b></td></tr>
  121. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class used to ensure exception-safety of method "pop". <br></td></tr>
  122. </table>
  123. <hr><a name="_details"></a><h2>Detailed Description</h2>
  124. <h3>template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt;<br>
  125. class tbb::concurrent_bounded_queue&lt; T, A &gt;</h3>
  126. A high-performance thread-safe blocking concurrent bounded queue.
  127. <p>
  128. This is the pre-PPL TBB concurrent queue which supports boundedness and blocking semantics. Note that method names agree with the PPL-style concurrent queue. Multiple threads may each push and pop concurrently. Assignment construction is not allowed.
  129. <p>
  130. <hr><h2>Member Typedef Documentation</h2>
  131. <a class="anchor" name="a80e4c11dbb324e4b92a24a77bbcde68"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::size_type" ref="a80e4c11dbb324e4b92a24a77bbcde68" args="" -->
  132. <div class="memitem">
  133. <div class="memproto">
  134. <div class="memtemplate">
  135. template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt; </div>
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">typedef std::ptrdiff_t <a class="el" href="a00280.html">tbb::concurrent_bounded_queue</a>&lt; T, A &gt;::<a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a> </td>
  139. </tr>
  140. </table>
  141. </div>
  142. <div class="memdoc">
  143. <p>
  144. Integral type for representing size of the queue.
  145. <p>
  146. Note that the size_type is a signed integral type. This is because the size can be negative if there are pending pops without corresponding pushes.
  147. </div>
  148. </div><p>
  149. <hr><h2>Member Function Documentation</h2>
  150. <a class="anchor" name="41f4c6bd7a82ab070e840bbf81b0b123"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::pop" ref="41f4c6bd7a82ab070e840bbf81b0b123" args="(T &amp;destination)" -->
  151. <div class="memitem">
  152. <div class="memproto">
  153. <div class="memtemplate">
  154. template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt; </div>
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">void <a class="el" href="a00280.html">tbb::concurrent_bounded_queue</a>&lt; T, A &gt;::pop </td>
  158. <td>(</td>
  159. <td class="paramtype">T &amp;&nbsp;</td>
  160. <td class="paramname"> <em>destination</em> </td>
  161. <td>&nbsp;)&nbsp;</td>
  162. <td width="100%"><code> [inline]</code></td>
  163. </tr>
  164. </table>
  165. </div>
  166. <div class="memdoc">
  167. <p>
  168. Dequeue item from head of queue.
  169. <p>
  170. Block until an item becomes available, and then dequeue it.
  171. </div>
  172. </div><p>
  173. <a class="anchor" name="f3c6c934f85fd02aedbc83a16943193b"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::set_capacity" ref="f3c6c934f85fd02aedbc83a16943193b" args="(size_type new_capacity)" -->
  174. <div class="memitem">
  175. <div class="memproto">
  176. <div class="memtemplate">
  177. template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt; </div>
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">void <a class="el" href="a00280.html">tbb::concurrent_bounded_queue</a>&lt; T, A &gt;::set_capacity </td>
  181. <td>(</td>
  182. <td class="paramtype"><a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a>&nbsp;</td>
  183. <td class="paramname"> <em>new_capacity</em> </td>
  184. <td>&nbsp;)&nbsp;</td>
  185. <td width="100%"><code> [inline]</code></td>
  186. </tr>
  187. </table>
  188. </div>
  189. <div class="memdoc">
  190. <p>
  191. Set the capacity.
  192. <p>
  193. Setting the capacity to 0 causes subsequent try_push operations to always fail, and subsequent push operations to block forever.
  194. </div>
  195. </div><p>
  196. <a class="anchor" name="7dc14d1a579a4cccda9f857585e1768d"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::size" ref="7dc14d1a579a4cccda9f857585e1768d" args="() const " -->
  197. <div class="memitem">
  198. <div class="memproto">
  199. <div class="memtemplate">
  200. template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt; </div>
  201. <table class="memname">
  202. <tr>
  203. <td class="memname"><a class="el" href="a00280.html#a80e4c11dbb324e4b92a24a77bbcde68">size_type</a> <a class="el" href="a00280.html">tbb::concurrent_bounded_queue</a>&lt; T, A &gt;::size </td>
  204. <td>(</td>
  205. <td class="paramname"> </td>
  206. <td>&nbsp;)&nbsp;</td>
  207. <td width="100%"> const<code> [inline]</code></td>
  208. </tr>
  209. </table>
  210. </div>
  211. <div class="memdoc">
  212. <p>
  213. Return number of pushes minus number of pops.
  214. <p>
  215. Note that the result can be negative if there are pops waiting for the corresponding pushes. The result can also exceed <a class="el" href="a00280.html#b2888b3e4e837d7e03f2c731963a402b">capacity()</a> if there are push operations in flight.
  216. </div>
  217. </div><p>
  218. <a class="anchor" name="0ca487019bbb00a196442aff78a1e4f7"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::try_pop" ref="0ca487019bbb00a196442aff78a1e4f7" args="(T &amp;destination)" -->
  219. <div class="memitem">
  220. <div class="memproto">
  221. <div class="memtemplate">
  222. template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt; </div>
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">bool <a class="el" href="a00280.html">tbb::concurrent_bounded_queue</a>&lt; T, A &gt;::try_pop </td>
  226. <td>(</td>
  227. <td class="paramtype">T &amp;&nbsp;</td>
  228. <td class="paramname"> <em>destination</em> </td>
  229. <td>&nbsp;)&nbsp;</td>
  230. <td width="100%"><code> [inline]</code></td>
  231. </tr>
  232. </table>
  233. </div>
  234. <div class="memdoc">
  235. <p>
  236. Attempt to dequeue an item from head of queue.
  237. <p>
  238. Does not wait for item to become available. Returns true if successful; false otherwise.
  239. </div>
  240. </div><p>
  241. <a class="anchor" name="2bd6232531279fb3ccbd296bea23066b"></a><!-- doxytag: member="tbb::concurrent_bounded_queue::try_push" ref="2bd6232531279fb3ccbd296bea23066b" args="(const T &amp;source)" -->
  242. <div class="memitem">
  243. <div class="memproto">
  244. <div class="memtemplate">
  245. template&lt;typename T, class A = cache_aligned_allocator&lt;T&gt;&gt; </div>
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">bool <a class="el" href="a00280.html">tbb::concurrent_bounded_queue</a>&lt; T, A &gt;::try_push </td>
  249. <td>(</td>
  250. <td class="paramtype">const T &amp;&nbsp;</td>
  251. <td class="paramname"> <em>source</em> </td>
  252. <td>&nbsp;)&nbsp;</td>
  253. <td width="100%"><code> [inline]</code></td>
  254. </tr>
  255. </table>
  256. </div>
  257. <div class="memdoc">
  258. <p>
  259. Enqueue an item at tail of queue if queue is not already full.
  260. <p>
  261. Does not wait for queue to become not full. Returns true if item is pushed; false if queue was already full.
  262. </div>
  263. </div><p>
  264. <hr>The documentation for this class was generated from the following file:<ul>
  265. <li>concurrent_queue.h</ul>
  266. <hr>
  267. <p></p>
  268. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  269. <p></p>
  270. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  271. registered trademarks or trademarks of Intel Corporation or its
  272. subsidiaries in the United States and other countries.
  273. <p></p>
  274. * Other names and brands may be claimed as the property of others.