xbazzi/fastinahurry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
fastinahurry/html/classutils_1_1ThreadPool.html
xbazzi 59d0867e21 Modify concurrency stuff
2025-08-16 20:32:40 -06:00

363 lines
18 KiB
HTML
Raw Blame History

<!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: utils::ThreadPool Class Reference</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&amp;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()">&#160;</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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('classutils_1_1ThreadPool.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classutils_1_1ThreadPool-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">utils::ThreadPool Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="ThreadPool_8hh_source.html">ThreadPool.hh</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for utils::ThreadPool:</div>
<div class="dyncontent">
<div class="center"><img src="classutils_1_1ThreadPool__coll__graph.png" border="0" usemap="#autils_1_1ThreadPool_coll__map" alt="Collaboration graph"/></div>
<map name="autils_1_1ThreadPool_coll__map" id="autils_1_1ThreadPool_coll__map">
<area shape="rect" title=" " alt="" coords="5,5,128,212"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a02ccb8118692092d5d4132eab7c751e2" id="r_a02ccb8118692092d5d4132eab7c751e2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a02ccb8118692092d5d4132eab7c751e2">ThreadPool</a> (std::size_t threads=std::thread::hardware_concurrency())</td></tr>
<tr class="separator:a02ccb8118692092d5d4132eab7c751e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f0428a4b19a724f956d82e408013108" id="r_a6f0428a4b19a724f956d82e408013108"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f0428a4b19a724f956d82e408013108">~ThreadPool</a> ()</td></tr>
<tr class="separator:a6f0428a4b19a724f956d82e408013108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f6b246fd98c4970c0510d48141a29d" id="r_a06f6b246fd98c4970c0510d48141a29d"><td class="memTemplParams" colspan="2">template&lt;class F, class... Args&gt; </td></tr>
<tr class="memitem:a06f6b246fd98c4970c0510d48141a29d"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a06f6b246fd98c4970c0510d48141a29d">enqueue</a> (F &amp;&amp;f, Args &amp;&amp;... args) -&gt; std::future&lt; std::invoke_result_t&lt; F, Args... &gt; &gt;</td></tr>
<tr class="separator:a06f6b246fd98c4970c0510d48141a29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a3113eec4fac2948b403a0d94c42a3732" id="r_a3113eec4fac2948b403a0d94c42a3732"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::thread &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3113eec4fac2948b403a0d94c42a3732">_workers</a></td></tr>
<tr class="separator:a3113eec4fac2948b403a0d94c42a3732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbc332a452776263a9e6557131495aee" id="r_acbc332a452776263a9e6557131495aee"><td class="memItemLeft" align="right" valign="top">std::queue&lt; std::function&lt; void()&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbc332a452776263a9e6557131495aee">_tasks</a></td></tr>
<tr class="separator:acbc332a452776263a9e6557131495aee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad59af3c00e330ac777fb5eb349e0e291" id="r_ad59af3c00e330ac777fb5eb349e0e291"><td class="memItemLeft" align="right" valign="top">std::mutex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad59af3c00e330ac777fb5eb349e0e291">_queue_mutex</a></td></tr>
<tr class="separator:ad59af3c00e330ac777fb5eb349e0e291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0284bde5203396b2e3cf95e07893748" id="r_ad0284bde5203396b2e3cf95e07893748"><td class="memItemLeft" align="right" valign="top">std::condition_variable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0284bde5203396b2e3cf95e07893748">_cv</a></td></tr>
<tr class="separator:ad0284bde5203396b2e3cf95e07893748"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a2a828a76092e3170cb6a93d679043f" id="r_a6a2a828a76092e3170cb6a93d679043f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6a2a828a76092e3170cb6a93d679043f">_stop</a> {false}</td></tr>
<tr class="separator:a6a2a828a76092e3170cb6a93d679043f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a02ccb8118692092d5d4132eab7c751e2" name="a02ccb8118692092d5d4132eab7c751e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02ccb8118692092d5d4132eab7c751e2">&#9670;&#160;</a></span>ThreadPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">utils::ThreadPool::ThreadPool </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>threads</em></span><span class="paramdefsep"> = </span><span class="paramdefval">std::thread::hardware_concurrency()</span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel explicit">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="#ad0284bde5203396b2e3cf95e07893748">_cv</a>, <a class="el" href="#ad59af3c00e330ac777fb5eb349e0e291">_queue_mutex</a>, <a class="el" href="#a6a2a828a76092e3170cb6a93d679043f">_stop</a>, <a class="el" href="#acbc332a452776263a9e6557131495aee">_tasks</a>, and <a class="el" href="#a3113eec4fac2948b403a0d94c42a3732">_workers</a>.</p>
</div>
</div>
<a id="a6f0428a4b19a724f956d82e408013108" name="a6f0428a4b19a724f956d82e408013108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f0428a4b19a724f956d82e408013108">&#9670;&#160;</a></span>~ThreadPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">utils::ThreadPool::~ThreadPool </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="#ad0284bde5203396b2e3cf95e07893748">_cv</a>, <a class="el" href="#ad59af3c00e330ac777fb5eb349e0e291">_queue_mutex</a>, <a class="el" href="#a6a2a828a76092e3170cb6a93d679043f">_stop</a>, and <a class="el" href="#a3113eec4fac2948b403a0d94c42a3732">_workers</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a06f6b246fd98c4970c0510d48141a29d" name="a06f6b246fd98c4970c0510d48141a29d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06f6b246fd98c4970c0510d48141a29d">&#9670;&#160;</a></span>enqueue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F, class... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto utils::ThreadPool::enqueue </td>
<td>(</td>
<td class="paramtype">F &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>f</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args &amp;&amp;...</td> <td class="paramname"><span class="paramname"><em>args</em></span>&#160;) -&gt; std::future&lt;std::invoke_result_t&lt;F, Args...&gt;&gt; </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="reference">References <a class="el" href="#ad0284bde5203396b2e3cf95e07893748">_cv</a>, <a class="el" href="#ad59af3c00e330ac777fb5eb349e0e291">_queue_mutex</a>, <a class="el" href="#a6a2a828a76092e3170cb6a93d679043f">_stop</a>, and <a class="el" href="#acbc332a452776263a9e6557131495aee">_tasks</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad0284bde5203396b2e3cf95e07893748" name="ad0284bde5203396b2e3cf95e07893748"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0284bde5203396b2e3cf95e07893748">&#9670;&#160;</a></span>_cv</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::condition_variable utils::ThreadPool::_cv</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a06f6b246fd98c4970c0510d48141a29d">enqueue()</a>, <a class="el" href="#a02ccb8118692092d5d4132eab7c751e2">ThreadPool()</a>, and <a class="el" href="#a6f0428a4b19a724f956d82e408013108">~ThreadPool()</a>.</p>
</div>
</div>
<a id="ad59af3c00e330ac777fb5eb349e0e291" name="ad59af3c00e330ac777fb5eb349e0e291"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad59af3c00e330ac777fb5eb349e0e291">&#9670;&#160;</a></span>_queue_mutex</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::mutex utils::ThreadPool::_queue_mutex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a06f6b246fd98c4970c0510d48141a29d">enqueue()</a>, <a class="el" href="#a02ccb8118692092d5d4132eab7c751e2">ThreadPool()</a>, and <a class="el" href="#a6f0428a4b19a724f956d82e408013108">~ThreadPool()</a>.</p>
</div>
</div>
<a id="a6a2a828a76092e3170cb6a93d679043f" name="a6a2a828a76092e3170cb6a93d679043f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a2a828a76092e3170cb6a93d679043f">&#9670;&#160;</a></span>_stop</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool utils::ThreadPool::_stop {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a06f6b246fd98c4970c0510d48141a29d">enqueue()</a>, <a class="el" href="#a02ccb8118692092d5d4132eab7c751e2">ThreadPool()</a>, and <a class="el" href="#a6f0428a4b19a724f956d82e408013108">~ThreadPool()</a>.</p>
</div>
</div>
<a id="acbc332a452776263a9e6557131495aee" name="acbc332a452776263a9e6557131495aee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbc332a452776263a9e6557131495aee">&#9670;&#160;</a></span>_tasks</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::queue&lt;std::function&lt;void()&gt; &gt; utils::ThreadPool::_tasks</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a06f6b246fd98c4970c0510d48141a29d">enqueue()</a>, and <a class="el" href="#a02ccb8118692092d5d4132eab7c751e2">ThreadPool()</a>.</p>
</div>
</div>
<a id="a3113eec4fac2948b403a0d94c42a3732" name="a3113eec4fac2948b403a0d94c42a3732"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3113eec4fac2948b403a0d94c42a3732">&#9670;&#160;</a></span>_workers</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::thread&gt; utils::ThreadPool::_workers</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a02ccb8118692092d5d4132eab7c751e2">ThreadPool()</a>, and <a class="el" href="#a6f0428a4b19a724f956d82e408013108">~ThreadPool()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/utils/<a class="el" href="ThreadPool_8hh_source.html">ThreadPool.hh</a></li>
<li>src/utils/<a class="el" href="ThreadPool_8cc.html">ThreadPool.cc</a></li>
</ul>
</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="namespaceutils.html">utils</a></li><li class="navelem"><a class="el" href="classutils_1_1ThreadPool.html">ThreadPool</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>
Reference in New Issue View Git Blame Copy Permalink