| <!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 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&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&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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1ThreadGroup-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::ThreadGroup Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><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></p> |
| |
| <p><code>#include <<a class="el" href="thread__group_8h_source.html">thread_group.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::ThreadGroup:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1ThreadGroup__coll__graph.png" border="0" usemap="#dmlc_1_1ThreadGroup_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </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"> </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:a0aeac26faab3e0608181a59a1e6726c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a0aeac26faab3e0608181a59a1e6726c6">ThreadGroup</a> ()</td></tr> |
| <tr class="memdesc:a0aeac26faab3e0608181a59a1e6726c6"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classdmlc_1_1ThreadGroup.html#a0aeac26faab3e0608181a59a1e6726c6">More...</a><br /></td></tr> |
| <tr class="separator:a0aeac26faab3e0608181a59a1e6726c6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac4a88fba4560dbbba3efac98e6d0f347"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#ac4a88fba4560dbbba3efac98e6d0f347">~ThreadGroup</a> ()</td></tr> |
| <tr class="memdesc:ac4a88fba4560dbbba3efac98e6d0f347"><td class="mdescLeft"> </td><td class="mdescRight">Destructor, perform cleanup. All child threads will be exited when this destructor completes. <a href="classdmlc_1_1ThreadGroup.html#ac4a88fba4560dbbba3efac98e6d0f347">More...</a><br /></td></tr> |
| <tr class="separator:ac4a88fba4560dbbba3efac98e6d0f347"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adfa40c047642d4b9969782274e8b8280"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#adfa40c047642d4b9969782274e8b8280">is_this_thread_in</a> () const</td></tr> |
| <tr class="memdesc:adfa40c047642d4b9969782274e8b8280"><td class="mdescLeft"> </td><td class="mdescRight">Check if the current thread a member if this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. <a href="classdmlc_1_1ThreadGroup.html#adfa40c047642d4b9969782274e8b8280">More...</a><br /></td></tr> |
| <tr class="separator:adfa40c047642d4b9969782274e8b8280"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0118655398fe78cf9faa466b043536f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#aa0118655398fe78cf9faa466b043536f">is_thread_in</a> (std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > thrd) const</td></tr> |
| <tr class="memdesc:aa0118655398fe78cf9faa466b043536f"><td class="mdescLeft"> </td><td class="mdescRight">Check if the current thread is a member of this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. <a href="classdmlc_1_1ThreadGroup.html#aa0118655398fe78cf9faa466b043536f">More...</a><br /></td></tr> |
| <tr class="separator:aa0118655398fe78cf9faa466b043536f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ab75ab28197f8951705f6afe713c31a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a2ab75ab28197f8951705f6afe713c31a">add_thread</a> (std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > thrd)</td></tr> |
| <tr class="memdesc:a2ab75ab28197f8951705f6afe713c31a"><td class="mdescLeft"> </td><td class="mdescRight">Add a <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object to this thread group. <a href="classdmlc_1_1ThreadGroup.html#a2ab75ab28197f8951705f6afe713c31a">More...</a><br /></td></tr> |
| <tr class="separator:a2ab75ab28197f8951705f6afe713c31a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67e34b5c574fc168ed9f62cf17de3729"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a67e34b5c574fc168ed9f62cf17de3729">remove_thread</a> (std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > thrd)</td></tr> |
| <tr class="memdesc:a67e34b5c574fc168ed9f62cf17de3729"><td class="mdescLeft"> </td><td class="mdescRight">Remove a <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object from this thread group. <a href="classdmlc_1_1ThreadGroup.html#a67e34b5c574fc168ed9f62cf17de3729">More...</a><br /></td></tr> |
| <tr class="separator:a67e34b5c574fc168ed9f62cf17de3729"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a286490cd78a1b60c85051bd9cb3e15d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a286490cd78a1b60c85051bd9cb3e15d8">join_all</a> ()</td></tr> |
| <tr class="memdesc:a286490cd78a1b60c85051bd9cb3e15d8"><td class="mdescLeft"> </td><td class="mdescRight">Join all threads in this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. <a href="classdmlc_1_1ThreadGroup.html#a286490cd78a1b60c85051bd9cb3e15d8">More...</a><br /></td></tr> |
| <tr class="separator:a286490cd78a1b60c85051bd9cb3e15d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a988dc9800999fc4648c7ba32c70c6aa0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a988dc9800999fc4648c7ba32c70c6aa0">request_shutdown_all</a> (const bool make_all_joinable=true)</td></tr> |
| <tr class="memdesc:a988dc9800999fc4648c7ba32c70c6aa0"><td class="mdescLeft"> </td><td class="mdescRight">Call request_shutdown() on all threads in this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. <a href="classdmlc_1_1ThreadGroup.html#a988dc9800999fc4648c7ba32c70c6aa0">More...</a><br /></td></tr> |
| <tr class="separator:a988dc9800999fc4648c7ba32c70c6aa0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a934c49ff2a4193d723a728e8e47cabe1"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a934c49ff2a4193d723a728e8e47cabe1">size</a> () const</td></tr> |
| <tr class="memdesc:a934c49ff2a4193d723a728e8e47cabe1"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of threads in this thread group. <a href="classdmlc_1_1ThreadGroup.html#a934c49ff2a4193d723a728e8e47cabe1">More...</a><br /></td></tr> |
| <tr class="separator:a934c49ff2a4193d723a728e8e47cabe1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96121f267e7498ff1ec208b0a19c1a40"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a96121f267e7498ff1ec208b0a19c1a40">empty</a> () const</td></tr> |
| <tr class="memdesc:a96121f267e7498ff1ec208b0a19c1a40"><td class="mdescLeft"> </td><td class="mdescRight">Check if the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> is empty. <a href="classdmlc_1_1ThreadGroup.html#a96121f267e7498ff1ec208b0a19c1a40">More...</a><br /></td></tr> |
| <tr class="separator:a96121f267e7498ff1ec208b0a19c1a40"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a24822f55ba9f87c5cd6e1014c0543cc0"><td class="memTemplParams" colspan="2">template<typename StartFunction , typename ThreadType = Thread, typename ... Args> </td></tr> |
| <tr class="memitem:a24822f55ba9f87c5cd6e1014c0543cc0"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a24822f55ba9f87c5cd6e1014c0543cc0">create</a> (const std::string &threadName, bool auto_remove, StartFunction start_function, Args... args)</td></tr> |
| <tr class="memdesc:a24822f55ba9f87c5cd6e1014c0543cc0"><td class="mdescLeft"> </td><td class="mdescRight">Create and launch a new <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object which will be owned by this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. <a href="classdmlc_1_1ThreadGroup.html#a24822f55ba9f87c5cd6e1014c0543cc0">More...</a><br /></td></tr> |
| <tr class="separator:a24822f55ba9f87c5cd6e1014c0543cc0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92d21f23342f63ffd19402424ba62bd2"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadGroup.html#a92d21f23342f63ffd19402424ba62bd2">thread_by_name</a> (const std::string &name)</td></tr> |
| <tr class="memdesc:a92d21f23342f63ffd19402424ba62bd2"><td class="mdescLeft"> </td><td class="mdescRight">Lookup <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object by name. <a href="classdmlc_1_1ThreadGroup.html#a92d21f23342f63ffd19402424ba62bd2">More...</a><br /></td></tr> |
| <tr class="separator:a92d21f23342f63ffd19402424ba62bd2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> lifecycle management group. </p> |
| <dl class="section note"><dt>Note</dt><dd>See gtest unit tests Syc.* for a usage examples </dd></dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a0aeac26faab3e0608181a59a1e6726c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0aeac26faab3e0608181a59a1e6726c6">◆ </a></span>ThreadGroup()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::ThreadGroup::ThreadGroup </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>Constructor. </p> |
| |
| </div> |
| </div> |
| <a id="ac4a88fba4560dbbba3efac98e6d0f347"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac4a88fba4560dbbba3efac98e6d0f347">◆ </a></span>~ThreadGroup()</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::~ThreadGroup </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, perform cleanup. All child threads will be exited when this destructor completes. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2ab75ab28197f8951705f6afe713c31a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ab75ab28197f8951705f6afe713c31a">◆ </a></span>add_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::add_thread </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > </td> |
| <td class="paramname"><em>thrd</em></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>Add a <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object to this thread group. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">thrd</td><td>The thread to add to this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the given thread was added to this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a24822f55ba9f87c5cd6e1014c0543cc0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a24822f55ba9f87c5cd6e1014c0543cc0">◆ </a></span>create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename StartFunction , typename ThreadType = Thread, typename ... Args> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool dmlc::ThreadGroup::create </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>threadName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>auto_remove</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">StartFunction </td> |
| <td class="paramname"><em>start_function</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Args... </td> |
| <td class="paramname"><em>args</em> </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>Create and launch a new <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object which will be owned by this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. </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">ThreadType</td><td>managedThreadclass type (in case it's derived, for instance) </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">threadName</td><td>Name if the thread. Must be unique for a <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> object </td></tr> |
| <tr><td class="paramname">auto_remove</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 request_shutdown() will have been been called on the running thread </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a96121f267e7498ff1ec208b0a19c1a40"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96121f267e7498ff1ec208b0a19c1a40">◆ </a></span>empty()</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::empty </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 the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> is empty. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> is empty </dd></dl> |
| |
| </div> |
| </div> |
| <a id="adfa40c047642d4b9969782274e8b8280"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adfa40c047642d4b9969782274e8b8280">◆ </a></span>is_this_thread_in()</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::is_this_thread_in </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 the current thread a member if this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the current thread is a member of this thread group </dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>This lookup involved a linear search, so for a large number of threads, is it not advised to call this function in a performance-sensitive area </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa0118655398fe78cf9faa466b043536f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa0118655398fe78cf9faa466b043536f">◆ </a></span>is_thread_in()</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::is_thread_in </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > </td> |
| <td class="paramname"><em>thrd</em></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 the current thread is a member of this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">thrd</td><td>The thread to search for </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the given thread is a member of this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a286490cd78a1b60c85051bd9cb3e15d8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a286490cd78a1b60c85051bd9cb3e15d8">◆ </a></span>join_all()</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::join_all </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>Join all threads in this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. </p> |
| <dl class="section note"><dt>Note</dt><dd>While it is not valid to call 'join' on an auto-remove thread, this function will wait for auto-remove threads to exit (waits for the <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> to become empty) </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a67e34b5c574fc168ed9f62cf17de3729"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a67e34b5c574fc168ed9f62cf17de3729">◆ </a></span>remove_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::remove_thread </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> > </td> |
| <td class="paramname"><em>thrd</em></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>Remove a <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object from this thread group. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">thrd</td><td>The thread to remove from this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the given thread was removed from this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a988dc9800999fc4648c7ba32c70c6aa0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a988dc9800999fc4648c7ba32c70c6aa0">◆ </a></span>request_shutdown_all()</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::request_shutdown_all </td> |
| <td>(</td> |
| <td class="paramtype">const bool </td> |
| <td class="paramname"><em>make_all_joinable</em> = <code>true</code></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>Call request_shutdown() on all threads in this <a class="el" href="classdmlc_1_1ThreadGroup.html" title="Thread lifecycle management group.">ThreadGroup</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">make_all_joinable</td><td>If true, remove all auto_remove flags from child threads </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a934c49ff2a4193d723a728e8e47cabe1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a934c49ff2a4193d723a728e8e47cabe1">◆ </a></span>size()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t dmlc::ThreadGroup::size </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>Return the number of threads in this thread group. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Number of threads in this thread group </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a92d21f23342f63ffd19402424ba62bd2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a92d21f23342f63ffd19402424ba62bd2">◆ </a></span>thread_by_name()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a>> dmlc::ThreadGroup::thread_by_name </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></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>Lookup <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object by name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Name of the thread to look up </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A shared pointer to the <a class="el" href="classdmlc_1_1ThreadGroup_1_1Thread.html" title="Lifecycle-managed thread (used by ThreadGroup)">Thread</a> object </dd></dl> |
| |
| </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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
