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.

93 lines
7.6 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::sender&lt; T &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="a00339.html">sender</a></div>
  25. <h1>tbb::flow::interface6::sender&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="tbb::flow::interface6::sender" -->Pure virtual template class that defines a sender of messages of type T.
  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::sender&lt; T &gt;:
  31. <p><center><img src="a00339.png" usemap="#tbb::flow::interface6::sender< T >_map" border="0" alt=""></center>
  32. <map name="tbb::flow::interface6::sender< T >_map">
  33. <area href="a00274.html" alt="tbb::flow::interface6::broadcast_node< T >" shape="rect" coords="0,56,352,80">
  34. <area href="a00275.html" alt="tbb::flow::interface6::buffer_node< T, A >" shape="rect" coords="362,56,714,80">
  35. <area href="a00304.html" alt="tbb::flow::interface6::limiter_node< T >" shape="rect" coords="724,56,1076,80">
  36. <area href="a00324.html" alt="tbb::flow::interface6::priority_queue_node< T, Compare, A >" shape="rect" coords="181,112,533,136">
  37. <area href="a00325.html" alt="tbb::flow::interface6::queue_node< T, A >" shape="rect" coords="543,112,895,136">
  38. <area href="a00340.html" alt="tbb::flow::interface6::sequencer_node< T, A >" shape="rect" coords="543,168,895,192">
  39. </map>
  40. <a href="a00055.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  41. <tr><td></td></tr>
  42. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  43. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="127af99916cc085cd9dbc09c53299928"></a><!-- doxytag: member="tbb::flow::interface6::sender::output_type" ref="127af99916cc085cd9dbc09c53299928" args="" -->
  44. typedef T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#127af99916cc085cd9dbc09c53299928">output_type</a></td></tr>
  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The output type of this sender. <br></td></tr>
  46. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d690e8a54e358968f0ee4fdf9ee73068"></a><!-- doxytag: member="tbb::flow::interface6::sender::successor_type" ref="d690e8a54e358968f0ee4fdf9ee73068" args="" -->
  47. typedef <a class="el" href="a00333.html">receiver</a>&lt; T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#d690e8a54e358968f0ee4fdf9ee73068">successor_type</a></td></tr>
  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The successor type for this node. <br></td></tr>
  49. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68b8941ad77b9303cf3bcb8cf1f2d28a"></a><!-- doxytag: member="tbb::flow::interface6::sender::register_successor" ref="68b8941ad77b9303cf3bcb8cf1f2d28a" args="(successor_type &amp;r)=0" -->
  51. virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#68b8941ad77b9303cf3bcb8cf1f2d28a">register_successor</a> (<a class="el" href="a00333.html">successor_type</a> &amp;r)=0</td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a new successor to this node. <br></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82f363bfb1738bb8789e167590b10ef9"></a><!-- doxytag: member="tbb::flow::interface6::sender::remove_successor" ref="82f363bfb1738bb8789e167590b10ef9" args="(successor_type &amp;r)=0" -->
  54. virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#82f363bfb1738bb8789e167590b10ef9">remove_successor</a> (<a class="el" href="a00333.html">successor_type</a> &amp;r)=0</td></tr>
  55. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a successor from this node. <br></td></tr>
  56. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="922fb56b0aad090b90a98b7d56b76a59"></a><!-- doxytag: member="tbb::flow::interface6::sender::try_get" ref="922fb56b0aad090b90a98b7d56b76a59" args="(T &amp;)" -->
  57. virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#922fb56b0aad090b90a98b7d56b76a59">try_get</a> (T &amp;)</td></tr>
  58. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request an item from the sender. <br></td></tr>
  59. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02c05b472271db1b68a48ea2618fa72f"></a><!-- doxytag: member="tbb::flow::interface6::sender::try_reserve" ref="02c05b472271db1b68a48ea2618fa72f" args="(T &amp;)" -->
  60. virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#02c05b472271db1b68a48ea2618fa72f">try_reserve</a> (T &amp;)</td></tr>
  61. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reserves an item in the sender. <br></td></tr>
  62. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="27036b06d6a91e97007e14f400529199"></a><!-- doxytag: member="tbb::flow::interface6::sender::try_release" ref="27036b06d6a91e97007e14f400529199" args="()" -->
  63. virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#27036b06d6a91e97007e14f400529199">try_release</a> ()</td></tr>
  64. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases the reserved item. <br></td></tr>
  65. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b840f50da117a0d6848707c1857ea2e"></a><!-- doxytag: member="tbb::flow::interface6::sender::try_consume" ref="7b840f50da117a0d6848707c1857ea2e" args="()" -->
  66. virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00339.html#7b840f50da117a0d6848707c1857ea2e">try_consume</a> ()</td></tr>
  67. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Consumes the reserved item. <br></td></tr>
  68. </table>
  69. <hr><a name="_details"></a><h2>Detailed Description</h2>
  70. <h3>template&lt;typename T&gt;<br>
  71. class tbb::flow::interface6::sender&lt; T &gt;</h3>
  72. Pure virtual template class that defines a sender of messages of type T.
  73. <p>
  74. <hr>The documentation for this class was generated from the following file:<ul>
  75. <li><a class="el" href="a00385.html">flow_graph.h</a></ul>
  76. <hr>
  77. <p></p>
  78. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  79. <p></p>
  80. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  81. registered trademarks or trademarks of Intel Corporation or its
  82. subsidiaries in the United States and other countries.
  83. <p></p>
  84. * Other names and brands may be claimed as the property of others.