abby/librf
1
0
Fork 0
mirror of https://github.com/tearshark/librf.git synced 2024-10-01 15:57:07 +08:00
Code Issues Releases Wiki Activity
b0b9934845
librf/doxygen/html/annotated.html

115 lines
14 KiB
HTML
Raw Normal View History

完善文档。 上传Doxygen生成的文档。
2020-03-31 15:30:45 +08:00
<!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: 类列表</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">类列表</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">这里列出了所有类、结构、联合以及接口定义等，并附带简要说明:</div><div class="directory">
<div class="levels">[详情级别 <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>asio</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classasio_1_1rf__task__t.html" target="_self">rf_task_t</a></td><td class="desc">用于指示asio相关异步函数，返回resumef::future_t&lt;&gt;的类型，从而变成支持 librf 的协程函数。 </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>resumef</b></td><td class="desc"></td></tr>
<tr id="row_1_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_1_0_" class="arrow" onclick="toggleFolder('1_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>detail</b></td><td class="desc"></td></tr>
<tr id="row_1_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1detail_1_1timer__target.html" target="_self">timer_target</a></td><td class="desc">定时器对象。 </td></tr>
<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1adopt__manual__unlock__t.html" target="_self">adopt_manual_unlock_t</a></td><td class="desc">提示手工解锁，故相关的lock()函数不再返回batch_unlock_t。 </td></tr>
<tr id="row_1_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1awaitable__impl__t.html" target="_self">awaitable_impl_t</a></td><td class="desc">Awaitable_t&lt;&gt;的公共实现部分，用于减少awaitable_t&lt;&gt;的重复代码。 </td></tr>
<tr id="row_1_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1awaitable__t.html" target="_self">awaitable_t</a></td><td class="desc">用于包装‘异步函数’为‘可等待函数(awaitable function)’。 </td></tr>
<tr id="row_1_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classresumef_1_1batch__lock__t.html" target="_self">batch_lock_t</a></td><td class="desc">无死锁的批量枷锁。 </td></tr>
<tr id="row_1_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1batch__unlock__t.html" target="_self">batch_unlock_t</a></td><td class="desc">在析构的时候自动解锁mutex_t的辅助类。 </td></tr>
<tr id="row_1_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1channel__exception.html" target="_self">channel_exception</a></td><td class="desc">错误使用channel_t时产生的异常(v2版本已经不再抛此异常了）。 </td></tr>
<tr id="row_1_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1channel__t.html" target="_self">channel_t</a></td><td class="desc">可传递数据的模板信号量。 </td></tr>
<tr id="row_1_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1counted__ptr.html" target="_self">counted_ptr</a></td><td class="desc">专用与state的智能计数指针，通过管理state内嵌的引用计数来管理state的生存期。 </td></tr>
<tr id="row_1_9_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1event__t.html" target="_self">event_t</a></td><td class="desc">用于协程的事件。 </td></tr>
<tr id="row_1_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1future__t.html" target="_self">future_t</a></td><td class="desc">用于resumef协程的返回值。 </td></tr>
<tr id="row_1_11_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1generator__t.html" target="_self">generator_t</a></td><td class="desc">专用于co_yield函数。 </td></tr>
<tr id="row_1_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1get__current__scheduler__awaitor.html" target="_self">get_current_scheduler_awaitor</a></td><td class="desc">获得本协程绑定的调度器的可等待对象。 </td></tr>
<tr id="row_1_13_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1get__root__state__awaitor.html" target="_self">get_root_state_awaitor</a></td><td class="desc">获得本协程绑定的跟state指针的可等待对象。 </td></tr>
<tr id="row_1_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1local__scheduler__t.html" target="_self">local_scheduler_t</a></td><td class="desc">创建一个线程相关的调度器。 </td></tr>
<tr id="row_1_15_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1mutex__exception.html" target="_self">mutex_exception</a></td><td class="desc">错误使用mutex_t时产生的异常。 </td></tr>
<tr id="row_1_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1mutex__t.html" target="_self">mutex_t</a></td><td class="desc">支持递归的锁。 </td></tr>
<tr id="row_1_17_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1scheduler__t.html" target="_self">scheduler_t</a></td><td class="desc">协程调度器。 </td></tr>
<tr id="row_1_18_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1spinlock.html" target="_self">spinlock</a></td><td class="desc">一个自旋锁实现。 </td></tr>
<tr id="row_1_19_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1state__base__t.html" target="_self">state_base_t</a></td><td class="desc">State基类，state用于在协程的promise和future之间共享数据。 </td></tr>
<tr id="row_1_20_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1state__future__t.html" target="_self">state_future_t</a></td><td class="desc">专用于future_t&lt;&gt;的state基类，实现了针对于future_t&lt;&gt;的公共方法等。 </td></tr>
<tr id="row_1_21_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1state__generator__t.html" target="_self">state_generator_t</a></td><td class="desc">专用于generator_t&lt;&gt;的state类。 </td></tr>
<tr id="row_1_22_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1state__t.html" target="_self">state_t</a></td><td class="desc">专用于future_t&lt;&gt;的state类。 </td></tr>
<tr id="row_1_23_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1switch__scheduler__awaitor.html" target="_self">switch_scheduler_awaitor</a></td><td class="desc">切换协程的可等待对象。 </td></tr>
<tr id="row_1_24_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1task__t.html" target="_self">task_t</a></td><td class="desc">协程任务类。 </td></tr>
<tr id="row_1_25_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1timer__canceled__exception.html" target="_self">timer_canceled_exception</a></td><td class="desc">定时器提前取消导致的异常。 </td></tr>
<tr id="row_1_26_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1timer__handler.html" target="_self">timer_handler</a></td><td class="desc">定时器句柄。 </td></tr>
<tr id="row_1_27_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1timer__manager.html" target="_self">timer_manager</a></td><td class="desc">定时器管理器。 </td></tr>
<tr id="row_1_28_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1when__.html" target="_self">when_</a></td><td class="desc">目前不知道怎么在doxygen里面能搜集到全局函数的文档。故用一个结构体来欺骗doxygen。 </td></tr>
<tr id="row_1_29_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structresumef_1_1yield__awaitor.html" target="_self">yield_awaitor</a></td><td class="desc">将本协程让渡出一次调用的可等待对象。 </td></tr>
</table>
</div><!-- directory -->
</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>
Reference in New Issue Copy Permalink