1
0
mirror of https://github.com/tearshark/librf.git synced 2024-10-02 00:00:11 +08:00
librf/doxygen/html/structresumef_1_1switch__scheduler__awaitor.html
tearshark cd74eea532 完善文档。
上传Doxygen生成的文档。
2020-03-31 15:30:45 +08:00

177 lines
9.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>librf: resumef::switch_scheduler_awaitor结构体 参考</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">librf
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'搜索');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','搜索');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">静态 Public 成员函数</a> &#124;
<a href="structresumef_1_1switch__scheduler__awaitor-members.html">所有成员列表</a> </div>
<div class="headertitle">
<div class="title">resumef::switch_scheduler_awaitor结构体 参考</div> </div>
</div><!--header-->
<div class="contents">
<p>切换协程的可等待对象。
<a href="structresumef_1_1switch__scheduler__awaitor.html#details">更多...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
静态 Public 成员函数</h2></td></tr>
<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>
<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>
<tr class="separator:ad895f4414bfb91fde51ac735420246a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a59f9ab7279d4aee22b69b93c86b209e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
<div class="textblock"><p>切换协程的可等待对象。 </p>
</div><h2 class="groupheader">成员函数说明</h2>
<a id="ad895f4414bfb91fde51ac735420246a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad895f4414bfb91fde51ac735420246a9">&#9670;&nbsp;</a></span>via() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> resumef::switch_scheduler_awaitor::via </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structresumef_1_1scheduler__t.html">scheduler_t</a> &amp;&#160;</td>
<td class="paramname"><em>sch</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>将本协程切换到指定调度器上运行。 </p>
<p>由于调度器必然在某个线程里运行,故达到了切换到特定线程里运行的目的。<br />
如果指定的协程就是本协程的调度器,则协程不暂停直接运行接下来的代码。 如果指定的协程不是本协程的调度器,则协程暂停后放入到目的协程的调度队列,等待下一次运行。 </p><dl class="params"><dt>参数</dt><dd>
<table class="params">
<tr><td class="paramname">sch</td><td>将要运行后续代码的协程 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>返回</dt><dd>[co_await] void </dd></dl>
<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>
</div>
</div>
<a id="a59f9ab7279d4aee22b69b93c86b209e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59f9ab7279d4aee22b69b93c86b209e7">&#9670;&nbsp;</a></span>via() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structresumef_1_1switch__scheduler__awaitor.html">switch_scheduler_awaitor</a> resumef::switch_scheduler_awaitor::via </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structresumef_1_1scheduler__t.html">scheduler_t</a> *&#160;</td>
<td class="paramname"><em>sch</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>将本协程切换到指定调度器上运行。 </p>
<p>由于调度器必然在某个线程里运行,故达到了切换到特定线程里运行的目的。<br />
如果指定的协程就是本协程的调度器,则协程不暂停直接运行接下来的代码。 如果指定的协程不是本协程的调度器,则协程暂停后放入到目的协程的调度队列,等待下一次运行。 </p><dl class="params"><dt>参数</dt><dd>
<table class="params">
<tr><td class="paramname">sch</td><td>将要运行后续代码的协程 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>返回</dt><dd>[co_await] void </dd></dl>
<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>
</div>
</div>
<hr/>该结构体的文档由以下文件生成:<ul>
<li>librf/src/<a class="el" href="switch__scheduler_8h_source.html">switch_scheduler.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
制作者 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>