blob: 0589a3aa29e6cd5dfee594e3636b258b5c8d6b16 [file] [log] [blame]
<!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>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/thread_group.h File 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>
<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">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by 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,'Search');
/* @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','Search');
$(document).ready(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">thread_group.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Thread and synchronization primitives and lifecycle management.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="concurrentqueue_8h_source.html">dmlc/concurrentqueue.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="blockingconcurrentqueue_8h_source.html">dmlc/blockingconcurrentqueue.h</a>&gt;</code><br />
<code>#include &lt;dmlc/logging.h&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;mutex&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
<code>#include &lt;thread&gt;</code><br />
<code>#include &lt;unordered_set&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
<code>#include &lt;condition_variable&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for thread_group.h:</div>
<div class="dyncontent">
<div class="center"><img src="thread__group_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2thread__group_8h" alt=""/></div>
<!-- MAP 0 -->
</div>
</div>
<p><a href="thread__group_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ManualEvent.html">dmlc::ManualEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple manual-reset event gate which remains open after signalled. <a href="classdmlc_1_1ManualEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html">dmlc::ThreadGroup</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> lifecycle management group. <a href="classdmlc_1_1ThreadGroup.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">dmlc::ThreadGroup::Thread</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lifecycle-managed thread (used by <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>) <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1BlockingQueueThread.html">dmlc::BlockingQueueThread&lt; ObjectType, quit_item &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking queue thread class. <a href="classdmlc_1_1BlockingQueueThread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1TimerThread.html">dmlc::TimerThread&lt; Duration &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Managed timer thread. <a href="classdmlc_1_1TimerThread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacedmlc"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html">dmlc</a></td></tr>
<tr class="memdesc:namespacedmlc"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace for dmlc <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a34fec5df74dfed6c51540a1fcf5bae54"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">dmlc::SharedMutex</a> = std::recursive_mutex</td></tr>
<tr class="memdesc:a34fec5df74dfed6c51540a1fcf5bae54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard mutex for C++ &lt; 14. <a href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">More...</a><br /></td></tr>
<tr class="separator:a34fec5df74dfed6c51540a1fcf5bae54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad58a9dfecc6e970348c217de29bb916"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">dmlc::WriteLock</a> = std::unique_lock&lt; SharedMutex &gt;</td></tr>
<tr class="memdesc:aad58a9dfecc6e970348c217de29bb916"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard unique lock for C++ &lt; 14. <a href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">More...</a><br /></td></tr>
<tr class="separator:aad58a9dfecc6e970348c217de29bb916"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a591cc4d1980f6074fbc450bcf9d40876"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">dmlc::ReadLock</a> = std::unique_lock&lt; SharedMutex &gt;</td></tr>
<tr class="memdesc:a591cc4d1980f6074fbc450bcf9d40876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard unique lock for C++ &lt; 14. <a href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">More...</a><br /></td></tr>
<tr class="separator:a591cc4d1980f6074fbc450bcf9d40876"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3af1c5a5f5dd3a6741693071f85d67ce"><td class="memTemplParams" colspan="2">template&lt;typename Duration , typename TimerFunction &gt; </td></tr>
<tr class="memitem:a3af1c5a5f5dd3a6741693071f85d67ce"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a3af1c5a5f5dd3a6741693071f85d67ce">dmlc::CreateTimer</a> (const std::string &amp;timer_name, const Duration &amp;duration, ThreadGroup *owner, TimerFunction timer_function)</td></tr>
<tr class="memdesc:a3af1c5a5f5dd3a6741693071f85d67ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility function to easily create a timer. <a href="namespacedmlc.html#a3af1c5a5f5dd3a6741693071f85d67ce">More...</a><br /></td></tr>
<tr class="separator:a3af1c5a5f5dd3a6741693071f85d67ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Thread and synchronization primitives and lifecycle management. </p>
<p>Copyright (c) 2017 by Contributors </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet by &#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>