| <!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 .NET Reference: Apache::Geode::Client::CacheableObjectXml 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&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 .NET 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('a00514.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> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::CacheableObjectXml Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A mutable generic System.Object wrapper that can serve as a distributable value for caching. |
| <a href="a00514.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="a01022.html">Apache::Geode::Client::ISerializable</a>.</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:acb81de701828d0a509b62c2df1cb9be4"><td class="memItemLeft" align="right" valign="top">virtual String ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00514.html#acb81de701828d0a509b62c2df1cb9be4">ToString</a> () override</td></tr> |
| <tr class="memdesc:acb81de701828d0a509b62c2df1cb9be4"><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of the object. <a href="#acb81de701828d0a509b62c2df1cb9be4">More...</a><br /></td></tr> |
| <tr class="separator:acb81de701828d0a509b62c2df1cb9be4"><td class="memSeparator" colspan="2"> </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:a493da3a5dd4860d75895542691f49b78"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00514.html">CacheableObjectXml</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00514.html#a493da3a5dd4860d75895542691f49b78">Create</a> (Object^ value)</td></tr> |
| <tr class="memdesc:a493da3a5dd4860d75895542691f49b78"><td class="mdescLeft"> </td><td class="mdescRight">Static function to create a new instance from the given object. <a href="#a493da3a5dd4860d75895542691f49b78">More...</a><br /></td></tr> |
| <tr class="separator:a493da3a5dd4860d75895542691f49b78"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ecab734eb0f3ce6f1db3f739d22cf4e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a01022.html">ISerializable</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00514.html#a9ecab734eb0f3ce6f1db3f739d22cf4e">CreateDeserializable</a> ()</td></tr> |
| <tr class="memdesc:a9ecab734eb0f3ce6f1db3f739d22cf4e"><td class="mdescLeft"> </td><td class="mdescRight">Factory function to register this class. <a href="#a9ecab734eb0f3ce6f1db3f739d22cf4e">More...</a><br /></td></tr> |
| <tr class="separator:a9ecab734eb0f3ce6f1db3f739d22cf4e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:ac1f002428b8df964b416680a045f36b5"><td class="memItemLeft" align="right" valign="top">Object^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00514.html#ac1f002428b8df964b416680a045f36b5">Value</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac1f002428b8df964b416680a045f36b5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the object value. <a href="#ac1f002428b8df964b416680a045f36b5">More...</a><br /></td></tr> |
| <tr class="separator:ac1f002428b8df964b416680a045f36b5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A mutable generic System.Object wrapper that can serve as a distributable value for caching. </p> |
| <p>This class can contain any object and uses the System.Xml.Serialization.XmlSerializer to serialize and deserialize the object. So the user must use the <code>XmlSerializer</code> attributes to control the serialization/deserialization of the object (or implement the System.Xml.Serialization.IXmlSerializable) to change the serialization/deserialization. However, the latter should be avoided for efficiency reasons and the user should implement ../../ISerializable instead. </p> |
| <p>The user must keep in mind that the rules that apply to <code>XmlSerializer</code> would be the rules that apply to this class. For instance the user cannot pass objects of class implementing or containing System.Collections.IDictionary class, must use System.Xml.Serialization.XmlIncludeAttribute to mark user-defined types etc. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a493da3a5dd4860d75895542691f49b78"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a493da3a5dd4860d75895542691f49b78">◆ </a></span>Create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00514.html">CacheableObjectXml</a> ^ Apache::Geode::Client::CacheableObjectXml::Create </td> |
| <td>(</td> |
| <td class="paramtype">Object^ </td> |
| <td class="paramname"><em>value</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>Static function to create a new instance from the given object. </p> |
| <p>If the given object is null then this method returns null. </p> |
| |
| </div> |
| </div> |
| <a id="a9ecab734eb0f3ce6f1db3f739d22cf4e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ecab734eb0f3ce6f1db3f739d22cf4e">◆ </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 <a class="el" href="a01022.html">ISerializable</a> ^ Apache::Geode::Client::CacheableObjectXml::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>Factory function to register this class. </p> |
| |
| </div> |
| </div> |
| <a id="acb81de701828d0a509b62c2df1cb9be4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acb81de701828d0a509b62c2df1cb9be4">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual String ^ Apache::Geode::Client::CacheableObjectXml::ToString </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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return a string representation of the object. </p> |
| |
| <p>Implements <a class="el" href="a01022.html#a335290fd15fd41d39bc73a7ca10d19bd">Apache::Geode::Client::ISerializable</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ac1f002428b8df964b416680a045f36b5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac1f002428b8df964b416680a045f36b5">◆ </a></span>Value</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Object^ Apache::Geode::Client::CacheableObjectXml::Value</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the object value. </p> |
| <p>The user can modify the object and the changes shall be reflected immediately in the local cache. For this change to be propagate to other members of the distributed system, the object needs to be put into the cache. </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 .NET API Documentation</small></address> |
