blob: 50365acc9fd367c4c3f0fa6b469878e7b4c4b71f [file] [log] [blame]
<!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: apache::geode::client::CacheableObjectArray 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00355.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">apache::geode::client::CacheableObjectArray Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implements an immutable Vector of <code>Cacheable</code> objects that can serve as a distributable object for caching.
<a href="a00355.html#details">More...</a></p>
<p>Inherits DataSerializablePrimitive, and vector&lt; std::shared_ptr&lt; Cacheable &gt; &gt;.</p>
<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:ac3c8dd47b0e568d034dd7acfcb181729"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00355.html#ac3c8dd47b0e568d034dd7acfcb181729">CacheableObjectArray</a> ()</td></tr>
<tr class="memdesc:ac3c8dd47b0e568d034dd7acfcb181729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, used for deserialization. <a href="#ac3c8dd47b0e568d034dd7acfcb181729">More...</a><br /></td></tr>
<tr class="separator:ac3c8dd47b0e568d034dd7acfcb181729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13339173081709482608e7021d265a47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00355.html#a13339173081709482608e7021d265a47">CacheableObjectArray</a> (int32_t n)</td></tr>
<tr class="memdesc:a13339173081709482608e7021d265a47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a vector with n elements allocated. <a href="#a13339173081709482608e7021d265a47">More...</a><br /></td></tr>
<tr class="separator:a13339173081709482608e7021d265a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab25b842c26d145f9c7e142c8f67388fa"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="a00355.html">CacheableObjectArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00355.html#ab25b842c26d145f9c7e142c8f67388fa">create</a> ()</td></tr>
<tr class="memdesc:ab25b842c26d145f9c7e142c8f67388fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Factory method for creating the default instance of <a class="el" href="a00355.html" title="Implements an immutable Vector of Cacheable objects that can serve as a distributable object for cach...">CacheableObjectArray</a>. <a href="#ab25b842c26d145f9c7e142c8f67388fa">More...</a><br /></td></tr>
<tr class="separator:ab25b842c26d145f9c7e142c8f67388fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c5cf4ee87db88125612053dda21fcec"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="a00355.html">CacheableObjectArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00355.html#a2c5cf4ee87db88125612053dda21fcec">create</a> (int32_t n)</td></tr>
<tr class="memdesc:a2c5cf4ee87db88125612053dda21fcec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Factory method for creating an instance of <a class="el" href="a00355.html" title="Implements an immutable Vector of Cacheable objects that can serve as a distributable object for cach...">CacheableObjectArray</a> with given size. <a href="#a2c5cf4ee87db88125612053dda21fcec">More...</a><br /></td></tr>
<tr class="separator:a2c5cf4ee87db88125612053dda21fcec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40c5c0ac18c33279b949565582e8c274"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="a00855.html">Serializable</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00355.html#a40c5c0ac18c33279b949565582e8c274">createDeserializable</a> ()</td></tr>
<tr class="memdesc:a40c5c0ac18c33279b949565582e8c274"><td class="mdescLeft">&#160;</td><td class="mdescRight">creation function for java Object[] <a href="#a40c5c0ac18c33279b949565582e8c274">More...</a><br /></td></tr>
<tr class="separator:a40c5c0ac18c33279b949565582e8c274"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implements an immutable Vector of <code>Cacheable</code> objects that can serve as a distributable object for caching. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac3c8dd47b0e568d034dd7acfcb181729"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3c8dd47b0e568d034dd7acfcb181729">&#9670;&nbsp;</a></span>CacheableObjectArray() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">apache::geode::client::CacheableObjectArray::CacheableObjectArray </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>Constructor, used for deserialization. </p>
</div>
</div>
<a id="a13339173081709482608e7021d265a47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13339173081709482608e7021d265a47">&#9670;&nbsp;</a></span>CacheableObjectArray() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">apache::geode::client::CacheableObjectArray::CacheableObjectArray </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a vector with n elements allocated. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab25b842c26d145f9c7e142c8f67388fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab25b842c26d145f9c7e142c8f67388fa">&#9670;&nbsp;</a></span>create() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::shared_ptr&lt;<a class="el" href="a00355.html">CacheableObjectArray</a>&gt; apache::geode::client::CacheableObjectArray::create </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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Factory method for creating the default instance of <a class="el" href="a00355.html" title="Implements an immutable Vector of Cacheable objects that can serve as a distributable object for cach...">CacheableObjectArray</a>. </p>
</div>
</div>
<a id="a2c5cf4ee87db88125612053dda21fcec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c5cf4ee87db88125612053dda21fcec">&#9670;&nbsp;</a></span>create() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::shared_ptr&lt;<a class="el" href="a00355.html">CacheableObjectArray</a>&gt; apache::geode::client::CacheableObjectArray::create </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Factory method for creating an instance of <a class="el" href="a00355.html" title="Implements an immutable Vector of Cacheable objects that can serve as a distributable object for cach...">CacheableObjectArray</a> with given size. </p>
</div>
</div>
<a id="a40c5c0ac18c33279b949565582e8c274"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40c5c0ac18c33279b949565582e8c274">&#9670;&nbsp;</a></span>createDeserializable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::shared_ptr&lt;<a class="el" href="a00855.html">Serializable</a>&gt; apache::geode::client::CacheableObjectArray::createDeserializable </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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>creation function for java Object[] </p>
</div>
</div>
</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>