| <!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: PdxWriter.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('a00179_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">PdxWriter.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_PDXWRITER_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define GEODE_PDXWRITER_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 "<a class="code" href="a00029.html">CacheableDate.hpp</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "internal/geode_globals.hpp"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>apache {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>geode {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>client {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </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>PdxSerializer;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>PdxUnreadFields;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="a00779.html"> 41</a></span> <span class="keyword">class </span>APACHE_GEODE_EXPORT <a class="code" href="a00779.html">PdxWriter</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="a00779.html">PdxWriter</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="a00779.html">PdxWriter</a>(<a class="code" href="a00779.html">PdxWriter</a>&& move) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> ~<a class="code" href="a00779.html">PdxWriter</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeChar(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  char16_t value) = 0;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeBoolean(<span class="keyword">const</span> std::string& fieldName, <span class="keywordtype">bool</span> value) = 0;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeByte(<span class="keyword">const</span> std::string& fieldName, int8_t value) = 0;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeShort(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  int16_t value) = 0;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeInt(<span class="keyword">const</span> std::string& fieldName, int32_t value) = 0;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeLong(<span class="keyword">const</span> std::string& fieldName, int64_t value) = 0;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeFloat(<span class="keyword">const</span> std::string& fieldName, <span class="keywordtype">float</span> value) = 0;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeDouble(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">double</span> value) = 0;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeDate(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  std::shared_ptr<CacheableDate> date) = 0;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeString(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">const</span> std::string& value) = 0;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeObject(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  std::shared_ptr<Cacheable> value) = 0;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeBooleanArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keyword">const</span> std::vector<bool>& array) = 0;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeCharArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">const</span> std::vector<char16_t>& array) = 0;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeByteArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">const</span> std::vector<int8_t>& array) = 0;</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> </div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeShortArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keyword">const</span> std::vector<int16_t>& array) = 0;</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeIntArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keyword">const</span> std::vector<int32_t>& array) = 0;</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeLongArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keyword">const</span> std::vector<int64_t>& array) = 0;</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> </div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeFloatArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keyword">const</span> std::vector<float>& array) = 0;</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeDoubleArray(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="keyword">const</span> std::vector<double>& array) = 0;</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeStringArray(</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  <span class="keyword">const</span> std::string& fieldName, <span class="keyword">const</span> std::vector<std::string>& array) = 0;</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeObjectArray(</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  <span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  std::shared_ptr<CacheableObjectArray> array) = 0;</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> </div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeArrayOfByteArrays(<span class="keyword">const</span> std::string& fieldName,</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  int8_t* <span class="keyword">const</span>* <span class="keyword">const</span> array,</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keywordtype">int</span> arrayLength,</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  <span class="keyword">const</span> <span class="keywordtype">int</span>* elementLength) = 0;</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& markIdentityField(<span class="keyword">const</span> std::string& fieldName) = 0;</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> </div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  <span class="keyword">virtual</span> <a class="code" href="a00779.html">PdxWriter</a>& writeUnreadFields(</div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  std::shared_ptr<PdxUnreadFields> unread) = 0;</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span> </div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <span class="keyword">virtual</span> std::shared_ptr<PdxSerializer> getPdxSerializer() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span> };</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span> } <span class="comment">// namespace client</span></div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span> } <span class="comment">// namespace geode</span></div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span> } <span class="comment">// namespace apache</span></div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span> </div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor">#endif // GEODE_PDXWRITER_H_</span></div><div class="ttc" id="a00779_html"><div class="ttname"><a href="a00779.html">apache::geode::client::PdxWriter</a></div><div class="ttdoc">A PdxWriter will be passed to PdxSerializable.toData when it is serializing the domain class.</div><div class="ttdef"><b>Definition:</b> PdxWriter.hpp:41</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="a00029_html"><div class="ttname"><a href="a00029.html">CacheableDate.hpp</a></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> |