| <!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::ImpalaServer::ScopedSessionState 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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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_1ImpalaServer_1_1ScopedSessionState.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </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> | |
| <a href="#pri-attribs">Private Attributes</a> | |
| <a href="classimpala_1_1ImpalaServer_1_1ScopedSessionState-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">impala::ImpalaServer::ScopedSessionState Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Collaboration diagram for impala::ImpalaServer::ScopedSessionState:</div> |
| <div class="dyncontent"> |
| <div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classimpala_1_1ImpalaServer_1_1ScopedSessionState__coll__graph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></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:a97dd7f555b5c90f913b1aa9992e3e243"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html#a97dd7f555b5c90f913b1aa9992e3e243">ScopedSessionState</a> (<a class="el" href="classimpala_1_1ImpalaServer.html">ImpalaServer</a> *impala)</td></tr> |
| <tr class="separator:a97dd7f555b5c90f913b1aa9992e3e243"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed2ad66c05d0da129316b812974995ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html#aed2ad66c05d0da129316b812974995ce">WithSession</a> (const TUniqueId &session_id, boost::shared_ptr< <a class="el" href="structimpala_1_1ImpalaServer_1_1SessionState.html">SessionState</a> > *session=NULL)</td></tr> |
| <tr class="separator:aed2ad66c05d0da129316b812974995ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5abeb730bad76be54c9a388e9fffa2ea"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html#a5abeb730bad76be54c9a388e9fffa2ea">~ScopedSessionState</a> ()</td></tr> |
| <tr class="memdesc:a5abeb730bad76be54c9a388e9fffa2ea"><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count so the session can be expired correctly. <a href="#a5abeb730bad76be54c9a388e9fffa2ea">More...</a><br/></td></tr> |
| <tr class="separator:a5abeb730bad76be54c9a388e9fffa2ea"><td class="memSeparator" colspan="2"> </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:ab3c001a1a094a356f769c8d4d6f95d26"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr< <a class="el" href="structimpala_1_1ImpalaServer_1_1SessionState.html">SessionState</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html#ab3c001a1a094a356f769c8d4d6f95d26">session_</a></td></tr> |
| <tr class="memdesc:ab3c001a1a094a356f769c8d4d6f95d26"><td class="mdescLeft"> </td><td class="mdescRight">Reference-counted pointer to the session state object. <a href="#ab3c001a1a094a356f769c8d4d6f95d26">More...</a><br/></td></tr> |
| <tr class="separator:ab3c001a1a094a356f769c8d4d6f95d26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a88201c21773090fe30d0d6787544cb08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1ImpalaServer.html">ImpalaServer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html#a88201c21773090fe30d0d6787544cb08">impala_</a></td></tr> |
| <tr class="memdesc:a88201c21773090fe30d0d6787544cb08"><td class="mdescLeft"> </td><td class="mdescRight">Saved so that we can access <a class="el" href="classimpala_1_1ImpalaServer.html">ImpalaServer</a> methods to get / return session state. <a href="#a88201c21773090fe30d0d6787544cb08">More...</a><br/></td></tr> |
| <tr class="separator:a88201c21773090fe30d0d6787544cb08"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Class that allows users of <a class="el" href="structimpala_1_1ImpalaServer_1_1SessionState.html">SessionState</a> to mark a session as in-use, and therefore immune to expiration. The marking is done in <a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html#aed2ad66c05d0da129316b812974995ce">WithSession()</a> and undone in the destructor, so this class can be used to 'check-out' a session for the duration of a scope. </p> |
| |
| <p>Definition at line <a class="el" href="impala-server_8h_source.html#l00842">842</a> of file <a class="el" href="impala-server_8h_source.html">impala-server.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a97dd7f555b5c90f913b1aa9992e3e243"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">impala::ImpalaServer::ScopedSessionState::ScopedSessionState </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classimpala_1_1ImpalaServer.html">ImpalaServer</a> * </td> |
| <td class="paramname"><em>impala</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>Definition at line <a class="el" href="impala-server_8h_source.html#l00844">844</a> of file <a class="el" href="impala-server_8h_source.html">impala-server.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5abeb730bad76be54c9a388e9fffa2ea"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">impala::ImpalaServer::ScopedSessionState::~ScopedSessionState </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>Decrements the reference count so the session can be expired correctly. </p> |
| |
| <p>Definition at line <a class="el" href="impala-server_8h_source.html#l00858">858</a> of file <a class="el" href="impala-server_8h_source.html">impala-server.h</a>.</p> |
| |
| <p>References <a class="el" href="impala-server_8h_source.html#l00869">impala_</a>, <a class="el" href="impala-server_8h_source.html#l00905">impala::ImpalaServer::MarkSessionInactive()</a>, and <a class="el" href="impala-server_8h_source.html#l00866">session_</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aed2ad66c05d0da129316b812974995ce"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::ImpalaServer::ScopedSessionState::WithSession </td> |
| <td>(</td> |
| <td class="paramtype">const TUniqueId & </td> |
| <td class="paramname"><em>session_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">boost::shared_ptr< <a class="el" href="structimpala_1_1ImpalaServer_1_1SessionState.html">SessionState</a> > * </td> |
| <td class="paramname"><em>session</em> = <code>NULL</code> </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>Marks a session as in-use, and saves it so that it can be unmarked when this object goes out of scope. Returns OK unless there is an error in GetSessionState. Must only be called once per <a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html">ScopedSessionState</a>. </p> |
| |
| <p>Definition at line <a class="el" href="impala-server_8h_source.html#l00849">849</a> of file <a class="el" href="impala-server_8h_source.html">impala-server.h</a>.</p> |
| |
| <p>References <a class="el" href="impala-server_8cc_source.html#l00965">impala::ImpalaServer::GetSessionState()</a>, <a class="el" href="impala-server_8h_source.html#l00869">impala_</a>, <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>, <a class="el" href="status_8h_source.html#l00242">RETURN_IF_ERROR</a>, and <a class="el" href="impala-server_8h_source.html#l00866">session_</a>.</p> |
| |
| <p>Referenced by <a class="el" href="impala-beeswax-server_8cc_source.html#l00435">impala::ImpalaServer::Cancel()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l00916">impala::ImpalaServer::CancelOperation()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00343">impala::ImpalaServer::close()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00447">impala::ImpalaServer::CloseInsert()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l00937">impala::ImpalaServer::CloseOperation()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00428">impala::ImpalaServer::dump_config()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00375">impala::ImpalaServer::echo()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00202">impala::ImpalaServer::executeAndWait()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l00398">impala::ImpalaServer::ExecuteMetadataOp()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l00683">impala::ImpalaServer::ExecuteStatement()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00253">impala::ImpalaServer::explain()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00272">impala::ImpalaServer::fetch()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00419">impala::ImpalaServer::get_default_configuration()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00385">impala::ImpalaServer::get_log()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00298">impala::ImpalaServer::get_results_metadata()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00355">impala::ImpalaServer::get_state()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00482">impala::ImpalaServer::GetExecSummary()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l00655">impala::ImpalaServer::GetInfo()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l01049">impala::ImpalaServer::GetLog()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l00960">impala::ImpalaServer::GetResultSetMetadata()</a>, <a class="el" href="impala-hs2-server_8cc_source.html#l01105">impala::ImpalaServer::GetRuntimeProfile()</a>, <a class="el" href="impala-beeswax-server_8cc_source.html#l00494">impala::ImpalaServer::PingImpalaService()</a>, and <a class="el" href="impala-beeswax-server_8cc_source.html#l00171">impala::ImpalaServer::query()</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a88201c21773090fe30d0d6787544cb08"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1ImpalaServer.html">ImpalaServer</a>* impala::ImpalaServer::ScopedSessionState::impala_</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>Saved so that we can access <a class="el" href="classimpala_1_1ImpalaServer.html">ImpalaServer</a> methods to get / return session state. </p> |
| |
| <p>Definition at line <a class="el" href="impala-server_8h_source.html#l00869">869</a> of file <a class="el" href="impala-server_8h_source.html">impala-server.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="impala-server_8h_source.html#l00849">WithSession()</a>, and <a class="el" href="impala-server_8h_source.html#l00858">~ScopedSessionState()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab3c001a1a094a356f769c8d4d6f95d26"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">boost::shared_ptr<<a class="el" href="structimpala_1_1ImpalaServer_1_1SessionState.html">SessionState</a>> impala::ImpalaServer::ScopedSessionState::session_</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>Reference-counted pointer to the session state object. </p> |
| |
| <p>Definition at line <a class="el" href="impala-server_8h_source.html#l00866">866</a> of file <a class="el" href="impala-server_8h_source.html">impala-server.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="impala-server_8h_source.html#l00849">WithSession()</a>, and <a class="el" href="impala-server_8h_source.html#l00858">~ScopedSessionState()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>be/src/service/<a class="el" href="impala-server_8h_source.html">impala-server.h</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_1ImpalaServer.html">ImpalaServer</a></li><li class="navelem"><a class="el" href="classimpala_1_1ImpalaServer_1_1ScopedSessionState.html">ScopedSessionState</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> |
