blob: d4cd884224ca341f1061796db66c6268f86a9d31 [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::JniLocalFrame 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_1JniLocalFrame.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_1JniLocalFrame-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::JniLocalFrame Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="jni-util_8h_source.html">jni-util.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::JniLocalFrame:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1JniLocalFrame__coll__graph.svg" width="163" height="259"><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:a3c6fc0103b016c858b73cafb51bed4fa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1JniLocalFrame.html#a3c6fc0103b016c858b73cafb51bed4fa">JniLocalFrame</a> ()</td></tr>
<tr class="separator:a3c6fc0103b016c858b73cafb51bed4fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe5ce44e03b9e1f8ccb25beea88df468"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1JniLocalFrame.html#abe5ce44e03b9e1f8ccb25beea88df468">~JniLocalFrame</a> ()</td></tr>
<tr class="separator:abe5ce44e03b9e1f8ccb25beea88df468"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d616a1464428c11712685fcdd25aa57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1JniLocalFrame.html#a4d616a1464428c11712685fcdd25aa57">push</a> (JNIEnv *env, int max_local_ref=10)</td></tr>
<tr class="separator:a4d616a1464428c11712685fcdd25aa57"><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:a11791920b1121dc3f6e2323139aad370"><td class="memItemLeft" align="right" valign="top">JNIEnv *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1JniLocalFrame.html#a11791920b1121dc3f6e2323139aad370">env_</a></td></tr>
<tr class="separator:a11791920b1121dc3f6e2323139aad370"><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>Utility class to push/pop a single JNI frame. "push" will push a JNI frame and the d'tor will pop the JNI frame. Frames establish a scope for local references. Local references go out of scope when their frame is popped, which enables the GC to clean up the corresponding objects. </p>
<p>Definition at line <a class="el" href="jni-util_8h_source.html#l00133">133</a> of file <a class="el" href="jni-util_8h_source.html">jni-util.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3c6fc0103b016c858b73cafb51bed4fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::JniLocalFrame::JniLocalFrame </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>Definition at line <a class="el" href="jni-util_8h_source.html#l00135">135</a> of file <a class="el" href="jni-util_8h_source.html">jni-util.h</a>.</p>
</div>
</div>
<a class="anchor" id="abe5ce44e03b9e1f8ccb25beea88df468"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::JniLocalFrame::~JniLocalFrame </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>Definition at line <a class="el" href="jni-util_8h_source.html#l00136">136</a> of file <a class="el" href="jni-util_8h_source.html">jni-util.h</a>.</p>
<p>References <a class="el" href="jni-util_8h_source.html#l00145">env_</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4d616a1464428c11712685fcdd25aa57"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::JniLocalFrame::push </td>
<td>(</td>
<td class="paramtype">JNIEnv *&#160;</td>
<td class="paramname"><em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_local_ref</em> = <code>10</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes a new JNI local frame. The frame can support max_local_ref local references. The number of local references created inside the frame might exceed max_local_ref, but there is no guarantee that memory will be available. Push should be called at most once. </p>
<p>Definition at line <a class="el" href="jni-util_8cc_source.html#l00034">34</a> of file <a class="el" href="jni-util_8cc_source.html">jni-util.cc</a>.</p>
<p>References <a class="el" href="jni-util_8h_source.html#l00145">env_</a>, and <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>.</p>
<p>Referenced by <a class="el" href="external-data-source-executor_8cc_source.html#l00086">CallJniMethod()</a>, <a class="el" href="jni-util_8h_source.html#l00231">impala::JniUtil::CallJniMethod()</a>, <a class="el" href="expr-benchmark_8cc_source.html#l00056">Planner::GeneratePlan()</a>, <a class="el" href="catalog_8cc_source.html#l00087">impala::Catalog::GetAllCatalogObjects()</a>, <a class="el" href="catalog_8cc_source.html#l00079">impala::Catalog::GetCatalogVersion()</a>, <a class="el" href="hbase-table-scanner_8cc_source.html#l00641">impala::HBaseTableScanner::GetCurrentValue()</a>, <a class="el" href="hbase-table-scanner_8cc_source.html#l00406">impala::HBaseTableScanner::HandleResultScannerTimeout()</a>, <a class="el" href="hbase-table_8cc_source.html#l00068">impala::HBaseTable::Init()</a>, <a class="el" href="external-data-source-executor_8cc_source.html#l00035">impala::ExternalDataSourceExecutor::Init()</a>, <a class="el" href="hbase-table-scanner_8cc_source.html#l00435">impala::HBaseTableScanner::InitScanRange()</a>, <a class="el" href="fe-support_8cc_source.html#l00072">Java_com_cloudera_impala_service_FeSupport_NativeEvalConstExprs()</a>, <a class="el" href="hbase-table-scanner_8cc_source.html#l00501">impala::HBaseTableScanner::Next()</a>, <a class="el" href="hive-udf-call_8cc_source.html#l00176">impala::HiveUdfCall::Open()</a>, <a class="el" href="hbase-table-scanner_8cc_source.html#l00290">impala::HBaseTableScanner::ScanSetup()</a>, <a class="el" href="frontend_8cc_source.html#l00228">impala::Frontend::SetCatalogInitialized()</a>, and <a class="el" href="frontend_8cc_source.html#l00183">impala::Frontend::ValidateSettings()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a11791920b1121dc3f6e2323139aad370"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">JNIEnv* impala::JniLocalFrame::env_</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="jni-util_8h_source.html#l00145">145</a> of file <a class="el" href="jni-util_8h_source.html">jni-util.h</a>.</p>
<p>Referenced by <a class="el" href="jni-util_8cc_source.html#l00034">push()</a>, and <a class="el" href="jni-util_8h_source.html#l00136">~JniLocalFrame()</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="jni-util_8h_source.html">jni-util.h</a></li>
<li>be/src/util/<a class="el" href="jni-util_8cc_source.html">jni-util.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_1JniLocalFrame.html">JniLocalFrame</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:50 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>