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.

125 lines
10 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.4"/>
  7. <title>tbb::flow::interface7::sender&lt; T &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <!-- end header part -->
  16. <!-- Generated by Doxygen 1.8.4 -->
  17. <div id="navrow1" class="tabs">
  18. <ul class="tablist">
  19. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  21. <li><a href="modules.html"><span>Modules</span></a></li>
  22. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  23. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  24. <li><a href="files.html"><span>Files</span></a></li>
  25. </ul>
  26. </div>
  27. <div id="navrow2" class="tabs2">
  28. <ul class="tablist">
  29. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  30. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  31. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  32. </ul>
  33. </div>
  34. <div id="nav-path" class="navpath">
  35. <ul>
  36. <li class="navelem"><a class="el" href="a00222.html">tbb</a></li><li class="navelem"><b>flow</b></li><li class="navelem"><b>interface7</b></li><li class="navelem"><a class="el" href="a00124.html">sender</a></li> </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#pub-types">Public Types</a> &#124;
  42. <a href="#pub-methods">Public Member Functions</a> &#124;
  43. <a href="a00308.html">List of all members</a> </div>
  44. <div class="headertitle">
  45. <div class="title">tbb::flow::interface7::sender&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <p>Pure virtual template class that defines a sender of messages of type T.
  49. <a href="a00124.html#details">More...</a></p>
  50. <p><code>#include &lt;flow_graph.h&gt;</code></p>
  51. <div class="dynheader">
  52. Inheritance diagram for tbb::flow::interface7::sender&lt; T &gt;:</div>
  53. <div class="dyncontent">
  54. <div class="center">
  55. <img src="a00124.png" usemap="#tbb::flow::interface7::sender&lt; T &gt;_map" alt=""/>
  56. <map id="tbb::flow::interface7::sender&lt; T &gt;_map" name="tbb::flow::interface7::sender&lt; T &gt;_map">
  57. <area href="a00025.html" title="Forwards messages of type T to all successors. " alt="tbb::flow::interface7::broadcast_node&lt; T &gt;" shape="rect" coords="0,56,352,80"/>
  58. <area href="a00027.html" title="Forwards messages in arbitrary order. " alt="tbb::flow::interface7::buffer_node&lt; T, A &gt;" shape="rect" coords="362,56,714,80"/>
  59. <area href="a00072.html" title="Forwards messages only if the threshold has not been reached. " alt="tbb::flow::interface7::limiter_node&lt; T &gt;" shape="rect" coords="724,56,1076,80"/>
  60. <area href="a00086.html" alt="tbb::flow::interface7::overwrite_node&lt; T &gt;" shape="rect" coords="1086,56,1438,80"/>
  61. <area href="a00091.html" title="Forwards messages in priority order. " alt="tbb::flow::interface7::priority_queue_node&lt; T, Compare, A &gt;" shape="rect" coords="181,112,533,136"/>
  62. <area href="a00092.html" title="Forwards messages in FIFO order. " alt="tbb::flow::interface7::queue_node&lt; T, A &gt;" shape="rect" coords="543,112,895,136"/>
  63. <area href="a00159.html" alt="tbb::flow::interface7::write_once_node&lt; T &gt;" shape="rect" coords="1086,112,1438,136"/>
  64. <area href="a00125.html" title="Forwards messages in sequence order. " alt="tbb::flow::interface7::sequencer_node&lt; T, A &gt;" shape="rect" coords="543,168,895,192"/>
  65. </map>
  66. </div></div>
  67. <table class="memberdecls">
  68. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  69. Public Types</h2></td></tr>
  70. <tr class="memitem:add86fddf72758d8e5b05b07650c6eeed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add86fddf72758d8e5b05b07650c6eeed"></a>
  71. typedef T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#add86fddf72758d8e5b05b07650c6eeed">output_type</a></td></tr>
  72. <tr class="memdesc:add86fddf72758d8e5b05b07650c6eeed"><td class="mdescLeft">&#160;</td><td class="mdescRight">The output type of this sender. <br/></td></tr>
  73. <tr class="separator:add86fddf72758d8e5b05b07650c6eeed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a7779627063a29d4d2a1fc905a5cae8db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7779627063a29d4d2a1fc905a5cae8db"></a>
  75. typedef <a class="el" href="a00106.html">receiver</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a7779627063a29d4d2a1fc905a5cae8db">successor_type</a></td></tr>
  76. <tr class="memdesc:a7779627063a29d4d2a1fc905a5cae8db"><td class="mdescLeft">&#160;</td><td class="mdescRight">The successor type for this node. <br/></td></tr>
  77. <tr class="separator:a7779627063a29d4d2a1fc905a5cae8db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table><table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:a4dac8f53a1f8373c1f3a874b9617e4ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4dac8f53a1f8373c1f3a874b9617e4ec"></a>
  82. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a4dac8f53a1f8373c1f3a874b9617e4ec">register_successor</a> (<a class="el" href="a00124.html#a7779627063a29d4d2a1fc905a5cae8db">successor_type</a> &amp;r)=0</td></tr>
  83. <tr class="memdesc:a4dac8f53a1f8373c1f3a874b9617e4ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new successor to this node. <br/></td></tr>
  84. <tr class="separator:a4dac8f53a1f8373c1f3a874b9617e4ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ac1ae19f49e31c6ca94dcf14732eb7a64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1ae19f49e31c6ca94dcf14732eb7a64"></a>
  86. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ac1ae19f49e31c6ca94dcf14732eb7a64">remove_successor</a> (<a class="el" href="a00124.html#a7779627063a29d4d2a1fc905a5cae8db">successor_type</a> &amp;r)=0</td></tr>
  87. <tr class="memdesc:ac1ae19f49e31c6ca94dcf14732eb7a64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a successor from this node. <br/></td></tr>
  88. <tr class="separator:ac1ae19f49e31c6ca94dcf14732eb7a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ad50b8ac93e79cbdcd2bba11d35432f2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad50b8ac93e79cbdcd2bba11d35432f2c"></a>
  90. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ad50b8ac93e79cbdcd2bba11d35432f2c">try_get</a> (T &amp;)</td></tr>
  91. <tr class="memdesc:ad50b8ac93e79cbdcd2bba11d35432f2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an item from the sender. <br/></td></tr>
  92. <tr class="separator:ad50b8ac93e79cbdcd2bba11d35432f2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:aa1b9dcf77ab558530ff93a706b4c4b5d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1b9dcf77ab558530ff93a706b4c4b5d"></a>
  94. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#aa1b9dcf77ab558530ff93a706b4c4b5d">try_reserve</a> (T &amp;)</td></tr>
  95. <tr class="memdesc:aa1b9dcf77ab558530ff93a706b4c4b5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserves an item in the sender. <br/></td></tr>
  96. <tr class="separator:aa1b9dcf77ab558530ff93a706b4c4b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a97ac316ddfb6bd7c7f2f56e3e819a30a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97ac316ddfb6bd7c7f2f56e3e819a30a"></a>
  98. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a97ac316ddfb6bd7c7f2f56e3e819a30a">try_release</a> ()</td></tr>
  99. <tr class="memdesc:a97ac316ddfb6bd7c7f2f56e3e819a30a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the reserved item. <br/></td></tr>
  100. <tr class="separator:a97ac316ddfb6bd7c7f2f56e3e819a30a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ad404d5218c7ae2556261ffa880cdf804"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad404d5218c7ae2556261ffa880cdf804"></a>
  102. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ad404d5218c7ae2556261ffa880cdf804">try_consume</a> ()</td></tr>
  103. <tr class="memdesc:ad404d5218c7ae2556261ffa880cdf804"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consumes the reserved item. <br/></td></tr>
  104. <tr class="separator:ad404d5218c7ae2556261ffa880cdf804"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table>
  106. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  107. <div class="textblock"><h3>template&lt;typename T&gt;<br/>
  108. class tbb::flow::interface7::sender&lt; T &gt;</h3>
  109. <p>Pure virtual template class that defines a sender of messages of type T. </p>
  110. </div><hr/>The documentation for this class was generated from the following file:<ul>
  111. <li><a class="el" href="a00179.html">flow_graph.h</a></li>
  112. </ul>
  113. </div><!-- contents -->
  114. <hr>
  115. <p></p>
  116. Copyright &copy; 2005-2014 Intel Corporation. All Rights Reserved.
  117. <p></p>
  118. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  119. registered trademarks or trademarks of Intel Corporation or its
  120. subsidiaries in the United States and other countries.
  121. <p></p>
  122. * Other names and brands may be claimed as the property of others.