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

structresumef_1_1switch__scheduler__awaitor.html 9.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  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: resumef::switch_scheduler_awaitor结构体 参考</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"><b>resumef</b></li><li class="navelem"><a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-static-methods">静态 Public 成员函数</a> &#124;
  68. <a href="structresumef_1_1switch__scheduler__awaitor-members.html">所有成员列表</a> </div>
  69. <div class="headertitle">
  70. <div class="title">resumef::switch_scheduler_awaitor结构体 参考</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>切换协程的可等待对象。
  74. <a href="structresumef_1_1switch__scheduler__awaitor.html#details">更多...</a></p>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  77. 静态 Public 成员函数</h2></td></tr>
  78. <tr class="memitem:ad895f4414bfb91fde51ac735420246a9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1switch__scheduler__awaitor.html#ad895f4414bfb91fde51ac735420246a9">via</a> (<a class="el" href="structresumef_1_1scheduler__t.html">scheduler_t</a> &amp;sch) noexcept</td></tr>
  79. <tr class="memdesc:ad895f4414bfb91fde51ac735420246a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">将本协程切换到指定调度器上运行。 <a href="structresumef_1_1switch__scheduler__awaitor.html#ad895f4414bfb91fde51ac735420246a9">更多...</a><br /></td></tr>
  80. <tr class="separator:ad895f4414bfb91fde51ac735420246a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a59f9ab7279d4aee22b69b93c86b209e7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1switch__scheduler__awaitor.html#a59f9ab7279d4aee22b69b93c86b209e7">via</a> (<a class="el" href="structresumef_1_1scheduler__t.html">scheduler_t</a> *sch) noexcept</td></tr>
  82. <tr class="memdesc:a59f9ab7279d4aee22b69b93c86b209e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">将本协程切换到指定调度器上运行。 <a href="structresumef_1_1switch__scheduler__awaitor.html#a59f9ab7279d4aee22b69b93c86b209e7">更多...</a><br /></td></tr>
  83. <tr class="separator:a59f9ab7279d4aee22b69b93c86b209e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
  86. <div class="textblock"><p>切换协程的可等待对象。 </p>
  87. </div><h2 class="groupheader">成员函数说明</h2>
  88. <a id="ad895f4414bfb91fde51ac735420246a9"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#ad895f4414bfb91fde51ac735420246a9">&#9670;&nbsp;</a></span>via() <span class="overload">[1/2]</span></h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="mlabels">
  93. <tr>
  94. <td class="mlabels-left">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">static <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> resumef::switch_scheduler_awaitor::via </td>
  98. <td>(</td>
  99. <td class="paramtype"><a class="el" href="structresumef_1_1scheduler__t.html">scheduler_t</a> &amp;&#160;</td>
  100. <td class="paramname"><em>sch</em></td><td>)</td>
  101. <td></td>
  102. </tr>
  103. </table>
  104. </td>
  105. <td class="mlabels-right">
  106. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p>将本协程切换到指定调度器上运行。 </p>
  111. <p>由于调度器必然在某个线程里运行,故达到了切换到特定线程里运行的目的。<br />
  112. 如果指定的协程就是本协程的调度器,则协程不暂停直接运行接下来的代码。 如果指定的协程不是本协程的调度器,则协程暂停后放入到目的协程的调度队列,等待下一次运行。 </p><dl class="params"><dt>参数</dt><dd>
  113. <table class="params">
  114. <tr><td class="paramname">sch</td><td>将要运行后续代码的协程 </td></tr>
  115. </table>
  116. </dd>
  117. </dl>
  118. <dl class="section return"><dt>返回</dt><dd>[co_await] void </dd></dl>
  119. <dl class="section note"><dt>注解</dt><dd>本函数是resumef名字空间下的全局函数。由于doxygen使用上的问题,将之归纳到 <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html" title="切换协程的可等待对象。">switch_scheduler_awaitor</a> 类下。 </dd></dl>
  120. </div>
  121. </div>
  122. <a id="a59f9ab7279d4aee22b69b93c86b209e7"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#a59f9ab7279d4aee22b69b93c86b209e7">&#9670;&nbsp;</a></span>via() <span class="overload">[2/2]</span></h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">static <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> resumef::switch_scheduler_awaitor::via </td>
  132. <td>(</td>
  133. <td class="paramtype"><a class="el" href="structresumef_1_1scheduler__t.html">scheduler_t</a> *&#160;</td>
  134. <td class="paramname"><em>sch</em></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>将本协程切换到指定调度器上运行。 </p>
  145. <p>由于调度器必然在某个线程里运行,故达到了切换到特定线程里运行的目的。<br />
  146. 如果指定的协程就是本协程的调度器,则协程不暂停直接运行接下来的代码。 如果指定的协程不是本协程的调度器,则协程暂停后放入到目的协程的调度队列,等待下一次运行。 </p><dl class="params"><dt>参数</dt><dd>
  147. <table class="params">
  148. <tr><td class="paramname">sch</td><td>将要运行后续代码的协程 </td></tr>
  149. </table>
  150. </dd>
  151. </dl>
  152. <dl class="section return"><dt>返回</dt><dd>[co_await] void </dd></dl>
  153. <dl class="section note"><dt>注解</dt><dd>本函数是resumef名字空间下的全局函数。由于doxygen使用上的问题,将之归纳到 <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html" title="切换协程的可等待对象。">switch_scheduler_awaitor</a> 类下。 </dd></dl>
  154. </div>
  155. </div>
  156. <hr/>该结构体的文档由以下文件生成:<ul>
  157. <li>librf/src/<a class="el" href="switch__scheduler_8h_source.html">switch_scheduler.h</a></li>
  158. </ul>
  159. </div><!-- contents -->
  160. <!-- start footer part -->
  161. <hr class="footer"/><address class="footer"><small>
  162. 制作者 &#160;<a href="http://www.doxygen.org/index.html">
  163. <img class="footer" src="doxygen.png" alt="doxygen"/>
  164. </a> 1.8.17
  165. </small></address>
  166. </body>
  167. </html>