| <!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: CacheableObjectArray.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.0</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('a00041_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">CacheableObjectArray.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="a00041.html">Go to the documentation of this file.</a><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_CACHEABLEOBJECTARRAY_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define GEODE_CACHEABLEOBJECTARRAY_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 <memory></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <vector></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="preprocessor">#include "Serializable.hpp"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "internal/DSCode.hpp"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "internal/DataSerializablePrimitive.hpp"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "internal/geode_globals.hpp"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>apache {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>geode {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>client {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>DataInput;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>DataOutput;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>Serializable;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="a00355.html"> 47</a></span> <span class="keyword">class </span>APACHE_GEODE_EXPORT <a class="code" href="a00355.html">CacheableObjectArray</a></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  : <span class="keyword">public</span> internal::DataSerializablePrimitive,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">public</span> std::vector<std::shared_ptr<Cacheable>> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="a00355.html#ac3c8dd47b0e568d034dd7acfcb181729"> 52</a></span>  <span class="keyword">inline</span> <a class="code" href="a00355.html#ac3c8dd47b0e568d034dd7acfcb181729">CacheableObjectArray</a>() : std::vector<std::shared_ptr<<a class="code" href="a00855.html">Cacheable</a>>>() {}</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="a00355.html#a13339173081709482608e7021d265a47"> 55</a></span>  <span class="keyword">inline</span> <span class="keyword">explicit</span> <a class="code" href="a00355.html#a13339173081709482608e7021d265a47">CacheableObjectArray</a>(int32_t n)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  : std::vector<std::shared_ptr<<a class="code" href="a00855.html">Cacheable</a>>>(n) {}</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  ~<a class="code" href="a00355.html">CacheableObjectArray</a>() noexcept override = default;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="a00355.html">CacheableObjectArray</a>& operator=(const <a class="code" href="a00355.html">CacheableObjectArray</a>& other) = delete;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="a00355.html">CacheableObjectArray</a>(const <a class="code" href="a00355.html">CacheableObjectArray</a>& other) = delete;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> toData(<a class="code" href="a00439.html">DataOutput</a>& output) const override;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  virtual <span class="keywordtype">void</span> fromData(<a class="code" href="a00435.html">DataInput</a>& input) override;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="a00355.html#a40c5c0ac18c33279b949565582e8c274"> 70</a></span>  inline static std::shared_ptr<<a class="code" href="a00855.html">Serializable</a>> createDeserializable() {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> std::make_shared<CacheableObjectArray>();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  internal::DSCode getDsCode()<span class="keyword"> const override </span>{</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> internal::DSCode::CacheableObjectArray;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="a00355.html#ab25b842c26d145f9c7e142c8f67388fa"> 81</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> std::shared_ptr<CacheableObjectArray> <a class="code" href="a00355.html#ab25b842c26d145f9c7e142c8f67388fa">create</a>() {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> std::make_shared<CacheableObjectArray>();</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="a00355.html#a2c5cf4ee87db88125612053dda21fcec"> 89</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> std::shared_ptr<CacheableObjectArray> <a class="code" href="a00355.html#a2c5cf4ee87db88125612053dda21fcec">create</a>(int32_t n) {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> std::make_shared<CacheableObjectArray>(n);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> objectSize() <span class="keyword">const override</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> } <span class="comment">// namespace client</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace geode</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> } <span class="comment">// namespace apache</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif // GEODE_CACHEABLEOBJECTARRAY_H_</span></div><div class="ttc" id="a00439_html"><div class="ttname"><a href="a00439.html">apache::geode::client::DataOutput</a></div><div class="ttdoc">Provide operations for writing primitive data values, byte arrays, strings, Serializable objects to a...</div><div class="ttdef"><b>Definition:</b> DataOutput.hpp:48</div></div> |
| <div class="ttc" id="a00355_html_ab25b842c26d145f9c7e142c8f67388fa"><div class="ttname"><a href="a00355.html#ab25b842c26d145f9c7e142c8f67388fa">apache::geode::client::CacheableObjectArray::create</a></div><div class="ttdeci">static std::shared_ptr< CacheableObjectArray > create()</div><div class="ttdoc">Factory method for creating the default instance of CacheableObjectArray.</div><div class="ttdef"><b>Definition:</b> CacheableObjectArray.hpp:81</div></div> |
| <div class="ttc" id="a00435_html"><div class="ttname"><a href="a00435.html">apache::geode::client::DataInput</a></div><div class="ttdoc">Provide operations for reading primitive data values, byte arrays, strings, Serializable objects from...</div><div class="ttdef"><b>Definition:</b> DataInput.hpp:59</div></div> |
| <div class="ttc" id="a00355_html"><div class="ttname"><a href="a00355.html">apache::geode::client::CacheableObjectArray</a></div><div class="ttdoc">Implements an immutable Vector of Cacheable objects that can serve as a distributable object for cach...</div><div class="ttdef"><b>Definition:</b> CacheableObjectArray.hpp:47</div></div> |
| <div class="ttc" id="a00855_html"><div class="ttname"><a href="a00855.html">apache::geode::client::Serializable</a></div><div class="ttdoc">This base class is the superclass of all user objects in the cache that can be serialized.</div><div class="ttdef"><b>Definition:</b> Serializable.hpp:53</div></div> |
| <div class="ttc" id="a00355_html_ac3c8dd47b0e568d034dd7acfcb181729"><div class="ttname"><a href="a00355.html#ac3c8dd47b0e568d034dd7acfcb181729">apache::geode::client::CacheableObjectArray::CacheableObjectArray</a></div><div class="ttdeci">CacheableObjectArray()</div><div class="ttdoc">Constructor, used for deserialization.</div><div class="ttdef"><b>Definition:</b> CacheableObjectArray.hpp:52</div></div> |
| <div class="ttc" id="a00355_html_a2c5cf4ee87db88125612053dda21fcec"><div class="ttname"><a href="a00355.html#a2c5cf4ee87db88125612053dda21fcec">apache::geode::client::CacheableObjectArray::create</a></div><div class="ttdeci">static std::shared_ptr< CacheableObjectArray > create(int32_t n)</div><div class="ttdoc">Factory method for creating an instance of CacheableObjectArray with given size.</div><div class="ttdef"><b>Definition:</b> CacheableObjectArray.hpp:89</div></div> |
| <div class="ttc" id="a00355_html_a13339173081709482608e7021d265a47"><div class="ttname"><a href="a00355.html#a13339173081709482608e7021d265a47">apache::geode::client::CacheableObjectArray::CacheableObjectArray</a></div><div class="ttdeci">CacheableObjectArray(int32_t n)</div><div class="ttdoc">Create a vector with n elements allocated.</div><div class="ttdef"><b>Definition:</b> CacheableObjectArray.hpp:55</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> |