You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

121 lines
10 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::flow::interface6::queue_node&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>::<b>flow</b>::<b>interface6</b>::<a class="el" href="a00325.html">queue_node</a></div>
  25. <h1>tbb::flow::interface6::queue_node&lt; T, A &gt; Class Template Reference</h1><!-- doxytag: class="tbb::flow::interface6::queue_node" --><!-- doxytag: inherits="tbb::flow::interface6::buffer_node" -->Forwards messages in FIFO order.
  26. <a href="#_details">More...</a>
  27. <p>
  28. <code>#include &lt;flow_graph.h&gt;</code>
  29. <p>
  30. <p>Inheritance diagram for tbb::flow::interface6::queue_node&lt; T, A &gt;:
  31. <p><center><img src="a00325.png" usemap="#tbb::flow::interface6::queue_node< T, A >_map" border="0" alt=""></center>
  32. <map name="tbb::flow::interface6::queue_node< T, A >_map">
  33. <area href="a00275.html" alt="tbb::flow::interface6::buffer_node< T, A >" shape="rect" coords="280,56,550,80">
  34. <area href="a00301.html" alt="tbb::flow::interface6::graph_node" shape="rect" coords="0,0,270,24">
  35. <area href="a00333.html" alt="tbb::flow::interface6::receiver< T >" shape="rect" coords="280,0,550,24">
  36. <area href="a00339.html" alt="tbb::flow::interface6::sender< T >" shape="rect" coords="560,0,830,24">
  37. <area href="a00340.html" alt="tbb::flow::interface6::sequencer_node< T, A >" shape="rect" coords="280,168,550,192">
  38. </map>
  39. <a href="a00076.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  40. <tr><td></td></tr>
  41. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e71030845210b6c4c7380eb9e11a2ac"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::input_type" ref="1e71030845210b6c4c7380eb9e11a2ac" args="" -->
  43. typedef T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#1e71030845210b6c4c7380eb9e11a2ac">input_type</a></td></tr>
  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The input type of this receiver. <br></td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="25b5a53ab1f9a342644fa3759bc0b1ad"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::output_type" ref="25b5a53ab1f9a342644fa3759bc0b1ad" args="" -->
  46. typedef T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#25b5a53ab1f9a342644fa3759bc0b1ad">output_type</a></td></tr>
  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The output type of this sender. <br></td></tr>
  48. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5e2fdd33c45d44549dee9c1638e19898"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::predecessor_type" ref="5e2fdd33c45d44549dee9c1638e19898" args="" -->
  49. typedef <a class="el" href="a00339.html">sender</a>&lt; <a class="el" href="a00325.html#1e71030845210b6c4c7380eb9e11a2ac">input_type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#5e2fdd33c45d44549dee9c1638e19898">predecessor_type</a></td></tr>
  50. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The predecessor type for this node. <br></td></tr>
  51. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f35076a19f256f9e7a61bed77ca1ccc5"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::successor_type" ref="f35076a19f256f9e7a61bed77ca1ccc5" args="" -->
  52. typedef <a class="el" href="a00333.html">receiver</a>&lt; <a class="el" href="a00325.html#25b5a53ab1f9a342644fa3759bc0b1ad">output_type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#f35076a19f256f9e7a61bed77ca1ccc5">successor_type</a></td></tr>
  53. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The successor type for this node. <br></td></tr>
  54. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  55. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c716593a92448b0f429d1f3a38e67996"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::queue_node" ref="c716593a92448b0f429d1f3a38e67996" args="(graph &amp;g)" -->
  56. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#c716593a92448b0f429d1f3a38e67996">queue_node</a> (<a class="el" href="a00300.html">graph</a> &amp;g)</td></tr>
  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
  58. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0226762d9ebba28311b7b1518d948ab1"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::queue_node" ref="0226762d9ebba28311b7b1518d948ab1" args="(const queue_node &amp;src)" -->
  59. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#0226762d9ebba28311b7b1518d948ab1">queue_node</a> (const <a class="el" href="a00325.html">queue_node</a> &amp;src)</td></tr>
  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
  61. <tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
  62. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a84ab6bb43d056468ac5df3626219513"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::size_type" ref="a84ab6bb43d056468ac5df3626219513" args="" -->
  63. typedef <a class="el" href="a00275.html">buffer_node</a>&lt; T, A <br>
  64. &gt;::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
  65. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63c3b0a76cd7964dec2f3d54afbb05f3"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::queue_operation" ref="63c3b0a76cd7964dec2f3d54afbb05f3" args="" -->
  66. typedef <a class="el" href="a00275.html">buffer_node</a>&lt; T, A <br>
  67. &gt;::buffer_operation&nbsp;</td><td class="memItemRight" valign="bottom"><b>queue_operation</b></td></tr>
  68. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b748e310297e1e3f88952a2a9876bab979763449c8716cdd38fda58e607551f1"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::WAIT" ref="b748e310297e1e3f88952a2a9876bab979763449c8716cdd38fda58e607551f1" args="" -->
  69. &nbsp;</td><td class="memItemRight" valign="bottom"><b>WAIT</b> = 0</td></tr>
  70. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b748e310297e1e3f88952a2a9876bab923e845160e46a20fb8550132f04e94aa"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::SUCCEEDED" ref="b748e310297e1e3f88952a2a9876bab923e845160e46a20fb8550132f04e94aa" args="" -->
  71. &nbsp;</td><td class="memItemRight" valign="bottom"><b>SUCCEEDED</b></td></tr>
  72. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b748e310297e1e3f88952a2a9876bab9ad699b139814d0746be2266041081474"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::FAILED" ref="b748e310297e1e3f88952a2a9876bab9ad699b139814d0746be2266041081474" args="" -->
  73. &nbsp;</td><td class="memItemRight" valign="bottom"><b>FAILED</b></td></tr>
  74. <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>op_stat</b> { <b>WAIT</b> = 0,
  75. <b>SUCCEEDED</b>,
  76. <b>FAILED</b>
  77. }</td></tr>
  78. <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
  79. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8eecd6591d7565cbb5b7f1e37bf97979"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::internal_forward_task" ref="8eecd6591d7565cbb5b7f1e37bf97979" args="(queue_operation *op)" -->
  80. void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00325.html#8eecd6591d7565cbb5b7f1e37bf97979">internal_forward_task</a> (queue_operation *op)</td></tr>
  81. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tries to forward valid items to successors. <br></td></tr>
  82. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfd2350a4c9d14486a8a9285acb9ca49"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::internal_pop" ref="cfd2350a4c9d14486a8a9285acb9ca49" args="(queue_operation *op)" -->
  83. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>internal_pop</b> (queue_operation *op)</td></tr>
  84. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf478ff2ae265ec859928191e2f7dbe3"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::internal_reserve" ref="bf478ff2ae265ec859928191e2f7dbe3" args="(queue_operation *op)" -->
  85. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>internal_reserve</b> (queue_operation *op)</td></tr>
  86. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d67eee760d9fd829064927e7fe1b54fb"></a><!-- doxytag: member="tbb::flow::interface6::queue_node::internal_consume" ref="d67eee760d9fd829064927e7fe1b54fb" args="(queue_operation *op)" -->
  87. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>internal_consume</b> (queue_operation *op)</td></tr>
  88. </table>
  89. <hr><a name="_details"></a><h2>Detailed Description</h2>
  90. <h3>template&lt;typename T, typename A = cache_aligned_allocator&lt;T&gt;&gt;<br>
  91. class tbb::flow::interface6::queue_node&lt; T, A &gt;</h3>
  92. Forwards messages in FIFO order.
  93. <p>
  94. <hr>The documentation for this class was generated from the following file:<ul>
  95. <li><a class="el" href="a00385.html">flow_graph.h</a></ul>
  96. <hr>
  97. <p></p>
  98. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  99. <p></p>
  100. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  101. registered trademarks or trademarks of Intel Corporation or its
  102. subsidiaries in the United States and other countries.
  103. <p></p>
  104. * Other names and brands may be claimed as the property of others.