Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
johnpatek committed Mar 21, 2024
1 parent 320c8d8 commit f802492
Show file tree
Hide file tree
Showing 22 changed files with 447 additions and 85 deletions.
1 change: 1 addition & 0 deletions docs/threadpool/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</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="dynsection.toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacemaxtek.html" target="_self">maxtek</a></td><td class="desc"></td></tr>
<tr id="row_0_0_" class="odd"><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="classmaxtek_1_1threadpool.html" target="_self">threadpool</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classallows.html" target="_self">allows</a></td><td class="desc">Threadpool </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
92 changes: 92 additions & 0 deletions docs/threadpool/classallows.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Threadpool: allows 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>
<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>
<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">Threadpool
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.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" 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('',true,false,'search.php','Search');
$(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">
<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><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">allows Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>threadpool
<a href="#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>threadpool </p>
<p>be submitted and exexuted asynchronously across multiple threads. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="threadpool_8hpp_source.html">threadpool.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
5 changes: 4 additions & 1 deletion docs/threadpool/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,12 @@
<div class="headertitle"><div class="title">Class Index</div></div>
</div><!--header-->
<div class="contents">
<div class="qindex"><a class="qindex" href="#letter_T">T</a></div>
<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a></div>
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a id="letter_A" name="letter_A">A</a></dt>
<dd><a class="el" href="classallows.html">allows</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_T" name="letter_T">T</a></dt>
<dd><a class="el" href="classmaxtek_1_1threadpool.html">threadpool</a> (<a class="el" href="namespacemaxtek.html">maxtek</a>)</dd></dl>
</div>
Expand Down
43 changes: 43 additions & 0 deletions docs/threadpool/classmaxtek_1_1threadpool.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,20 @@
<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:a5b45e377702b79ac2f1405b5e1ae24f5" id="r_a5b45e377702b79ac2f1405b5e1ae24f5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b45e377702b79ac2f1405b5e1ae24f5">threadpool</a> (size_t threads=std::thread::hardware_concurrency())</td></tr>
<tr class="memdesc:a5b45e377702b79ac2f1405b5e1ae24f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructs a new threadpool <br /></td></tr>
<tr class="separator:a5b45e377702b79ac2f1405b5e1ae24f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ee8f22615b38d6960ea033667789a71" id="r_a0ee8f22615b38d6960ea033667789a71"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ee8f22615b38d6960ea033667789a71">~threadpool</a> ()</td></tr>
<tr class="memdesc:a0ee8f22615b38d6960ea033667789a71"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys threadpool after calling shutdown if necessary <br /></td></tr>
<tr class="separator:a0ee8f22615b38d6960ea033667789a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebcaf1fcb1c54de81d77d69dcba6279e" id="r_aebcaf1fcb1c54de81d77d69dcba6279e"><td class="memTemplParams" colspan="2">template&lt;class F , class... Args&gt; </td></tr>
<tr class="memitem:aebcaf1fcb1c54de81d77d69dcba6279e"><td class="memTemplItemLeft" align="right" valign="top">std::future&lt; std::result_of_t&lt; F(Args...)&gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aebcaf1fcb1c54de81d77d69dcba6279e">submit</a> (F &amp;&amp;function, Args &amp;&amp;...args)</td></tr>
<tr class="memdesc:aebcaf1fcb1c54de81d77d69dcba6279e"><td class="mdescLeft">&#160;</td><td class="mdescRight">submits a function with its arguments to the threadpool <br /></td></tr>
<tr class="separator:aebcaf1fcb1c54de81d77d69dcba6279e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84eb22cabdb124d0d918728652a27c21" id="r_a84eb22cabdb124d0d918728652a27c21"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a84eb22cabdb124d0d918728652a27c21">active</a> () const</td></tr>
<tr class="memdesc:a84eb22cabdb124d0d918728652a27c21"><td class="mdescLeft">&#160;</td><td class="mdescRight">check if the threadpool is active <br /></td></tr>
<tr class="separator:a84eb22cabdb124d0d918728652a27c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf07455ccd2eb75f8b0e4df111813adc" id="r_acf07455ccd2eb75f8b0e4df111813adc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acf07455ccd2eb75f8b0e4df111813adc">shutdown</a> ()</td></tr>
<tr class="memdesc:acf07455ccd2eb75f8b0e4df111813adc"><td class="mdescLeft">&#160;</td><td class="mdescRight">shut down threadpool by joining threads and rejecting submissions <br /></td></tr>
<tr class="separator:acf07455ccd2eb75f8b0e4df111813adc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Expand All @@ -114,6 +119,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5b45e377702b79ac2f1405b5
</table>
</div><div class="memdoc">

<p>constructs a new threadpool </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">threads</td><td>number of threads to use for constructing the threadpool </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">fails</td><td>if threads is set to zero </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a0ee8f22615b38d6960ea033667789a71" name="a0ee8f22615b38d6960ea033667789a71"></a>
Expand All @@ -131,6 +150,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0ee8f22615b38d6960ea0336
</table>
</div><div class="memdoc">

<p>destroys threadpool after calling shutdown if necessary </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
Expand All @@ -149,6 +170,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a84eb22cabdb124d0d9187286
</table>
</div><div class="memdoc">

<p>check if the threadpool is active </p>
<dl class="section return"><dt>Returns</dt><dd>true if the threadpool is active, false if it has been shut down </dd></dl>

</div>
</div>
<a id="acf07455ccd2eb75f8b0e4df111813adc" name="acf07455ccd2eb75f8b0e4df111813adc"></a>
Expand All @@ -166,6 +190,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#acf07455ccd2eb75f8b0e4df1
</table>
</div><div class="memdoc">

<p>shut down threadpool by joining threads and rejecting submissions </p>

</div>
</div>
<a id="aebcaf1fcb1c54de81d77d69dcba6279e" name="aebcaf1fcb1c54de81d77d69dcba6279e"></a>
Expand Down Expand Up @@ -197,6 +223,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#aebcaf1fcb1c54de81d77d69d
</table>
</div><div class="memdoc">

<p>submits a function with its arguments to the threadpool </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">F</td><td>function signature </td></tr>
<tr><td class="paramname">Args</td><td>function argument types </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">function</td><td>function signature </td></tr>
<tr><td class="paramname">args</td><td>arguments to pass to the function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a future holding the asynchronous function result </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
Expand Down
3 changes: 3 additions & 0 deletions docs/threadpool/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<a href="README_8md.html"/>
<a href="threadpool_8hpp.html"/>
<a href="md_README.html"/>
<a href="classallows.html"/>
<a href="namespacemaxtek.html"/>
<a href="classmaxtek_1_1threadpool.html"/>
<a href="classmaxtek_1_1threadpool-members.html"/>
Expand All @@ -30,5 +31,7 @@
<a href="functions_func.html"/>
<a href="functions_func.html"/>
<a href="files.html"/>
<a href="globals.html"/>
<a href="globals_defs.html"/>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/threadpool/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<div class="contents">
<div class="textblock">Here is a list of all files with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="threadpool_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="threadpool_8hpp.html" target="_self">threadpool.hpp</a></td><td class="desc"></td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="threadpool_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="threadpool_8hpp.html" target="_self">threadpool.hpp</a></td><td class="desc">Maxtek threadpool </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
83 changes: 83 additions & 0 deletions docs/threadpool/globals.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Threadpool: File Members</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>
<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>
<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">Threadpool
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.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" 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('',true,false,'search.php','Search');
$(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">
<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="contents">
<div class="textblock">Here is a list of all file members with links to the files they belong to:</div><ul>
<li>DLL_EXPORT&#160;:&#160;<a class="el" href="threadpool_8hpp.html#a1ca888bd091694c05472e1b91df1a97b">threadpool.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Loading

0 comments on commit f802492

Please sign in to comment.