基于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_1event__t.html 20KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415
  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::event_t结构体 参考</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_1event__t.html">event_t</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-methods">Public 成员函数</a> &#124;
  68. <a href="structresumef_1_1event__t-members.html">所有成员列表</a> </div>
  69. <div class="headertitle">
  70. <div class="title">resumef::event_t结构体 参考</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>用于协程的事件。
  74. <a href="structresumef_1_1event__t.html#details">更多...</a></p>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  77. Public 成员函数</h2></td></tr>
  78. <tr class="memitem:a5ae54675783d984c3defd7b2093c91a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#a5ae54675783d984c3defd7b2093c91a1">event_t</a> (bool initially=false)</td></tr>
  79. <tr class="memdesc:a5ae54675783d984c3defd7b2093c91a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">构造一个事件。 <a href="structresumef_1_1event__t.html#a5ae54675783d984c3defd7b2093c91a1">更多...</a><br /></td></tr>
  80. <tr class="separator:a5ae54675783d984c3defd7b2093c91a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ab3a49adfb8c1cfcfa606cca3148f946a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#ab3a49adfb8c1cfcfa606cca3148f946a">event_t</a> (std::adopt_lock_t)</td></tr>
  82. <tr class="memdesc:ab3a49adfb8c1cfcfa606cca3148f946a"><td class="mdescLeft">&#160;</td><td class="mdescRight">构造一个无效的事件。 <a href="structresumef_1_1event__t.html#ab3a49adfb8c1cfcfa606cca3148f946a">更多...</a><br /></td></tr>
  83. <tr class="separator:ab3a49adfb8c1cfcfa606cca3148f946a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:af742aa0454758c3def349cacae86c229"><td class="memItemLeft" align="right" valign="top"><a id="af742aa0454758c3def349cacae86c229"></a>
  85. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#af742aa0454758c3def349cacae86c229">~event_t</a> ()</td></tr>
  86. <tr class="memdesc:af742aa0454758c3def349cacae86c229"><td class="mdescLeft">&#160;</td><td class="mdescRight">采用shared_ptr&lt;&gt;来保存内部的事件实现。故不必担心正在被等待的协程,因为事件提前销毁而出现异常。 <br /></td></tr>
  87. <tr class="separator:af742aa0454758c3def349cacae86c229"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aac7bf6f81982126225125354769ad695"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#aac7bf6f81982126225125354769ad695">signal_all</a> () const noexcept</td></tr>
  89. <tr class="memdesc:aac7bf6f81982126225125354769ad695"><td class="mdescLeft">&#160;</td><td class="mdescRight">向所有正在等待的协程触发一次信号。 <a href="structresumef_1_1event__t.html#aac7bf6f81982126225125354769ad695">更多...</a><br /></td></tr>
  90. <tr class="separator:aac7bf6f81982126225125354769ad695"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ab9500bb2438c27adb4b34988eaa04ff9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#ab9500bb2438c27adb4b34988eaa04ff9">signal</a> () const noexcept</td></tr>
  92. <tr class="memdesc:ab9500bb2438c27adb4b34988eaa04ff9"><td class="mdescLeft">&#160;</td><td class="mdescRight">触发一次信号。 <a href="structresumef_1_1event__t.html#ab9500bb2438c27adb4b34988eaa04ff9">更多...</a><br /></td></tr>
  93. <tr class="separator:ab9500bb2438c27adb4b34988eaa04ff9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a8da187ffff9c6aee7e9bad6d97af9f4a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#a8da187ffff9c6aee7e9bad6d97af9f4a">reset</a> () const noexcept</td></tr>
  95. <tr class="memdesc:a8da187ffff9c6aee7e9bad6d97af9f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">重置信号。 <a href="structresumef_1_1event__t.html#a8da187ffff9c6aee7e9bad6d97af9f4a">更多...</a><br /></td></tr>
  96. <tr class="separator:a8da187ffff9c6aee7e9bad6d97af9f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a9656c785d3c1c1d57560137894aa1be3"><td class="memItemLeft" align="right" valign="top">awaiter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#a9656c785d3c1c1d57560137894aa1be3">operator co_await</a> () const noexcept</td></tr>
  98. <tr class="memdesc:a9656c785d3c1c1d57560137894aa1be3"><td class="mdescLeft">&#160;</td><td class="mdescRight">在协程中等待信号触发。 <a href="structresumef_1_1event__t.html#a9656c785d3c1c1d57560137894aa1be3">更多...</a><br /></td></tr>
  99. <tr class="separator:a9656c785d3c1c1d57560137894aa1be3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a1231525d8406b1f69b563e84dc7fead7"><td class="memItemLeft" align="right" valign="top">awaiter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#a1231525d8406b1f69b563e84dc7fead7">wait</a> () const noexcept</td></tr>
  101. <tr class="memdesc:a1231525d8406b1f69b563e84dc7fead7"><td class="mdescLeft">&#160;</td><td class="mdescRight">在协程中等待信号触发。 <a href="structresumef_1_1event__t.html#a1231525d8406b1f69b563e84dc7fead7">更多...</a><br /></td></tr>
  102. <tr class="separator:a1231525d8406b1f69b563e84dc7fead7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ac3d2ceb787ca321855731e40646d4112"><td class="memTemplParams" colspan="2">template&lt;class _Rep , class _Period &gt; </td></tr>
  104. <tr class="memitem:ac3d2ceb787ca321855731e40646d4112"><td class="memTemplItemLeft" align="right" valign="top">timeout_awaiter&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#ac3d2ceb787ca321855731e40646d4112">wait_for</a> (const std::chrono::duration&lt; _Rep, _Period &gt; &amp;dt) const noexcept</td></tr>
  105. <tr class="memdesc:ac3d2ceb787ca321855731e40646d4112"><td class="mdescLeft">&#160;</td><td class="mdescRight">在协程中等待信号触发,直到超时。 <a href="structresumef_1_1event__t.html#ac3d2ceb787ca321855731e40646d4112">更多...</a><br /></td></tr>
  106. <tr class="separator:ac3d2ceb787ca321855731e40646d4112"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a083cda88807a10c4f68b134ce32c597b"><td class="memTemplParams" colspan="2">template&lt;class _Clock , class _Duration &gt; </td></tr>
  108. <tr class="memitem:a083cda88807a10c4f68b134ce32c597b"><td class="memTemplItemLeft" align="right" valign="top">timeout_awaiter&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structresumef_1_1event__t.html#a083cda88807a10c4f68b134ce32c597b">wait_until</a> (const std::chrono::time_point&lt; _Clock, _Duration &gt; &amp;tp) const noexcept</td></tr>
  109. <tr class="memdesc:a083cda88807a10c4f68b134ce32c597b"><td class="mdescLeft">&#160;</td><td class="mdescRight">在协程中等待信号触发,直到超时。 <a href="structresumef_1_1event__t.html#a083cda88807a10c4f68b134ce32c597b">更多...</a><br /></td></tr>
  110. <tr class="separator:a083cda88807a10c4f68b134ce32c597b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
  113. <div class="textblock"><p>用于协程的事件。 </p>
  114. <p>用于同步不同线程里运行的协程。 </p>
  115. </div><h2 class="groupheader">构造及析构函数说明</h2>
  116. <a id="a5ae54675783d984c3defd7b2093c91a1"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#a5ae54675783d984c3defd7b2093c91a1">&#9670;&nbsp;</a></span>event_t() <span class="overload">[1/2]</span></h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">resumef::event_t::event_t </td>
  123. <td>(</td>
  124. <td class="paramtype">bool&#160;</td>
  125. <td class="paramname"><em>initially</em> = <code>false</code></td><td>)</td>
  126. <td></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>构造一个事件。 </p>
  131. <dl class="params"><dt>参数</dt><dd>
  132. <table class="params">
  133. <tr><td class="paramname">initially</td><td>初始是否触发一次信号。 </td></tr>
  134. </table>
  135. </dd>
  136. </dl>
  137. </div>
  138. </div>
  139. <a id="ab3a49adfb8c1cfcfa606cca3148f946a"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#ab3a49adfb8c1cfcfa606cca3148f946a">&#9670;&nbsp;</a></span>event_t() <span class="overload">[2/2]</span></h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">resumef::event_t::event_t </td>
  146. <td>(</td>
  147. <td class="paramtype">std::adopt_lock_t&#160;</td>
  148. <td class="paramname"></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>构造一个无效的事件。 </p>
  154. <p>如果用于后续保存另外一个事件,则应当使用此构造函数,便于节省一次不必要的内部初始化。 </p>
  155. </div>
  156. </div>
  157. <h2 class="groupheader">成员函数说明</h2>
  158. <a id="a9656c785d3c1c1d57560137894aa1be3"></a>
  159. <h2 class="memtitle"><span class="permalink"><a href="#a9656c785d3c1c1d57560137894aa1be3">&#9670;&nbsp;</a></span>operator co_await()</h2>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="mlabels">
  163. <tr>
  164. <td class="mlabels-left">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">awaiter resumef::event_t::operator co_await </td>
  168. <td>(</td>
  169. <td class="paramname"></td><td>)</td>
  170. <td> const</td>
  171. </tr>
  172. </table>
  173. </td>
  174. <td class="mlabels-right">
  175. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>在协程中等待信号触发。 </p>
  180. <dl class="section see"><dt>参见</dt><dd>等同于co_await <a class="el" href="structresumef_1_1event__t.html#a1231525d8406b1f69b563e84dc7fead7" title="在协程中等待信号触发。">wait()</a>。 </dd></dl>
  181. <dl class="section attention"><dt>注意</dt><dd>只能在协程中调用。 </dd></dl>
  182. </div>
  183. </div>
  184. <a id="a8da187ffff9c6aee7e9bad6d97af9f4a"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#a8da187ffff9c6aee7e9bad6d97af9f4a">&#9670;&nbsp;</a></span>reset()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">void resumef::event_t::reset </td>
  194. <td>(</td>
  195. <td class="paramname"></td><td>)</td>
  196. <td> const</td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>重置信号。 </p>
  206. <dl class="section attention"><dt>注意</dt><dd>非协程中也可以使用。 </dd></dl>
  207. </div>
  208. </div>
  209. <a id="ab9500bb2438c27adb4b34988eaa04ff9"></a>
  210. <h2 class="memtitle"><span class="permalink"><a href="#ab9500bb2438c27adb4b34988eaa04ff9">&#9670;&nbsp;</a></span>signal()</h2>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="mlabels">
  214. <tr>
  215. <td class="mlabels-left">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">void resumef::event_t::signal </td>
  219. <td>(</td>
  220. <td class="paramname"></td><td>)</td>
  221. <td> const</td>
  222. </tr>
  223. </table>
  224. </td>
  225. <td class="mlabels-right">
  226. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>触发一次信号。 </p>
  231. <p>如果有正在等待的协程,则最先等待的协程会被唤醒。<br />
  232. 如果没有正在等待的协程,则信号触发次数加一。之后有协程调用wait(),则会直接返回。 </p><dl class="section attention"><dt>注意</dt><dd>非协程中也可以使用。 </dd></dl>
  233. </div>
  234. </div>
  235. <a id="aac7bf6f81982126225125354769ad695"></a>
  236. <h2 class="memtitle"><span class="permalink"><a href="#aac7bf6f81982126225125354769ad695">&#9670;&nbsp;</a></span>signal_all()</h2>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="mlabels">
  240. <tr>
  241. <td class="mlabels-left">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">void resumef::event_t::signal_all </td>
  245. <td>(</td>
  246. <td class="paramname"></td><td>)</td>
  247. <td> const</td>
  248. </tr>
  249. </table>
  250. </td>
  251. <td class="mlabels-right">
  252. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>向所有正在等待的协程触发一次信号。 </p>
  257. <dl class="section attention"><dt>注意</dt><dd>非协程中也可以使用。 </dd></dl>
  258. </div>
  259. </div>
  260. <a id="a1231525d8406b1f69b563e84dc7fead7"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#a1231525d8406b1f69b563e84dc7fead7">&#9670;&nbsp;</a></span>wait()</h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">awaiter resumef::event_t::wait </td>
  270. <td>(</td>
  271. <td class="paramname"></td><td>)</td>
  272. <td> const</td>
  273. </tr>
  274. </table>
  275. </td>
  276. <td class="mlabels-right">
  277. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>在协程中等待信号触发。 </p>
  282. <p>如果信号已经触发,则立即返回true。<br />
  283. 否则,当前协程被阻塞,直到信号被触发后唤醒。 消耗一次信号触发次数。 </p><dl class="retval"><dt>返回值</dt><dd>
  284. <table class="retval">
  285. <tr><td class="paramname">bool</td><td>[co_await] 返回是否等到了信号 </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. <dl class="section attention"><dt>注意</dt><dd>只能在协程中调用。 </dd></dl>
  290. </div>
  291. </div>
  292. <a id="ac3d2ceb787ca321855731e40646d4112"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#ac3d2ceb787ca321855731e40646d4112">&#9670;&nbsp;</a></span>wait_for()</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <div class="memtemplate">
  297. template&lt;class _Rep , class _Period &gt; </div>
  298. <table class="mlabels">
  299. <tr>
  300. <td class="mlabels-left">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname">timeout_awaiter resumef::event_t::wait_for </td>
  304. <td>(</td>
  305. <td class="paramtype">const std::chrono::duration&lt; _Rep, _Period &gt; &amp;&#160;</td>
  306. <td class="paramname"><em>dt</em></td><td>)</td>
  307. <td> const</td>
  308. </tr>
  309. </table>
  310. </td>
  311. <td class="mlabels-right">
  312. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>在协程中等待信号触发,直到超时。 </p>
  317. <p>如果信号已经触发,则立即返回true。<br />
  318. 否则,当前协程被阻塞,直到信号被触发后,或者超时后唤醒。 如果等到了信号,则消耗一次信号触发次数。 </p><dl class="params"><dt>参数</dt><dd>
  319. <table class="params">
  320. <tr><td class="paramname">dt</td><td>超时时长 </td></tr>
  321. </table>
  322. </dd>
  323. </dl>
  324. <dl class="retval"><dt>返回值</dt><dd>
  325. <table class="retval">
  326. <tr><td class="paramname">bool</td><td>[co_await] 等到了信号返回true,超时了返回false。 </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section attention"><dt>注意</dt><dd>只能在协程中调用。 </dd></dl>
  331. </div>
  332. </div>
  333. <a id="a083cda88807a10c4f68b134ce32c597b"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#a083cda88807a10c4f68b134ce32c597b">&#9670;&nbsp;</a></span>wait_until()</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <div class="memtemplate">
  338. template&lt;class _Clock , class _Duration &gt; </div>
  339. <table class="mlabels">
  340. <tr>
  341. <td class="mlabels-left">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">timeout_awaiter resumef::event_t::wait_until </td>
  345. <td>(</td>
  346. <td class="paramtype">const std::chrono::time_point&lt; _Clock, _Duration &gt; &amp;&#160;</td>
  347. <td class="paramname"><em>tp</em></td><td>)</td>
  348. <td> const</td>
  349. </tr>
  350. </table>
  351. </td>
  352. <td class="mlabels-right">
  353. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>在协程中等待信号触发,直到超时。 </p>
  358. <p>如果信号已经触发,则立即返回true。<br />
  359. 否则,当前协程被阻塞,直到信号被触发后,或者超时后唤醒。 如果等到了信号,则消耗一次信号触发次数。 </p><dl class="params"><dt>参数</dt><dd>
  360. <table class="params">
  361. <tr><td class="paramname">tp</td><td>超时时刻 </td></tr>
  362. </table>
  363. </dd>
  364. </dl>
  365. <dl class="retval"><dt>返回值</dt><dd>
  366. <table class="retval">
  367. <tr><td class="paramname">bool</td><td>[co_await] 等到了信号返回true,超时了返回false。 </td></tr>
  368. </table>
  369. </dd>
  370. </dl>
  371. <dl class="section attention"><dt>注意</dt><dd>只能在协程中调用。 </dd></dl>
  372. </div>
  373. </div>
  374. <hr/>该结构体的文档由以下文件生成:<ul>
  375. <li>librf/src/<a class="el" href="event__v2_8h_source.html">event_v2.h</a></li>
  376. </ul>
  377. </div><!-- contents -->
  378. <!-- start footer part -->
  379. <hr class="footer"/><address class="footer"><small>
  380. 制作者 &#160;<a href="http://www.doxygen.org/index.html">
  381. <img class="footer" src="doxygen.png" alt="doxygen"/>
  382. </a> 1.8.17
  383. </small></address>
  384. </body>
  385. </html>