178 lines
16 KiB
HTML
178 lines
16 KiB
HTML
<!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="en-US">
|
|
<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.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>My Project: include/utils/ThreadPool.hh Source File</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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</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">My Project
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('ThreadPool_8hh_source.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">ThreadPool.hh</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ThreadPool_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// C++ Includes</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <queue></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <thread></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <condition_variable></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <mutex></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <future></span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceutils.html">utils</a> {</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html"> 12</a></span><span class="keyword">class </span><a class="code hl_function" href="classutils_1_1ThreadPool.html#a02ccb8118692092d5d4132eab7c751e2">ThreadPool</a> {</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html#a3113eec4fac2948b403a0d94c42a3732"> 14</a></span> std::vector<std::thread> <a class="code hl_variable" href="classutils_1_1ThreadPool.html#a3113eec4fac2948b403a0d94c42a3732">_workers</a>;</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html#acbc332a452776263a9e6557131495aee"> 15</a></span> std::queue<std::function<void()>> <a class="code hl_variable" href="classutils_1_1ThreadPool.html#acbc332a452776263a9e6557131495aee">_tasks</a>;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html#ad59af3c00e330ac777fb5eb349e0e291"> 17</a></span> std::mutex <a class="code hl_variable" href="classutils_1_1ThreadPool.html#ad59af3c00e330ac777fb5eb349e0e291">_queue_mutex</a>;</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html#ad0284bde5203396b2e3cf95e07893748"> 18</a></span> std::condition_variable <a class="code hl_variable" href="classutils_1_1ThreadPool.html#ad0284bde5203396b2e3cf95e07893748">_cv</a>;</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html#a6a2a828a76092e3170cb6a93d679043f"> 19</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classutils_1_1ThreadPool.html#a6a2a828a76092e3170cb6a93d679043f">_stop</a>{<span class="keyword">false</span>};</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classutils_1_1ThreadPool.html#a02ccb8118692092d5d4132eab7c751e2">ThreadPool</a>(std::size_t threads = std::thread::hardware_concurrency());</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_function" href="classutils_1_1ThreadPool.html#a6f0428a4b19a724f956d82e408013108">~ThreadPool</a>();</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">template</span><<span class="keyword">class </span>F, <span class="keyword">class</span>... Args></div>
|
|
<div class="foldopen" id="foldopen00026" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classutils_1_1ThreadPool.html#a06f6b246fd98c4970c0510d48141a29d"> 26</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classutils_1_1ThreadPool.html#a06f6b246fd98c4970c0510d48141a29d">enqueue</a>(F&& f, Args&&... args) -> std::future<std::invoke_result_t<F, Args...>> {</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">using </span>return_type = std::invoke_result_t<F, Args...>;</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">auto</span> task_ptr = std::make_shared<std::packaged_task<return_type()>>(</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> std::bind(std::forward<F>(f), std::forward<Args>(args)...)</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> );</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> std::future<return_type> result = task_ptr->get_future();</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> std::unique_lock lock(<a class="code hl_variable" href="classutils_1_1ThreadPool.html#ad59af3c00e330ac777fb5eb349e0e291">_queue_mutex</a>);</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classutils_1_1ThreadPool.html#a6a2a828a76092e3170cb6a93d679043f">_stop</a>)</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">"Tried to enqueue on stopped ThreadPool"</span>);</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_variable" href="classutils_1_1ThreadPool.html#acbc332a452776263a9e6557131495aee">_tasks</a>.emplace([task_ptr]() { (*task_ptr)(); });</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> }</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_variable" href="classutils_1_1ThreadPool.html#ad0284bde5203396b2e3cf95e07893748">_cv</a>.notify_one();</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">return</span> result;</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>} <span class="comment">// End utils namespace</span></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_a02ccb8118692092d5d4132eab7c751e2"><div class="ttname"><a href="classutils_1_1ThreadPool.html#a02ccb8118692092d5d4132eab7c751e2">utils::ThreadPool::ThreadPool</a></div><div class="ttdeci">ThreadPool(std::size_t threads=std::thread::hardware_concurrency())</div><div class="ttdef"><b>Definition</b> ThreadPool.cc:13</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_a06f6b246fd98c4970c0510d48141a29d"><div class="ttname"><a href="classutils_1_1ThreadPool.html#a06f6b246fd98c4970c0510d48141a29d">utils::ThreadPool::enqueue</a></div><div class="ttdeci">auto enqueue(F &&f, Args &&... args) -> std::future< std::invoke_result_t< F, Args... > ></div><div class="ttdef"><b>Definition</b> ThreadPool.hh:26</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_a3113eec4fac2948b403a0d94c42a3732"><div class="ttname"><a href="classutils_1_1ThreadPool.html#a3113eec4fac2948b403a0d94c42a3732">utils::ThreadPool::_workers</a></div><div class="ttdeci">std::vector< std::thread > _workers</div><div class="ttdef"><b>Definition</b> ThreadPool.hh:14</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_a6a2a828a76092e3170cb6a93d679043f"><div class="ttname"><a href="classutils_1_1ThreadPool.html#a6a2a828a76092e3170cb6a93d679043f">utils::ThreadPool::_stop</a></div><div class="ttdeci">bool _stop</div><div class="ttdef"><b>Definition</b> ThreadPool.hh:19</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_a6f0428a4b19a724f956d82e408013108"><div class="ttname"><a href="classutils_1_1ThreadPool.html#a6f0428a4b19a724f956d82e408013108">utils::ThreadPool::~ThreadPool</a></div><div class="ttdeci">~ThreadPool()</div><div class="ttdef"><b>Definition</b> ThreadPool.cc:33</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_acbc332a452776263a9e6557131495aee"><div class="ttname"><a href="classutils_1_1ThreadPool.html#acbc332a452776263a9e6557131495aee">utils::ThreadPool::_tasks</a></div><div class="ttdeci">std::queue< std::function< void()> > _tasks</div><div class="ttdef"><b>Definition</b> ThreadPool.hh:15</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_ad0284bde5203396b2e3cf95e07893748"><div class="ttname"><a href="classutils_1_1ThreadPool.html#ad0284bde5203396b2e3cf95e07893748">utils::ThreadPool::_cv</a></div><div class="ttdeci">std::condition_variable _cv</div><div class="ttdef"><b>Definition</b> ThreadPool.hh:18</div></div>
|
|
<div class="ttc" id="aclassutils_1_1ThreadPool_html_ad59af3c00e330ac777fb5eb349e0e291"><div class="ttname"><a href="classutils_1_1ThreadPool.html#ad59af3c00e330ac777fb5eb349e0e291">utils::ThreadPool::_queue_mutex</a></div><div class="ttdeci">std::mutex _queue_mutex</div><div class="ttdef"><b>Definition</b> ThreadPool.hh:17</div></div>
|
|
<div class="ttc" id="anamespaceutils_html"><div class="ttname"><a href="namespaceutils.html">utils</a></div><div class="ttdef"><b>Definition</b> ThreadPool.cc:11</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_821002d4f10779a80d4fb17bc32f21f1.html">utils</a></li><li class="navelem"><a class="el" href="ThreadPool_8hh.html">ThreadPool.hh</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|