基于C++ Coroutines提案 ‘Stackless Resumable Functions’编写的协程库
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.

channel__v2_8h_source.html 16KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>librf: librf/src/channel_v2.h 源文件</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">librf
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- 制作者 Doxygen 1.8.17 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'搜索');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','搜索');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_3c80010775d22af2067790ecc9cdcf9d.html">librf</a></li><li class="navelem"><a class="el" href="dir_54ae0e78d997f6903cdf0996223d047f.html">src</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">channel_v2.h</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
  71. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
  72. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="keyword">namespace </span>resumef</div>
  73. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;{</div>
  74. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  75. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">namespace </span>detail</div>
  76. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;{</div>
  77. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">class</span> _Ty, <span class="keyword">class</span> _Opty&gt;</div>
  78. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="keyword">struct </span>channel_impl_v2;</div>
  79. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;} <span class="comment">//namespace detail</span></div>
  80. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
  81. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">inline</span> <span class="keyword">namespace </span>channel_v2</div>
  82. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;{</div>
  83. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  84. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
  85. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">class</span> _Ty = <span class="keywordtype">bool</span>, <span class="keywordtype">bool</span> _Optional = !std::is_trivial_v&lt;_Ty&gt;, <span class="keywordtype">bool</span> _OptimizationThread = false&gt;</div>
  86. <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structresumef_1_1channel__t.html"> 25</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structresumef_1_1channel__t.html">channel_t</a></div>
  87. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {</div>
  88. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; static_assert((std::is_copy_constructible_v&lt;_Ty&gt;&amp;&amp; std::is_copy_assignable_v&lt;_Ty&gt;) ||</div>
  89. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; (std::is_move_constructible_v&lt;_Ty&gt; &amp;&amp; std::is_move_assignable_v&lt;_Ty&gt;));</div>
  90. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
  91. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">struct </span>[[nodiscard]] read_awaiter;</div>
  92. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">struct </span>[[nodiscard]] write_awaiter;</div>
  93. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
  94. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>(<span class="keywordtype">size_t</span> cache_size = 1);</div>
  95. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
  96. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">size_t</span> capacity() <span class="keyword">const</span> noexcept;</div>
  97. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
  98. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; read_awaiter <span class="keyword">operator</span> co_await() <span class="keyword">const</span> noexcept;</div>
  99. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
  100. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; read_awaiter read() <span class="keyword">const</span> noexcept;</div>
  101. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
  102. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">class </span>U</div>
  103. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  104. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; COMMA_RESUMEF_ENABLE_IF(std::is_constructible_v&lt;value_type, U&amp;&amp;&gt;)</div>
  105. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  106. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; &gt;</div>
  107. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  108. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; RESUMEF_REQUIRES(std::is_constructible_v&lt;_Ty, U&amp;&amp;&gt;)</div>
  109. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  110. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; write_awaiter operator &lt;&lt; (U&amp;&amp; val) <span class="keyword">const</span> noexcept(std::is_move_constructible_v&lt;U&gt;);</div>
  111. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
  112. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">class </span>U</div>
  113. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  114. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; COMMA_RESUMEF_ENABLE_IF(std::is_constructible_v&lt;value_type, U&amp;&amp;&gt;)</div>
  115. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  116. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; &gt;</div>
  117. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  118. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; RESUMEF_REQUIRES(std::is_constructible_v&lt;_Ty, U&amp;&amp;&gt;)</div>
  119. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  120. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; write_awaiter write(U&amp;&amp; val) <span class="keyword">const</span> noexcept(std::is_move_constructible_v&lt;U&gt;);</div>
  121. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
  122. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
  123. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  124. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">using</span> value_type = _Ty;</div>
  125. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
  126. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">static</span> constexpr <span class="keywordtype">bool</span> use_optional = _Optional;</div>
  127. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">static</span> constexpr <span class="keywordtype">bool</span> optimization_for_multithreading = _OptimizationThread;</div>
  128. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
  129. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">using</span> optional_type = std::conditional_t&lt;use_optional, std::optional&lt;value_type&gt;, value_type&gt;;</div>
  130. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">using</span> channel_type = detail::channel_impl_v2&lt;value_type, optional_type&gt;;</div>
  131. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">using</span> lock_type = <span class="keyword">typename</span> channel_type::lock_type;</div>
  132. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
  133. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>(<span class="keyword">const</span> <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&amp;) = <span class="keywordflow">default</span>;</div>
  134. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>(<a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
  135. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&amp; operator = (<span class="keyword">const</span> <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&amp;) = <span class="keywordflow">default</span>;</div>
  136. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&amp; operator = (<a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
  137. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">private</span>:</div>
  138. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; std::shared_ptr&lt;channel_type&gt; _chan;</div>
  139. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  140. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; };</div>
  141. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
  142. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
  143. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="preprocessor">#ifndef DOXYGEN_SKIP_PROPERTY</span></div>
  144. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="comment">//不支持channel_t&lt;void&gt;</span></div>
  145. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">template</span>&lt;<span class="keywordtype">bool</span> _Option, <span class="keywordtype">bool</span> _OptimizationThread&gt;</div>
  146. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keyword">struct </span><a class="code" href="structresumef_1_1channel__t.html">channel_t</a>&lt;void, _Option, _OptimizationThread&gt;</div>
  147. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; {</div>
  148. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; };</div>
  149. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  150. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
  151. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">using</span> semaphore_t = channel_t&lt;bool, false, true&gt;;</div>
  152. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
  153. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;} <span class="comment">//namespace channel_v2</span></div>
  154. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;} <span class="comment">//namespace resumef</span></div>
  155. </div><!-- fragment --></div><!-- contents -->
  156. <div class="ttc" id="astructresumef_1_1channel__t_html"><div class="ttname"><a href="structresumef_1_1channel__t.html">resumef::channel_t</a></div><div class="ttdoc">可传递数据的模板信号量。</div><div class="ttdef"><b>Definition:</b> channel_v2.h:25</div></div>
  157. <!-- start footer part -->
  158. <hr class="footer"/><address class="footer"><small>
  159. 制作者 &#160;<a href="http://www.doxygen.org/index.html">
  160. <img class="footer" src="doxygen.png" alt="doxygen"/>
  161. </a> 1.8.17
  162. </small></address>
  163. </body>
  164. </html>