| <!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::ThriftSerializer 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_1ThriftSerializer.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_1ThriftSerializer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">impala::ThriftSerializer Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for impala::ThriftSerializer:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1ThriftSerializer__coll__graph.svg" width="308" height="304"><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:a6f18c14f9f0a101141e3966963c9847c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftSerializer.html#a6f18c14f9f0a101141e3966963c9847c">ThriftSerializer</a> (<a class="el" href="classbool.html">bool</a> compact, int initial_buffer_size=1024)</td></tr> |
| <tr class="separator:a6f18c14f9f0a101141e3966963c9847c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adeb56b50d58ccb1ba6750e20615ae545"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:adeb56b50d58ccb1ba6750e20615ae545"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftSerializer.html#adeb56b50d58ccb1ba6750e20615ae545">Serialize</a> (T *obj, std::vector< uint8_t > *result)</td></tr> |
| <tr class="memdesc:adeb56b50d58ccb1ba6750e20615ae545"><td class="mdescLeft"> </td><td class="mdescRight">Serializes obj into result. Result will contain a copy of the memory. <a href="#adeb56b50d58ccb1ba6750e20615ae545">More...</a><br/></td></tr> |
| <tr class="separator:adeb56b50d58ccb1ba6750e20615ae545"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aab3a906dd543865eb626c9f42086af3c"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:aab3a906dd543865eb626c9f42086af3c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftSerializer.html#aab3a906dd543865eb626c9f42086af3c">Serialize</a> (T *obj, uint32_t *len, uint8_t **buffer)</td></tr> |
| <tr class="separator:aab3a906dd543865eb626c9f42086af3c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a47bcacc88d331ed65a3ecf6970349347"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a47bcacc88d331ed65a3ecf6970349347"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftSerializer.html#a47bcacc88d331ed65a3ecf6970349347">Serialize</a> (T *obj, std::string *result)</td></tr> |
| <tr class="separator:a47bcacc88d331ed65a3ecf6970349347"><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:aba46de27bde85eeeeea466383c9c8aec"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr<br class="typebreak"/> |
| < apache::thrift::transport::TMemoryBuffer > </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftSerializer.html#aba46de27bde85eeeeea466383c9c8aec">mem_buffer_</a></td></tr> |
| <tr class="separator:aba46de27bde85eeeeea466383c9c8aec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ae1306bf9d4a4b846dacd06dc93adc8"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr<br class="typebreak"/> |
| < apache::thrift::protocol::TProtocol > </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1ThriftSerializer.html#a5ae1306bf9d4a4b846dacd06dc93adc8">protocol_</a></td></tr> |
| <tr class="separator:a5ae1306bf9d4a4b846dacd06dc93adc8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Utility class to serialize thrift objects to a binary format. This object should be reused if possible to reuse the underlying memory. Note: thrift will encode NULLs into the serialized buffer so it is not valid to treat it as a string. </p> |
| |
| <p>Definition at line <a class="el" href="thrift-util_8h_source.html#l00039">39</a> of file <a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a6f18c14f9f0a101141e3966963c9847c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">impala::ThriftSerializer::ThriftSerializer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classbool.html">bool</a> </td> |
| <td class="paramname"><em>compact</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>initial_buffer_size</em> = <code>1024</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>If compact, the objects will be serialized using the Compact Protocol. Otherwise, we'll use the binary protocol. Note: the deserializer must be matching. </p> |
| |
| <p>Definition at line <a class="el" href="thrift-util_8cc_source.html#l00066">66</a> of file <a class="el" href="thrift-util_8cc_source.html">thrift-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="thrift-util_8h_source.html#l00089">mem_buffer_</a>, and <a class="el" href="thrift-util_8h_source.html#l00090">protocol_</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="adeb56b50d58ccb1ba6750e20615ae545"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class T > </div> |
| <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::ThriftSerializer::Serialize </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>obj</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< uint8_t > * </td> |
| <td class="paramname"><em>result</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serializes obj into result. Result will contain a copy of the memory. </p> |
| |
| <p>Definition at line <a class="el" href="thrift-util_8h_source.html#l00048">48</a> of file <a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>.</p> |
| |
| <p>References <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>, and <a class="el" href="status_8h_source.html#l00242">RETURN_IF_ERROR</a>.</p> |
| |
| <p>Referenced by <a class="el" href="admission-controller_8cc_source.html#l00568">impala::AdmissionController::AddPoolUpdates()</a>, <a class="el" href="catalog-server_8cc_source.html#l00295">impala::CatalogServer::BuildTopicUpdates()</a>, <a class="el" href="thrift-enc-test_8cc_source.html#l00011">main()</a>, <a class="el" href="jni-thrift-util_8h_source.html#l00027">impala::SerializeThriftMsg()</a>, and <a class="el" href="thrift-util-test_8cc_source.html#l00029">impala::TEST()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aab3a906dd543865eb626c9f42086af3c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class T > </div> |
| <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::ThriftSerializer::Serialize </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>obj</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t * </td> |
| <td class="paramname"><em>len</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint8_t ** </td> |
| <td class="paramname"><em>buffer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Serialize obj into a memory buffer. The result is returned in buffer/len. The memory returned is owned by this object and will be invalid when another object is serialized. </p> |
| |
| <p>Definition at line <a class="el" href="thrift-util_8h_source.html#l00061">61</a> of file <a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>.</p> |
| |
| <p>References <a class="el" href="thrift-util_8h_source.html#l00089">mem_buffer_</a>, <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>, and <a class="el" href="thrift-util_8h_source.html#l00090">protocol_</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a47bcacc88d331ed65a3ecf6970349347"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class T > </div> |
| <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::ThriftSerializer::Serialize </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>obj</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string * </td> |
| <td class="paramname"><em>result</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="thrift-util_8h_source.html#l00075">75</a> of file <a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>.</p> |
| |
| <p>References <a class="el" href="thrift-util_8h_source.html#l00089">mem_buffer_</a>, <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>, and <a class="el" href="thrift-util_8h_source.html#l00090">protocol_</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="aba46de27bde85eeeeea466383c9c8aec"></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<apache::thrift::transport::TMemoryBuffer> impala::ThriftSerializer::mem_buffer_</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="thrift-util_8h_source.html#l00089">89</a> of file <a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="thrift-util_8h_source.html#l00061">Serialize()</a>, and <a class="el" href="thrift-util_8cc_source.html#l00066">ThriftSerializer()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5ae1306bf9d4a4b846dacd06dc93adc8"></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<apache::thrift::protocol::TProtocol> impala::ThriftSerializer::protocol_</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="thrift-util_8h_source.html#l00090">90</a> of file <a class="el" href="thrift-util_8h_source.html">thrift-util.h</a>.</p> |
| |
| <p>Referenced by <a class="el" href="thrift-util_8h_source.html#l00061">Serialize()</a>, and <a class="el" href="thrift-util_8cc_source.html#l00066">ThriftSerializer()</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-util_8h_source.html">thrift-util.h</a></li> |
| <li>be/src/rpc/<a class="el" href="thrift-util_8cc_source.html">thrift-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_1ThriftSerializer.html">ThriftSerializer</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> |
