Files
dl_old/document/html/classdl_1_1_multi_thread_task.html
T
2026-03-03 16:12:17 +08:00

291 lines
16 KiB
HTML
Vendored

<!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" lang="zh">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>dl: dl::MultiThreadTask&lt; T &gt; 模板类 参考</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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 id="projectrow">
<td id="projectalign">
<div id="projectname">dl
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','搜索',false);
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedl.html">dl</a></li><li class="navelem"><a class="el" href="classdl_1_1_multi_thread_task.html">MultiThreadTask</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public 类型</a> &#124;
<a href="#pub-methods">Public 成员函数</a> &#124;
<a href="classdl_1_1_multi_thread_task-members.html">所有成员列表</a> </div>
<div class="headertitle"><div class="title">dl::MultiThreadTask&lt; T &gt; 模板类 参考</div></div>
</div><!--header-->
<div class="contents">
<p>多线程任务
<a href="#details">更多...</a></p>
<p><code>#include &lt;<a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public 类型</h2></td></tr>
<tr class="memitem:acfdb729146b1e20cf49767a39cfdee72" id="r_acfdb729146b1e20cf49767a39cfdee72"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acfdb729146b1e20cf49767a39cfdee72">FnDoTask</a> = std::function&lt;void(const <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&amp;)&gt;</td></tr>
<tr class="separator:acfdb729146b1e20cf49767a39cfdee72"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public 成员函数</h2></td></tr>
<tr class="memitem:aeb0514206edd9cc8baecdb4a2abea4f0" id="r_aeb0514206edd9cc8baecdb4a2abea4f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb0514206edd9cc8baecdb4a2abea4f0">Init</a> (<a class="el" href="#acfdb729146b1e20cf49767a39cfdee72">FnDoTask</a> fn_do_task, <a class="el" href="namespacedl.html#a7114047f78bb869b67366f78278d4b1d">QueueMode</a> mode=<a class="el" href="namespacedl.html#a7114047f78bb869b67366f78278d4b1dac589858dbe1d06c46544266ae4cd2c6f">QueueMode::FIFO</a>, size_t thread_num=(size_t) std::thread::hardware_concurrency())</td></tr>
<tr class="separator:aeb0514206edd9cc8baecdb4a2abea4f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cf016464cc1d9a8c995497c078bb357" id="r_a4cf016464cc1d9a8c995497c078bb357"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4cf016464cc1d9a8c995497c078bb357">AddTask</a> (const <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &amp;task)</td></tr>
<tr class="memdesc:a4cf016464cc1d9a8c995497c078bb357"><td class="mdescLeft">&#160;</td><td class="mdescRight">添加任务 <br /></td></tr>
<tr class="separator:a4cf016464cc1d9a8c995497c078bb357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6932777222ccaca0178ac2af9c7778a0" id="r_a6932777222ccaca0178ac2af9c7778a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6932777222ccaca0178ac2af9c7778a0">ClearTask</a> ()</td></tr>
<tr class="memdesc:a6932777222ccaca0178ac2af9c7778a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">清除所有任务 <br /></td></tr>
<tr class="separator:a6932777222ccaca0178ac2af9c7778a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5533ed9eb1a6c0ab83e07e7ce3421973" id="r_a5533ed9eb1a6c0ab83e07e7ce3421973"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5533ed9eb1a6c0ab83e07e7ce3421973">Wait</a> ()</td></tr>
<tr class="memdesc:a5533ed9eb1a6c0ab83e07e7ce3421973"><td class="mdescLeft">&#160;</td><td class="mdescRight">等待任务完成 <br /></td></tr>
<tr class="separator:a5533ed9eb1a6c0ab83e07e7ce3421973"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17dbfe517b3076359253df568c5471ac" id="r_a17dbfe517b3076359253df568c5471ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17dbfe517b3076359253df568c5471ac">~MultiThreadTask</a> ()</td></tr>
<tr class="separator:a17dbfe517b3076359253df568c5471ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt;<br />
class dl::MultiThreadTask&lt; T &gt;</div><p>多线程任务 </p>
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00029">29</a> 行定义.</p>
</div><h2 class="groupheader">成员类型定义说明</h2>
<a id="acfdb729146b1e20cf49767a39cfdee72" name="acfdb729146b1e20cf49767a39cfdee72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfdb729146b1e20cf49767a39cfdee72">&#9670;&#160;</a></span>FnDoTask</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classdl_1_1_multi_thread_task.html">dl::MultiThreadTask</a>&lt; <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &gt;::FnDoTask = std::function&lt;void(const <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&amp;)&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00033">33</a> 行定义.</p>
</div>
</div>
<h2 class="groupheader">构造及析构函数说明</h2>
<a id="a17dbfe517b3076359253df568c5471ac" name="a17dbfe517b3076359253df568c5471ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17dbfe517b3076359253df568c5471ac">&#9670;&#160;</a></span>~MultiThreadTask()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdl_1_1_multi_thread_task.html">dl::MultiThreadTask</a>&lt; <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &gt;::~<a class="el" href="classdl_1_1_multi_thread_task.html">MultiThreadTask</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00097">97</a> 行定义.</p>
</div>
</div>
<h2 class="groupheader">成员函数说明</h2>
<a id="a4cf016464cc1d9a8c995497c078bb357" name="a4cf016464cc1d9a8c995497c078bb357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cf016464cc1d9a8c995497c078bb357">&#9670;&#160;</a></span>AddTask()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classdl_1_1_multi_thread_task.html">dl::MultiThreadTask</a>&lt; <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &gt;::AddTask </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &amp;</td> <td class="paramname"><span class="paramname"><em>task</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>添加任务 </p>
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00058">58</a> 行定义.</p>
</div>
</div>
<a id="a6932777222ccaca0178ac2af9c7778a0" name="a6932777222ccaca0178ac2af9c7778a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6932777222ccaca0178ac2af9c7778a0">&#9670;&#160;</a></span>ClearTask()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classdl_1_1_multi_thread_task.html">dl::MultiThreadTask</a>&lt; <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &gt;::ClearTask </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>清除所有任务 </p>
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00072">72</a> 行定义.</p>
</div>
</div>
<a id="aeb0514206edd9cc8baecdb4a2abea4f0" name="aeb0514206edd9cc8baecdb4a2abea4f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb0514206edd9cc8baecdb4a2abea4f0">&#9670;&#160;</a></span>Init()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classdl_1_1_multi_thread_task.html">dl::MultiThreadTask</a>&lt; <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &gt;::Init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#acfdb729146b1e20cf49767a39cfdee72">FnDoTask</a></td> <td class="paramname"><span class="paramname"><em>fn_do_task</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacedl.html#a7114047f78bb869b67366f78278d4b1d">QueueMode</a></td> <td class="paramname"><span class="paramname"><em>mode</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="namespacedl.html#a7114047f78bb869b67366f78278d4b1dac589858dbe1d06c46544266ae4cd2c6f">QueueMode::FIFO</a></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>thread_num</em></span><span class="paramdefsep"> = </span><span class="paramdefval">(size_t)std::thread::hardware_concurrency()</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00035">35</a> 行定义.</p>
</div>
</div>
<a id="a5533ed9eb1a6c0ab83e07e7ce3421973" name="a5533ed9eb1a6c0ab83e07e7ce3421973"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5533ed9eb1a6c0ab83e07e7ce3421973">&#9670;&#160;</a></span>Wait()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a>&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classdl_1_1_multi_thread_task.html">dl::MultiThreadTask</a>&lt; <a class="el" href="namespacedl.html#a38a0162879cdbfbbe99ba16e7a170132ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> &gt;::Wait </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>等待任务完成 </p>
<p class="definition">在文件 <a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a> 第 <a class="el" href="dl__thread__task_8h_source.html#l00082">82</a> 行定义.</p>
</div>
</div>
<hr/>该类的文档由以下文件生成:<ul>
<li>dl/io/<a class="el" href="dl__thread__task_8h_source.html">dl_thread_task.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
制作者&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1
</small></address>
</div><!-- doc-content -->
</body>
</html>