Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / classdmlc_1_1ThreadGroup_1_1Thread.html
blob: 649ac929ab3840dffdef820ab09e22779c7fdd99 [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: dmlc::ThreadGroup::Thread 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>
<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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a></li><li class="navelem"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classdmlc_1_1ThreadGroup_1_1Thread-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::ThreadGroup::Thread Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>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></p>
<p><code>#include &lt;<a class="el" href="thread__group_8h_source.html">thread_group.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for dmlc::ThreadGroup::Thread:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1ThreadGroup_1_1Thread__inherit__graph.png" border="0" usemap="#dmlc_1_1ThreadGroup_1_1Thread_inherit__map" alt="Inheritance graph"/></div>
<!-- MAP 0 -->
</div>
<div class="dynheader">
Collaboration diagram for dmlc::ThreadGroup::Thread:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1ThreadGroup_1_1Thread__coll__graph.png" border="0" usemap="#dmlc_1_1ThreadGroup_1_1Thread_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 1 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a15a7156eee217ef17010947a83632150"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a15a7156eee217ef17010947a83632150">SharedPtr</a> = std::shared_ptr&lt; <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> &gt;</td></tr>
<tr class="memdesc:a15a7156eee217ef17010947a83632150"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared pointer type for readability. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a15a7156eee217ef17010947a83632150">More...</a><br /></td></tr>
<tr class="separator:a15a7156eee217ef17010947a83632150"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af418c16d46e4adc424a84c68a44e0c0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b">Thread</a> (std::string threadName, <a class="el" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a> *owner, std::thread *thrd=nullptr)</td></tr>
<tr class="memdesc:af418c16d46e4adc424a84c68a44e0c0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b">More...</a><br /></td></tr>
<tr class="separator:af418c16d46e4adc424a84c68a44e0c0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25667e2d229f416bd324bfc7d28ad47d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a25667e2d229f416bd324bfc7d28ad47d">~Thread</a> ()</td></tr>
<tr class="memdesc:a25667e2d229f416bd324bfc7d28ad47d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor with cleanup. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a25667e2d229f416bd324bfc7d28ad47d">More...</a><br /></td></tr>
<tr class="separator:a25667e2d229f416bd324bfc7d28ad47d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34db4d633ab7229256211a7f3690b823"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">name</a> () const</td></tr>
<tr class="memdesc:a34db4d633ab7229256211a7f3690b823"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the thread. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">More...</a><br /></td></tr>
<tr class="separator:a34db4d633ab7229256211a7f3690b823"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95bee6cfb44fa0added840e1c42ff7f1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a95bee6cfb44fa0added840e1c42ff7f1">is_current_thread</a> () const</td></tr>
<tr class="memdesc:a95bee6cfb44fa0added840e1c42ff7f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this class represents the currently running thread (self) <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a95bee6cfb44fa0added840e1c42ff7f1">More...</a><br /></td></tr>
<tr class="separator:a95bee6cfb44fa0added840e1c42ff7f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dee1f2d880507a322c28bf2c29bfaee"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">request_shutdown</a> ()</td></tr>
<tr class="memdesc:a0dee1f2d880507a322c28bf2c29bfaee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal to this thread that a thread shutdown/exit is requested. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">More...</a><br /></td></tr>
<tr class="separator:a0dee1f2d880507a322c28bf2c29bfaee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa880e5707af1df23523142850f36dc45"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">is_shutdown_requested</a> () const</td></tr>
<tr class="memdesc:aa880e5707af1df23523142850f36dc45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether shutdown has been requested (<a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee" title="Signal to this thread that a thread shutdown/exit is requested.">request_shutdown()</a> was called) <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">More...</a><br /></td></tr>
<tr class="separator:aa880e5707af1df23523142850f36dc45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16c4ff5126f01989d26d0170476c76ff"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a16c4ff5126f01989d26d0170476c76ff">is_auto_remove</a> () const</td></tr>
<tr class="memdesc:a16c4ff5126f01989d26d0170476c76ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether the thread is set to auto-remove itself from the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> owner when exiting. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a16c4ff5126f01989d26d0170476c76ff">More...</a><br /></td></tr>
<tr class="separator:a16c4ff5126f01989d26d0170476c76ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9637c66d37e0d39397784e35e8c0921a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a9637c66d37e0d39397784e35e8c0921a">make_joinable</a> ()</td></tr>
<tr class="memdesc:a9637c66d37e0d39397784e35e8c0921a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make the thread joinable (by removing the auto_remove flag) <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a9637c66d37e0d39397784e35e8c0921a">More...</a><br /></td></tr>
<tr class="separator:a9637c66d37e0d39397784e35e8c0921a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abff81204caa69efd85052b6be5af5281"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#abff81204caa69efd85052b6be5af5281">joinable</a> () const</td></tr>
<tr class="memdesc:abff81204caa69efd85052b6be5af5281"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether the thread is joinable. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#abff81204caa69efd85052b6be5af5281">More...</a><br /></td></tr>
<tr class="separator:abff81204caa69efd85052b6be5af5281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e13b559e8afc0e933ca7c6e7fe004e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a7e13b559e8afc0e933ca7c6e7fe004e3">join</a> ()</td></tr>
<tr class="memdesc:a7e13b559e8afc0e933ca7c6e7fe004e3"><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> join. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a7e13b559e8afc0e933ca7c6e7fe004e3">More...</a><br /></td></tr>
<tr class="separator:a7e13b559e8afc0e933ca7c6e7fe004e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0aad366a57a4553a1beb3af637071cc0"><td class="memItemLeft" align="right" valign="top">std::thread::id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0aad366a57a4553a1beb3af637071cc0">get_id</a> () const</td></tr>
<tr class="memdesc:a0aad366a57a4553a1beb3af637071cc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get this thread's id. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0aad366a57a4553a1beb3af637071cc0">More...</a><br /></td></tr>
<tr class="separator:a0aad366a57a4553a1beb3af637071cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aba557e3155a2e29664f761a3cf3b9cd5"><td class="memTemplParams" colspan="2">template&lt;typename StartFunction , typename ... Args&gt; </td></tr>
<tr class="memitem:aba557e3155a2e29664f761a3cf3b9cd5"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">launch</a> (std::shared_ptr&lt; <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> &gt; pThis, bool autoRemove, StartFunction start_function, Args ...args)</td></tr>
<tr class="memdesc:aba557e3155a2e29664f761a3cf3b9cd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launch the given <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object. <a href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">More...</a><br /></td></tr>
<tr class="separator:aba557e3155a2e29664f761a3cf3b9cd5"><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>Lifecycle-managed thread (used by <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>) </p>
<dl class="section note"><dt>Note</dt><dd>See gtest unit tests Syc.* for a usage examples </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a15a7156eee217ef17010947a83632150"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15a7156eee217ef17010947a83632150">&#9670;&nbsp;</a></span>SharedPtr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a15a7156eee217ef17010947a83632150">dmlc::ThreadGroup::Thread::SharedPtr</a> = std::shared_ptr&lt;<a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared pointer type for readability. </p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af418c16d46e4adc424a84c68a44e0c0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af418c16d46e4adc424a84c68a44e0c0b">&#9670;&nbsp;</a></span>Thread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::ThreadGroup::Thread::Thread </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>threadName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a> *&#160;</td>
<td class="paramname"><em>owner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::thread *&#160;</td>
<td class="paramname"><em>thrd</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">threadName</td><td>User-defined name of the thread. must be unique per <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> </td></tr>
<tr><td class="paramname">owner</td><td>The <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> object managing the lifecycle of this thread </td></tr>
<tr><td class="paramname">thrd</td><td>Optionally-assigned std::thread object associated with this <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> class </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a25667e2d229f416bd324bfc7d28ad47d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25667e2d229f416bd324bfc7d28ad47d">&#9670;&nbsp;</a></span>~Thread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual dmlc::ThreadGroup::Thread::~Thread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor with cleanup. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0aad366a57a4553a1beb3af637071cc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0aad366a57a4553a1beb3af637071cc0">&#9670;&nbsp;</a></span>get_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::thread::id dmlc::ThreadGroup::Thread::get_id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get this thread's id. </p>
<dl class="section return"><dt>Returns</dt><dd>this thread's id </dd></dl>
</div>
</div>
<a id="a16c4ff5126f01989d26d0170476c76ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16c4ff5126f01989d26d0170476c76ff">&#9670;&nbsp;</a></span>is_auto_remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::ThreadGroup::Thread::is_auto_remove </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the thread is set to auto-remove itself from the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> owner when exiting. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the thread will auto-remove itself from the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> owner when exiting </dd></dl>
</div>
</div>
<a id="a95bee6cfb44fa0added840e1c42ff7f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95bee6cfb44fa0added840e1c42ff7f1">&#9670;&nbsp;</a></span>is_current_thread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::ThreadGroup::Thread::is_current_thread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if this class represents the currently running thread (self) </p>
<dl class="section return"><dt>Returns</dt><dd>true if the current running thread belongs to this class </dd></dl>
</div>
</div>
<a id="aa880e5707af1df23523142850f36dc45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa880e5707af1df23523142850f36dc45">&#9670;&nbsp;</a></span>is_shutdown_requested()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool dmlc::ThreadGroup::Thread::is_shutdown_requested </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether shutdown has been requested (<a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee" title="Signal to this thread that a thread shutdown/exit is requested.">request_shutdown()</a> was called) </p>
<dl class="section return"><dt>Returns</dt><dd>true if shutdown was requested. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This may be overriden to match an overriden to match an overriden '<a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee" title="Signal to this thread that a thread shutdown/exit is requested.">request_shutdown()</a>', for instance. </dd></dl>
</div>
</div>
<a id="a7e13b559e8afc0e933ca7c6e7fe004e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e13b559e8afc0e933ca7c6e7fe004e3">&#9670;&nbsp;</a></span>join()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::ThreadGroup::Thread::join </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> join. </p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a7e13b559e8afc0e933ca7c6e7fe004e3" title="Thread join.">join()</a> may not be called on auto-remove threads </dd></dl>
</div>
</div>
<a id="abff81204caa69efd85052b6be5af5281"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abff81204caa69efd85052b6be5af5281">&#9670;&nbsp;</a></span>joinable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::ThreadGroup::Thread::joinable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the thread is joinable. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the thread is joinable </dd></dl>
</div>
</div>
<a id="aba557e3155a2e29664f761a3cf3b9cd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba557e3155a2e29664f761a3cf3b9cd5">&#9670;&nbsp;</a></span>launch()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename StartFunction , typename ... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::ThreadGroup::Thread::launch </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> &gt;&#160;</td>
<td class="paramname"><em>pThis</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>autoRemove</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">StartFunction&#160;</td>
<td class="paramname"><em>start_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args ...&#160;</td>
<td class="paramname"><em>args</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Launch the given <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">StartFunction</td><td>Function type for the thread 'main' function </td></tr>
<tr><td class="paramname">Args</td><td>Arguments to pass to the thread 'main' function </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pThis</td><td>Shared pointer for the managed thread to launch </td></tr>
<tr><td class="paramname">autoRemove</td><td>if true, automatically remove this <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object from the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> owner upon exit </td></tr>
<tr><td class="paramname">start_function</td><td>The <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a>'s 'main' function </td></tr>
<tr><td class="paramname">args</td><td>Arguments to pass to the <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a>'s 'main' function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the thread was successfully created and added to the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> If false is returned, the thread may have already been started, but if something went wrong (ie duplicte thread name for the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>), then <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee" title="Signal to this thread that a thread shutdown/exit is requested.">request_shutdown()</a> will have been been called on the running thread </dd></dl>
</div>
</div>
<a id="a9637c66d37e0d39397784e35e8c0921a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9637c66d37e0d39397784e35e8c0921a">&#9670;&nbsp;</a></span>make_joinable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::ThreadGroup::Thread::make_joinable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Make the thread joinable (by removing the auto_remove flag) </p>
<dl class="section warning"><dt>Warning</dt><dd>Care should be taken not to cause a race condition between this call and parallel execution of this thread auto-removing itself </dd></dl>
</div>
</div>
<a id="a34db4d633ab7229256211a7f3690b823"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34db4d633ab7229256211a7f3690b823">&#9670;&nbsp;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* dmlc::ThreadGroup::Thread::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the thread. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the thread name's string </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This shoul ndly be used as immediate for the sacope of the shared pointer pointing to this object </dd></dl>
</div>
</div>
<a id="a0dee1f2d880507a322c28bf2c29bfaee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dee1f2d880507a322c28bf2c29bfaee">&#9670;&nbsp;</a></span>request_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void dmlc::ThreadGroup::Thread::request_shutdown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal to this thread that a thread shutdown/exit is requested. </p>
<dl class="section note"><dt>Note</dt><dd>This is a candidate for overrise in a derived class which may trigger shutdown by means other than a boolean (ie condition variable, SimpleManualkEvent, etc). </dd></dl>
<p>Reimplemented in <a class="el" href="classdmlc_1_1BlockingQueueThread.html#a2db37aa339c11da94a0ce81f52d2d5c7">dmlc::BlockingQueueThread&lt; ObjectType, quit_item &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="thread__group_8h_source.html">thread_group.h</a></li>
</ul>
</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>