Apache Geode Native .NET Reference 1.15.0
Apache::Geode::Client::CacheableObjectXml Class Reference

A mutable generic System.Object wrapper that can serve as a distributable value for caching. More...

#include <CacheableObjectXml.hpp>

Inherits Apache::Geode::Client::ISerializable.

Public Member Functions

virtual String ^ ToString () override
 Return a string representation of the object. More...
 

Static Public Member Functions

static CacheableObjectXmlCreate (Object^ value)
 Static function to create a new instance from the given object. More...
 
static ISerializableCreateDeserializable ()
 Factory function to register this class. More...
 

Properties

Object^ Value [get]
 Gets the object value. More...
 

Detailed Description

A mutable generic System.Object wrapper that can serve as a distributable value for caching.

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 XmlSerializer 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.

The user must keep in mind that the rules that apply to XmlSerializer 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.

Member Function Documentation

◆ Create()

static CacheableObjectXml ^ Apache::Geode::Client::CacheableObjectXml::Create ( Object^  value)
inlinestatic

Static function to create a new instance from the given object.

If the given object is null then this method returns null.

◆ CreateDeserializable()

static ISerializable ^ Apache::Geode::Client::CacheableObjectXml::CreateDeserializable ( )
inlinestatic

Factory function to register this class.

◆ ToString()

virtual String ^ Apache::Geode::Client::CacheableObjectXml::ToString ( )
inlineoverridevirtual

Return a string representation of the object.

Implements Apache::Geode::Client::ISerializable.

Property Documentation

◆ Value

Object^ Apache::Geode::Client::CacheableObjectXml::Value
get

Gets the object value.

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.


Apache Geode C++ Cache .NET API Documentation