blob: 4ae196af1022d3073a3f80a06cdebc61ce78b3bd [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::ThriftThreadFactory 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_1ThriftThreadFactory.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="#pri-attribs">Private Attributes</a> &#124;
<a href="classimpala_1_1ThriftThreadFactory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::ThriftThreadFactory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for impala::ThriftThreadFactory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1ThriftThreadFactory__inherit__graph.svg" width="192" height="288"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div class="dynheader">
Collaboration diagram for impala::ThriftThreadFactory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1ThriftThreadFactory__coll__graph.svg" width="356" height="288"><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:a4f92c5705876d348deb0ac5c5429d0b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftThreadFactory.html#a4f92c5705876d348deb0ac5c5429d0b4">ThriftThreadFactory</a> (const std::string &amp;group, const std::string &amp;prefix)</td></tr>
<tr class="separator:a4f92c5705876d348deb0ac5c5429d0b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7dbd1fdd92c7afeb4dc7892cd3b4057"><td class="memItemLeft" align="right" valign="top">virtual boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="classapache_1_1thrift_1_1concurrency_1_1Thread.html">apache::thrift::concurrency::Thread</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftThreadFactory.html#ae7dbd1fdd92c7afeb4dc7892cd3b4057">newThread</a> (boost::shared_ptr&lt; apache::thrift::concurrency::Runnable &gt; runnable) const </td></tr>
<tr class="memdesc:ae7dbd1fdd92c7afeb4dc7892cd3b4057"><td class="mdescLeft">&#160;</td><td class="mdescRight">(From ThreadFactory) - creates a new <a class="el" href="classimpala_1_1ThriftThread.html">ThriftThread</a> to run the supplied <a class="el" href="classRunnable.html">Runnable</a>. <a href="#ae7dbd1fdd92c7afeb4dc7892cd3b4057">More...</a><br/></td></tr>
<tr class="separator:ae7dbd1fdd92c7afeb4dc7892cd3b4057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e0215aa14ee423163e735b297b75bb"><td class="memItemLeft" align="right" valign="top">virtual <br class="typebreak"/>
apache::thrift::concurrency::Thread::id_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftThreadFactory.html#a99e0215aa14ee423163e735b297b75bb">getCurrentThreadId</a> () const </td></tr>
<tr class="separator:a99e0215aa14ee423163e735b297b75bb"><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:a8efb2ee63e1906a5cb5aad98101716e7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftThreadFactory.html#a8efb2ee63e1906a5cb5aad98101716e7">group_</a></td></tr>
<tr class="memdesc:a8efb2ee63e1906a5cb5aad98101716e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group name for the Impala ThreadManager. <a href="#a8efb2ee63e1906a5cb5aad98101716e7">More...</a><br/></td></tr>
<tr class="separator:a8efb2ee63e1906a5cb5aad98101716e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e1674f3807e7b671dca6a2f0ca20133"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftThreadFactory.html#a1e1674f3807e7b671dca6a2f0ca20133">prefix_</a></td></tr>
<tr class="memdesc:a1e1674f3807e7b671dca6a2f0ca20133"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classimpala_1_1Thread.html" title="TODO: Consider allowing fragment IDs as category parameters. ">Thread</a> name prefix for the Impala ThreadManager. <a href="#a1e1674f3807e7b671dca6a2f0ca20133">More...</a><br/></td></tr>
<tr class="separator:a1e1674f3807e7b671dca6a2f0ca20133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc3dd5b5897ea645e532de8f27b740d7"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftThreadFactory.html#adc3dd5b5897ea645e532de8f27b740d7">count_</a></td></tr>
<tr class="separator:adc3dd5b5897ea645e532de8f27b740d7"><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>The <a class="el" href="classimpala_1_1ThriftThreadFactory.html">ThriftThreadFactory</a> is responsible for creating new ThriftThreads to run server tasks on. </p>
<p>Definition at line <a class="el" href="thrift-thread_8h_source.html#l00038">38</a> of file <a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4f92c5705876d348deb0ac5c5429d0b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::ThriftThreadFactory::ThriftThreadFactory </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>prefix</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>Group is the thread group for new threads to be assigned to, and prefix is the per-thread prefix (threads are named "prefix-&lt;count_&gt;-&lt;tid&gt;"). </p>
<p>Definition at line <a class="el" href="thrift-thread_8h_source.html#l00042">42</a> of file <a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a99e0215aa14ee423163e735b297b75bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">atc::Thread::id_t ThriftThreadFactory::getCurrentThreadId </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>(From ThreadFactory) - returns the <em>current</em> thread ID, i.e. the ID of the executing thread (which may not have been created by this factory). </p>
<p>Definition at line <a class="el" href="thrift-thread_8cc_source.html#l00064">64</a> of file <a class="el" href="thrift-thread_8cc_source.html">thrift-thread.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ae7dbd1fdd92c7afeb4dc7892cd3b4057"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">shared_ptr&lt; atc::Thread &gt; ThriftThreadFactory::newThread </td>
<td>(</td>
<td class="paramtype">boost::shared_ptr&lt; apache::thrift::concurrency::Runnable &gt;&#160;</td>
<td class="paramname"><em>runnable</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>(From ThreadFactory) - creates a new <a class="el" href="classimpala_1_1ThriftThread.html">ThriftThread</a> to run the supplied <a class="el" href="classRunnable.html">Runnable</a>. </p>
<p>Definition at line <a class="el" href="thrift-thread_8cc_source.html#l00044">44</a> of file <a class="el" href="thrift-thread_8cc_source.html">thrift-thread.cc</a>.</p>
<p>References <a class="el" href="thrift-thread_8h_source.html#l00062">count_</a>, <a class="el" href="thrift-thread_8h_source.html#l00055">group_</a>, <a class="el" href="cpu-info_8cc_source.html#l00050">impala::name</a>, and <a class="el" href="thrift-thread_8h_source.html#l00058">prefix_</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="adc3dd5b5897ea645e532de8f27b740d7"></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::ThriftThreadFactory::count_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Marked mutable because we want to increment it inside newThread, which for some reason is const. </p>
<p>Definition at line <a class="el" href="thrift-thread_8h_source.html#l00062">62</a> of file <a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a>.</p>
<p>Referenced by <a class="el" href="thrift-thread_8cc_source.html#l00044">newThread()</a>.</p>
</div>
</div>
<a class="anchor" id="a8efb2ee63e1906a5cb5aad98101716e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string impala::ThriftThreadFactory::group_</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>Group name for the Impala ThreadManager. </p>
<p>Definition at line <a class="el" href="thrift-thread_8h_source.html#l00055">55</a> of file <a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a>.</p>
<p>Referenced by <a class="el" href="thrift-thread_8cc_source.html#l00044">newThread()</a>.</p>
</div>
</div>
<a class="anchor" id="a1e1674f3807e7b671dca6a2f0ca20133"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string impala::ThriftThreadFactory::prefix_</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><a class="el" href="classimpala_1_1Thread.html" title="TODO: Consider allowing fragment IDs as category parameters. ">Thread</a> name prefix for the Impala ThreadManager. </p>
<p>Definition at line <a class="el" href="thrift-thread_8h_source.html#l00058">58</a> of file <a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a>.</p>
<p>Referenced by <a class="el" href="thrift-thread_8cc_source.html#l00044">newThread()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/rpc/<a class="el" href="thrift-thread_8h_source.html">thrift-thread.h</a></li>
<li>be/src/rpc/<a class="el" href="thrift-thread_8cc_source.html">thrift-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_1ThriftThreadFactory.html">ThriftThreadFactory</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:49 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>