| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native C++ Reference: PdxReader.hpp Source File</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="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native C++ Reference |
|  <span id="projectnumber">1.13.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00164_source.html','');}); |
| /* @license-end */ |
| </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)"> |
| </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="headertitle"> |
| <div class="title">PdxReader.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef GEODE_PDXREADER_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define GEODE_PDXREADER_H_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="a00026.html">CacheableBuiltins.hpp</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "PdxUnreadFields.hpp"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>apache {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>geode {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>client {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>CacheableDate;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>CacheableObjectArray;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>PdxReader;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>PdxSerializer;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="a00759.html"> 58</a></span> <span class="keyword">class </span>APACHE_GEODE_EXPORT <a class="code" href="a00759.html">PdxReader</a> {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="a00759.html#a12dcb925fad3dff4f8bc7dac6cee8aa7"> 63</a></span>  <a class="code" href="a00759.html#a12dcb925fad3dff4f8bc7dac6cee8aa7">PdxReader</a>() {}</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="a00759.html#a8a15f7137d7e9cb7cfb9ea2fca16e677"> 68</a></span>  <span class="keyword">virtual</span> <a class="code" href="a00759.html#a8a15f7137d7e9cb7cfb9ea2fca16e677">~PdxReader</a>() {}</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> char16_t readChar(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> readBoolean(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> int8_t readByte(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">virtual</span> int16_t readShort(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">virtual</span> int32_t readInt(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">virtual</span> int64_t readLong(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> readFloat(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> readDouble(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">virtual</span> std::string readString(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">virtual</span> std::shared_ptr<Cacheable> readObject(</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keyword">virtual</span> std::vector<char16_t> readCharArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keyword">virtual</span> std::vector<bool> readBooleanArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">virtual</span> std::vector<int8_t> readByteArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keyword">virtual</span> std::vector<int16_t> readShortArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">virtual</span> std::vector<int32_t> readIntArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keyword">virtual</span> std::vector<int64_t> readLongArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">virtual</span> std::vector<float> readFloatArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keyword">virtual</span> std::vector<double> readDoubleArray(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keyword">virtual</span> std::vector<std::string> readStringArray(</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keyword">virtual</span> std::shared_ptr<CacheableObjectArray> readObjectArray(</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">virtual</span> int8_t** readArrayOfByteArrays(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  int32_t& arrayLength,</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  int32_t** elementLength) = 0;</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> </div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="keyword">virtual</span> std::shared_ptr<CacheableDate> readDate(</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  <span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> </div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> hasField(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> </div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isIdentityField(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> </div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  <span class="keyword">virtual</span> std::shared_ptr<PdxUnreadFields> readUnreadFields() = 0;</div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> </div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <span class="keyword">virtual</span> std::shared_ptr<PdxSerializer> getPdxSerializer() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> };</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> } <span class="comment">// namespace client</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> } <span class="comment">// namespace geode</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> } <span class="comment">// namespace apache</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> </div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="preprocessor">#endif // GEODE_PDXREADER_H_</span></div><div class="ttc" id="a00759_html"><div class="ttname"><a href="a00759.html">apache::geode::client::PdxReader</a></div><div class="ttdoc">A PdxReader will be passed to PdxSerializable.fromData or during deserialization of a PDX.</div><div class="ttdef"><b>Definition:</b> PdxReader.hpp:58</div></div> |
| <div class="ttc" id="a00026_html"><div class="ttname"><a href="a00026.html">CacheableBuiltins.hpp</a></div><div class="ttdoc">Contains generic template definitions for Cacheable types and instantiations for built-in types.</div></div> |
| <div class="ttc" id="a00759_html_a12dcb925fad3dff4f8bc7dac6cee8aa7"><div class="ttname"><a href="a00759.html#a12dcb925fad3dff4f8bc7dac6cee8aa7">apache::geode::client::PdxReader::PdxReader</a></div><div class="ttdeci">PdxReader()</div><div class="ttdoc">constructors</div><div class="ttdef"><b>Definition:</b> PdxReader.hpp:63</div></div> |
| <div class="ttc" id="a00759_html_a8a15f7137d7e9cb7cfb9ea2fca16e677"><div class="ttname"><a href="a00759.html#a8a15f7137d7e9cb7cfb9ea2fca16e677">apache::geode::client::PdxReader::~PdxReader</a></div><div class="ttdeci">virtual ~PdxReader()</div><div class="ttdoc">destructor</div><div class="ttdef"><b>Definition:</b> PdxReader.hpp:68</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache API Documentation</small></address> |