基于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.

switch__scheduler_8h_source.html 16KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  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/switch_scheduler.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">switch_scheduler.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="l00008"></a><span class="lineno"><a class="line" href="structresumef_1_1switch__scheduler__awaitor.html"> 8</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a></div>
  75. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; {</div>
  76. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">using</span> value_type = void;</div>
  77. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keyword">using</span> <a class="code" href="structresumef_1_1state__t.html">state_type</a> = <a class="code" href="structresumef_1_1state__t.html">state_t&lt;value_type&gt;</a>;</div>
  78. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">using</span> promise_type = promise_t&lt;value_type&gt;;</div>
  79. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">using</span> lock_type = <span class="keyword">typename</span> <a class="code" href="structresumef_1_1spinlock.html">state_type::lock_type</a>;</div>
  80. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
  81. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>(<a class="code" href="structresumef_1_1scheduler__t.html">scheduler_t</a>* sch)</div>
  82. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; :_scheduler(sch) {}</div>
  83. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>(<span class="keyword">const</span> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&amp;) = <span class="keywordflow">default</span>;</div>
  84. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>(<a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
  85. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
  86. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&amp; operator = (<span class="keyword">const</span> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&amp;) = <span class="keywordflow">default</span>;</div>
  87. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&amp; operator = (<a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
  88. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
  89. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordtype">bool</span> await_ready() noexcept</div>
  90. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; {</div>
  91. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  92. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; }</div>
  93. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
  94. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">class</span> _PromiseT, <span class="keyword">typename</span> = std::enable_if_t&lt;traits::is_promise_v&lt;_PromiseT&gt;&gt;&gt;</div>
  95. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">bool</span> await_suspend(coroutine_handle&lt;_PromiseT&gt; handler)</div>
  96. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
  97. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; _PromiseT&amp; promise = handler.promise();</div>
  98. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">auto</span>* sptr = promise.get_state();</div>
  99. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">if</span> (sptr-&gt;switch_scheduler_await_suspend(_scheduler))</div>
  100. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
  101. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="structresumef_1_1counted__ptr.html">counted_ptr&lt;state_t&lt;void&gt;</a>&gt; _state = state_future_t::_Alloc_state&lt;state_type&gt;(<span class="keyword">true</span>);</div>
  102. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; _state-&gt;set_value();</div>
  103. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; _state-&gt;future_await_suspend(handler);</div>
  104. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
  105. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
  106. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div>
  107. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  108. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div>
  109. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
  110. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> await_resume() noexcept</div>
  111. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div>
  112. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div>
  113. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
  114. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">private</span>:</div>
  115. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="structresumef_1_1scheduler__t.html">scheduler_t</a>* _scheduler;</div>
  116. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#ifdef DOXYGEN_SKIP_PROPERTY</span></div>
  117. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">public</span>:</div>
  118. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">static</span> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html#ad895f4414bfb91fde51ac735420246a9">via</a>(<a class="code" href="structresumef_1_1scheduler__t.html">scheduler_t</a>&amp; sch) noexcept;</div>
  119. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
  120. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">static</span> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html#ad895f4414bfb91fde51ac735420246a9">via</a>(<a class="code" href="structresumef_1_1scheduler__t.html">scheduler_t</a>* sch) noexcept;</div>
  121. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  122. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; };</div>
  123. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
  124. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">//由于跟when_all/when_any混用的时候,在clang上编译失败:</span></div>
  125. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">//clang把scheduler_t判断成一个is_awaitable,且放弃选择when_all/any(scheduler_t&amp; sch, ...)版本</span></div>
  126. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">//故放弃这种用法</span></div>
  127. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">//inline switch_scheduler_awaitor operator co_await(scheduler_t&amp; sch) noexcept</span></div>
  128. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="comment">//{</span></div>
  129. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">// return { &amp;sch };</span></div>
  130. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="comment">//}</span></div>
  131. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
  132. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">inline</span> <a class="code" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> via(<a class="code" href="structresumef_1_1scheduler__t.html">scheduler_t</a>&amp; sch) noexcept</div>
  133. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div>
  134. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> { &amp;sch };</div>
  135. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div>
  136. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
  137. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">inline</span> switch_scheduler_awaitor via(scheduler_t* sch) noexcept</div>
  138. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {</div>
  139. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> { sch };</div>
  140. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
  141. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
  142. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;}</div>
  143. </div><!-- fragment --></div><!-- contents -->
  144. <div class="ttc" id="astructresumef_1_1scheduler__t_html"><div class="ttname"><a href="structresumef_1_1scheduler__t.html">resumef::scheduler_t</a></div><div class="ttdoc">协程调度器。</div><div class="ttdef"><b>Definition:</b> scheduler.h:10</div></div>
  145. <div class="ttc" id="astructresumef_1_1counted__ptr_html"><div class="ttname"><a href="structresumef_1_1counted__ptr.html">resumef::counted_ptr</a></div><div class="ttdoc">专用与state的智能计数指针,通过管理state内嵌的引用计数来管理state的生存期。</div><div class="ttdef"><b>Definition:</b> counted_ptr.h:9</div></div>
  146. <div class="ttc" id="astructresumef_1_1spinlock_html"><div class="ttname"><a href="structresumef_1_1spinlock.html">resumef::spinlock</a></div><div class="ttdoc">一个自旋锁实现。</div><div class="ttdef"><b>Definition:</b> spinlock.h:14</div></div>
  147. <div class="ttc" id="astructresumef_1_1switch__scheduler__awaitor_html_ad895f4414bfb91fde51ac735420246a9"><div class="ttname"><a href="structresumef_1_1switch__scheduler__awaitor.html#ad895f4414bfb91fde51ac735420246a9">resumef::switch_scheduler_awaitor::via</a></div><div class="ttdeci">static switch_scheduler_awaitor via(scheduler_t &amp;sch) noexcept</div><div class="ttdoc">将本协程切换到指定调度器上运行。</div></div>
  148. <div class="ttc" id="astructresumef_1_1state__t_html"><div class="ttname"><a href="structresumef_1_1state__t.html">resumef::state_t</a></div><div class="ttdoc">专用于future_t&lt;&gt;的state类。</div><div class="ttdef"><b>Definition:</b> state.h:217</div></div>
  149. <div class="ttc" id="astructresumef_1_1switch__scheduler__awaitor_html"><div class="ttname"><a href="structresumef_1_1switch__scheduler__awaitor.html">resumef::switch_scheduler_awaitor</a></div><div class="ttdoc">切换协程的可等待对象。</div><div class="ttdef"><b>Definition:</b> switch_scheduler.h:8</div></div>
  150. <!-- start footer part -->
  151. <hr class="footer"/><address class="footer"><small>
  152. 制作者 &#160;<a href="http://www.doxygen.org/index.html">
  153. <img class="footer" src="doxygen.png" alt="doxygen"/>
  154. </a> 1.8.17
  155. </small></address>
  156. </body>
  157. </html>