blob: cb8b63bc9cbcbd654c0ddad6de4dd657b67abced [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>Impala: impala::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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</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">
$(document).ready(function(){initNavTree('classimpala_1_1Thread.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classimpala_1_1Thread-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::Thread Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>TODO: Consider allowing fragment IDs as category parameters.
<a href="classimpala_1_1Thread.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="thread_8h_source.html">thread.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::Thread:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1Thread__coll__graph.svg" width="432" height="438"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<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:aa3de0c044c6524d31836aab4ffea5973"><td class="memTemplParams" colspan="2">template&lt;class F &gt; </td></tr>
<tr class="memitem:aa3de0c044c6524d31836aab4ffea5973"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#aa3de0c044c6524d31836aab4ffea5973">Thread</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const F &amp;f)</td></tr>
<tr class="separator:aa3de0c044c6524d31836aab4ffea5973"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36c3cc9e249fd6faee3a38303587c9fc"><td class="memTemplParams" colspan="2">template&lt;class F , class A1 &gt; </td></tr>
<tr class="memitem:a36c3cc9e249fd6faee3a38303587c9fc"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a36c3cc9e249fd6faee3a38303587c9fc">Thread</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const F &amp;f, const A1 &amp;a1)</td></tr>
<tr class="separator:a36c3cc9e249fd6faee3a38303587c9fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaade3dde1bacb8f5215851aeff8a60b"><td class="memTemplParams" colspan="2">template&lt;class F , class A1 , class A2 &gt; </td></tr>
<tr class="memitem:aaaade3dde1bacb8f5215851aeff8a60b"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#aaaade3dde1bacb8f5215851aeff8a60b">Thread</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const F &amp;f, const A1 &amp;a1, const A2 &amp;a2)</td></tr>
<tr class="separator:aaaade3dde1bacb8f5215851aeff8a60b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf0bd140e9a117cd17ec9b759ff7e211"><td class="memTemplParams" colspan="2">template&lt;class F , class A1 , class A2 , class A3 &gt; </td></tr>
<tr class="memitem:adf0bd140e9a117cd17ec9b759ff7e211"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#adf0bd140e9a117cd17ec9b759ff7e211">Thread</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const F &amp;f, const A1 &amp;a1, const A2 &amp;a2, const A3 &amp;a3)</td></tr>
<tr class="separator:adf0bd140e9a117cd17ec9b759ff7e211"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4df4ee99c148f00cdc3affde898c55f"><td class="memTemplParams" colspan="2">template&lt;class F , class A1 , class A2 , class A3 , class A4 &gt; </td></tr>
<tr class="memitem:af4df4ee99c148f00cdc3affde898c55f"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#af4df4ee99c148f00cdc3affde898c55f">Thread</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const F &amp;f, const A1 &amp;a1, const A2 &amp;a2, const A3 &amp;a3, const A4 &amp;a4)</td></tr>
<tr class="separator:af4df4ee99c148f00cdc3affde898c55f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fbbab264db536d65642d4b006437c56"><td class="memTemplParams" colspan="2">template&lt;class F , class A1 , class A2 , class A3 , class A4 , class A5 &gt; </td></tr>
<tr class="memitem:a9fbbab264db536d65642d4b006437c56"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a9fbbab264db536d65642d4b006437c56">Thread</a> (const std::string &amp;category, const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const F &amp;f, const A1 &amp;a1, const A2 &amp;a2, const A3 &amp;a3, const A4 &amp;a4, const A5 &amp;a5)</td></tr>
<tr class="separator:a9fbbab264db536d65642d4b006437c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fad57e14b212d8d1bc61b2c00948047"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a5fad57e14b212d8d1bc61b2c00948047">Join</a> () const </td></tr>
<tr class="separator:a5fad57e14b212d8d1bc61b2c00948047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70887ee3a48c1175d2a190a6e0afae67"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a70887ee3a48c1175d2a190a6e0afae67">tid</a> () const </td></tr>
<tr class="separator:a70887ee3a48c1175d2a190a6e0afae67"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af33f21d868395845bec0e26e42ef3087"><td class="memItemLeft" align="right" valign="top">static const int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#af33f21d868395845bec0e26e42ef3087">INVALID_THREAD_ID</a> = -1</td></tr>
<tr class="separator:af33f21d868395845bec0e26e42ef3087"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a044ce27a118a6a677093b143743c2008"><td class="memItemLeft" align="right" valign="top">typedef boost::function&lt; void()&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a044ce27a118a6a677093b143743c2008">ThreadFunctor</a></td></tr>
<tr class="memdesc:a044ce27a118a6a677093b143743c2008"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function object that wraps the user-supplied function to run in a separate thread. <a href="#a044ce27a118a6a677093b143743c2008">More...</a><br/></td></tr>
<tr class="separator:a044ce27a118a6a677093b143743c2008"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:aaf91fd871c86273536d91802d0258247"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#aaf91fd871c86273536d91802d0258247">StartThread</a> (const <a class="el" href="classimpala_1_1Thread.html#a044ce27a118a6a677093b143743c2008">ThreadFunctor</a> &amp;functor)</td></tr>
<tr class="separator:aaf91fd871c86273536d91802d0258247"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a143f3a2eb86a90160a83a8220c78d83b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread</a> (const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>, const std::string &amp;category, <a class="el" href="classimpala_1_1Thread.html#a044ce27a118a6a677093b143743c2008">ThreadFunctor</a> functor, <a class="el" href="classimpala_1_1Promise.html">Promise</a>&lt; int64_t &gt; *thread_started)</td></tr>
<tr class="separator:a143f3a2eb86a90160a83a8220c78d83b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a49f2214244a0fa8cb134d73450471581"><td class="memItemLeft" align="right" valign="top">boost::scoped_ptr&lt; boost::thread &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a49f2214244a0fa8cb134d73450471581">thread_</a></td></tr>
<tr class="memdesc:a49f2214244a0fa8cb134d73450471581"><td class="mdescLeft">&#160;</td><td class="mdescRight">The actual thread object that runs the user's method via <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a>. <a href="#a49f2214244a0fa8cb134d73450471581">More...</a><br/></td></tr>
<tr class="separator:a49f2214244a0fa8cb134d73450471581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a153d05e96c0bdf3f444af8816250a061"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a153d05e96c0bdf3f444af8816250a061">category_</a></td></tr>
<tr class="memdesc:a153d05e96c0bdf3f444af8816250a061"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name and category for this thread. <a href="#a153d05e96c0bdf3f444af8816250a061">More...</a><br/></td></tr>
<tr class="separator:a153d05e96c0bdf3f444af8816250a061"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31cecf874ff332b002d7d24c311d0ac1"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a31cecf874ff332b002d7d24c311d0ac1">name_</a></td></tr>
<tr class="separator:a31cecf874ff332b002d7d24c311d0ac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f1c2ddb4140367deae98287becb9d21"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#a9f1c2ddb4140367deae98287becb9d21">tid_</a></td></tr>
<tr class="separator:a9f1c2ddb4140367deae98287becb9d21"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:af4ae654033a8bfb4756e6eac91c68eea"><td class="memItemLeft" align="right" valign="top">static const int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Thread.html#af4ae654033a8bfb4756e6eac91c68eea">UNINITIALISED_THREAD_ID</a> = -2</td></tr>
<tr class="separator:af4ae654033a8bfb4756e6eac91c68eea"><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>TODO: Consider allowing fragment IDs as category parameters. </p>
<p>Thin wrapper around boost::thread that can register itself with the singleton <a class="el" href="classimpala_1_1ThreadMgr.html">ThreadMgr</a> (a private class implemented in <a class="el" href="thread_8cc.html">thread.cc</a> entirely, which tracks all live threads so that they may be monitored via the debug webpages). This class has a limited subset of boost::thread's API. Construction is almost the same, but clients must supply a category and a name for each thread so that they can be identified in the debug web UI. Otherwise, <a class="el" href="classimpala_1_1Thread.html#a5fad57e14b212d8d1bc61b2c00948047">Join()</a> is the only supported method from boost::thread. Each <a class="el" href="classimpala_1_1Thread.html" title="TODO: Consider allowing fragment IDs as category parameters. ">Thread</a> object knows its operating system thread ID (tid), which can be used to attach debuggers to specific threads, to retrieve resource-usage statistics from the operating system, and to assign threads to resource control groups. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00045">45</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a044ce27a118a6a677093b143743c2008"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">typedef boost::function&lt;void ()&gt; <a class="el" href="classimpala_1_1Thread.html#a044ce27a118a6a677093b143743c2008">impala::Thread::ThreadFunctor</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function object that wraps the user-supplied function to run in a separate thread. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00117">117</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa3de0c044c6524d31836aab4ffea5973"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::Thread::Thread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const F &amp;&#160;</td>
<td class="paramname"><em>f</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This constructor pattern mimics that in boost::thread. There is one constructor for each number of arguments that the thread function accepts. To extend the set of acceptable signatures, add another constructor with &lt;class F, class A1.... class An&gt;. In general:</p>
<ul>
<li>category: string identifying the thread category to which this thread belongs, used for organising threads together on the debug UI.</li>
<li>name: name of this thread. Will be appended with "-&lt;thread-id&gt;" to ensure uniqueness.</li>
<li>F - a method type that supports operator(), and the instance passed to the constructor is executed immediately in a separate thread.</li>
<li>A1...An - argument types whose instances are passed to f(...) </li>
</ul>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00061">61</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8cc_source.html#l00270">StartThread()</a>.</p>
</div>
</div>
<a class="anchor" id="a36c3cc9e249fd6faee3a38303587c9fc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F , class A1 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::Thread::Thread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const F &amp;&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A1 &amp;&#160;</td>
<td class="paramname"><em>a1</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00067">67</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8cc_source.html#l00270">StartThread()</a>.</p>
</div>
</div>
<a class="anchor" id="aaaade3dde1bacb8f5215851aeff8a60b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F , class A1 , class A2 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::Thread::Thread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const F &amp;&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A1 &amp;&#160;</td>
<td class="paramname"><em>a1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A2 &amp;&#160;</td>
<td class="paramname"><em>a2</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00073">73</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8cc_source.html#l00270">StartThread()</a>.</p>
</div>
</div>
<a class="anchor" id="adf0bd140e9a117cd17ec9b759ff7e211"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F , class A1 , class A2 , class A3 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::Thread::Thread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const F &amp;&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A1 &amp;&#160;</td>
<td class="paramname"><em>a1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A2 &amp;&#160;</td>
<td class="paramname"><em>a2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A3 &amp;&#160;</td>
<td class="paramname"><em>a3</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00080">80</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8cc_source.html#l00270">StartThread()</a>.</p>
</div>
</div>
<a class="anchor" id="af4df4ee99c148f00cdc3affde898c55f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F , class A1 , class A2 , class A3 , class A4 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::Thread::Thread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const F &amp;&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A1 &amp;&#160;</td>
<td class="paramname"><em>a1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A2 &amp;&#160;</td>
<td class="paramname"><em>a2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A3 &amp;&#160;</td>
<td class="paramname"><em>a3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A4 &amp;&#160;</td>
<td class="paramname"><em>a4</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00087">87</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8cc_source.html#l00270">StartThread()</a>.</p>
</div>
</div>
<a class="anchor" id="a9fbbab264db536d65642d4b006437c56"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class F , class A1 , class A2 , class A3 , class A4 , class A5 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::Thread::Thread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const F &amp;&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A1 &amp;&#160;</td>
<td class="paramname"><em>a1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A2 &amp;&#160;</td>
<td class="paramname"><em>a2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A3 &amp;&#160;</td>
<td class="paramname"><em>a3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A4 &amp;&#160;</td>
<td class="paramname"><em>a4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const A5 &amp;&#160;</td>
<td class="paramname"><em>a5</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00094">94</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8cc_source.html#l00270">StartThread()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5fad57e14b212d8d1bc61b2c00948047"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::Thread::Join </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>Blocks until this thread finishes execution. Once this method returns, the thread will be unregistered with the <a class="el" href="classimpala_1_1ThreadMgr.html">ThreadMgr</a> and will not appear in the debug UI. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00102">102</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8h_source.html#l00120">thread_</a>.</p>
<p>Referenced by <a class="el" href="thread-create-benchmark_8cc_source.html#l00087">ImpalaThreadStarter()</a>, and <a class="el" href="thread_8cc_source.html#l00327">impala::ThreadGroup::JoinAll()</a>.</p>
</div>
</div>
<a class="anchor" id="aaf91fd871c86273536d91802d0258247"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::Thread::StartThread </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classimpala_1_1Thread.html#a044ce27a118a6a677093b143743c2008">ThreadFunctor</a> &amp;&#160;</td>
<td class="paramname"><em>functor</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the thread running <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a>, and returns once that thread has initialised and its TID read. Waits for notification from the started thread that initialisation is complete before returning. </p>
<p>Definition at line <a class="el" href="thread_8cc_source.html#l00270">270</a> of file <a class="el" href="thread_8cc_source.html">thread.cc</a>.</p>
<p>References <a class="el" href="promise_8h_source.html#l00059">impala::Promise&lt; T &gt;::Get()</a>, and <a class="el" href="thread_8cc_source.html#l00043">impala::thread_manager</a>.</p>
<p>Referenced by <a class="el" href="thread_8h_source.html#l00061">Thread()</a>.</p>
</div>
</div>
<a class="anchor" id="a143f3a2eb86a90160a83a8220c78d83b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::Thread::SuperviseThread </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classimpala_1_1Thread.html#a044ce27a118a6a677093b143743c2008">ThreadFunctor</a>&#160;</td>
<td class="paramname"><em>functor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classimpala_1_1Promise.html">Promise</a>&lt; int64_t &gt; *&#160;</td>
<td class="paramname"><em>thread_started</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">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrapper for the user-supplied function. Always invoked from thread_. Executes the method in functor_, but before doing so registers with the global <a class="el" href="classimpala_1_1ThreadMgr.html">ThreadMgr</a> and reads the thread's system TID. After the method terminates, it is unregistered. <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a> notifies <a class="el" href="classimpala_1_1Thread.html#aaf91fd871c86273536d91802d0258247">StartThread()</a> when thread initialisation is completed via the promise parameter, which is set to the new thread's system ID. After this point, it is no longer safe for <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a> to refer to parameters passed by reference or pointer to this method, because of a wrinkle in the lifecycle of boost threads: if the thread object representing a thread should be destroyed, the actual operating-system thread continues to run (the thread is detached, not terminated). Therefore it's not safe to make reference to the <a class="el" href="classimpala_1_1Thread.html" title="TODO: Consider allowing fragment IDs as category parameters. ">Thread</a> object or any of its members in <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a> after it notifies the caller via thread_started that initialisation is completed. An alternative is to join() in the destructor of <a class="el" href="classimpala_1_1Thread.html" title="TODO: Consider allowing fragment IDs as category parameters. ">Thread</a>, but that's not the same semantics as boost::thread, which we are trying to emulate here. As a result, the 'functor' parameter is deliberately copied into this method, since it is used after the notification completes.h The tid parameter is written to exactly once before <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a> notifies the caller. </p>
<p>Definition at line <a class="el" href="thread_8cc_source.html#l00288">288</a> of file <a class="el" href="thread_8cc_source.html">thread.cc</a>.</p>
<p>References <a class="el" href="error-util_8cc_source.html#l00030">impala::GetStrErrMsg()</a>, <a class="el" href="cpu-info_8cc_source.html#l00050">impala::name</a>, <a class="el" href="promise_8h_source.html#l00038">impala::Promise&lt; T &gt;::Set()</a>, and <a class="el" href="thread_8cc_source.html#l00043">impala::thread_manager</a>.</p>
</div>
</div>
<a class="anchor" id="a70887ee3a48c1175d2a190a6e0afae67"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t impala::Thread::tid </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>The thread ID assigned to this thread by the operating system. If the OS does not support retrieving the tid, returns <a class="el" href="classimpala_1_1Thread.html#af33f21d868395845bec0e26e42ef3087">Thread::INVALID_THREAD_ID</a>. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00106">106</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>References <a class="el" href="thread_8h_source.html#l00129">tid_</a>.</p>
<p>Referenced by <a class="el" href="cgroups-mgr_8cc_source.html#l00142">impala::CgroupsMgr::AssignThreadToCgroup()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a153d05e96c0bdf3f444af8816250a061"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string impala::Thread::category_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Name and category for this thread. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00123">123</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="af33f21d868395845bec0e26e42ef3087"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int64_t impala::Thread::INVALID_THREAD_ID = -1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00108">108</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a31cecf874ff332b002d7d24c311d0ac1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string impala::Thread::name_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="thread_8h_source.html#l00124">124</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div>
</div>
<a class="anchor" id="a49f2214244a0fa8cb134d73450471581"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::scoped_ptr&lt;boost::thread&gt; impala::Thread::thread_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The actual thread object that runs the user's method via <a class="el" href="classimpala_1_1Thread.html#a143f3a2eb86a90160a83a8220c78d83b">SuperviseThread()</a>. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00120">120</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>Referenced by <a class="el" href="thread_8h_source.html#l00102">Join()</a>.</p>
</div>
</div>
<a class="anchor" id="a9f1c2ddb4140367deae98287becb9d21"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t impala::Thread::tid_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>OS-specific thread ID. Set to UNINITIALISED_THREAD_ID initially, but once the constructor returns from <a class="el" href="classimpala_1_1Thread.html#aaf91fd871c86273536d91802d0258247">StartThread()</a> the tid_ is guaranteed to be set either to a non-negative integer, or INVALID_THREAD_ID. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00129">129</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
<p>Referenced by <a class="el" href="thread_8h_source.html#l00106">tid()</a>.</p>
</div>
</div>
<a class="anchor" id="af4ae654033a8bfb4756e6eac91c68eea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int64_t impala::Thread::UNINITIALISED_THREAD_ID = -2</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To distinguish between a thread ID that can't be determined, and one that hasn't been assigned. Since tid_ is set in the constructor, this value will never be seen by clients of this class. </p>
<p>Definition at line <a class="el" href="thread_8h_source.html#l00114">114</a> of file <a class="el" href="thread_8h_source.html">thread.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/util/<a class="el" href="thread_8h_source.html">thread.h</a></li>
<li>be/src/util/<a class="el" href="thread_8cc_source.html">thread.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="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1Thread.html">Thread</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:51 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>