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

yield_8h_source.html 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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/yield.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">yield.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_1yield__awaitor.html"> 8</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structresumef_1_1yield__awaitor.html">yield_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; <span class="keywordtype">bool</span> await_ready() <span class="keyword">const</span> noexcept</div>
  82. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {</div>
  83. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
  84. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; }</div>
  85. <div class="line"><a name="l00019"></a><span class="lineno"> 19</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>
  86. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordtype">bool</span> await_suspend(coroutine_handle&lt;_PromiseT&gt; handler)</div>
  87. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; {</div>
  88. <div class="line"><a name="l00022"></a><span class="lineno"> 22</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>
  89. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; _state-&gt;set_value();</div>
  90. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; _state-&gt;future_await_suspend(handler);</div>
  91. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  92. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</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="keywordtype">void</span> await_resume() <span class="keyword">const</span> noexcept</div>
  95. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</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; </div>
  98. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#ifdef DOXYGEN_SKIP_PROPERTY</span></div>
  99. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
  100. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> <a class="code" href="structresumef_1_1yield__awaitor.html">yield_awaitor</a> <a class="code" href="structresumef_1_1yield__awaitor.html#a25aa400aefa4bb8c2b61a190b0a7cdda">yield</a>() noexcept;</div>
  101. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#endif //DOXYGEN_SKIP_PROPERTY</span></div>
  102. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; };</div>
  103. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
  104. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">inline</span> <a class="code" href="structresumef_1_1yield__awaitor.html">yield_awaitor</a> yield() noexcept</div>
  105. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
  106. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> {};</div>
  107. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
  108. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
  109. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
  110. </div><!-- fragment --></div><!-- contents -->
  111. <div class="ttc" id="astructresumef_1_1yield__awaitor_html"><div class="ttname"><a href="structresumef_1_1yield__awaitor.html">resumef::yield_awaitor</a></div><div class="ttdoc">将本协程让渡出一次调用的可等待对象。</div><div class="ttdef"><b>Definition:</b> yield.h:8</div></div>
  112. <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>
  113. <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>
  114. <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>
  115. <div class="ttc" id="astructresumef_1_1yield__awaitor_html_a25aa400aefa4bb8c2b61a190b0a7cdda"><div class="ttname"><a href="structresumef_1_1yield__awaitor.html#a25aa400aefa4bb8c2b61a190b0a7cdda">resumef::yield_awaitor::yield</a></div><div class="ttdeci">static yield_awaitor yield() noexcept</div><div class="ttdoc">将本协程让渡出一次调用的可等待对象。</div></div>
  116. <!-- start footer part -->
  117. <hr class="footer"/><address class="footer"><small>
  118. 制作者 &#160;<a href="http://www.doxygen.org/index.html">
  119. <img class="footer" src="doxygen.png" alt="doxygen"/>
  120. </a> 1.8.17
  121. </small></address>
  122. </body>
  123. </html>