Apache::Geode::Client::CacheableObjectXml Class Reference

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

Inherits Apache::Geode::Client::IGeodeSerializable.

Public Member Functions
virtual IGeodeSerializable ^	FromData (DataInput^ input)
	Deserializes the System.Object using System.Xml.Serialization.XmlSerializer class. More...
virtual void	ToData (DataOutput^ output)
	Serializes this System.Object using System.Xml.Serialization.XmlSerializer class. More...
virtual String ^	ToString () override
	Return a string representation of the object. More...

Static Public Member Functions
static CacheableObjectXml ^	Create (Object^ value)
	Static function to create a new instance from the given object. More...
static IGeodeSerializable ^	CreateDeserializable ()
	Factory function to register this class. More...

Properties
virtual System::UInt32	ClassId [get]
	Returns the classId of the instance being serialized. More...
virtual System::UInt32	ObjectSize [get]
	return the size of this object in bytes More...
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 ../../IGeodeSerializable 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 IGeodeSerializable ^ Apache::Geode::Client::CacheableObjectXml::CreateDeserializable ( )

inlinestatic

Factory function to register this class.

FromData()

virtual IGeodeSerializable ^ Apache::Geode::Client::CacheableObjectXml::FromData ( DataInput^  input )

virtual

Deserializes the System.Object using System.Xml.Serialization.XmlSerializer class.

Parameters

input

the DataInput stream to use for reading the object data

Returns

the deserialized object

Implements Apache::Geode::Client::IGeodeSerializable.

ToData()

virtual void Apache::Geode::Client::CacheableObjectXml::ToData ( DataOutput^  output )

virtual

Serializes this System.Object using System.Xml.Serialization.XmlSerializer class.

Parameters

output

the DataOutput object to use for serializing the object

Implements Apache::Geode::Client::IGeodeSerializable.

ToString()

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

inlineoverridevirtual

Return a string representation of the object.

Implements Apache::Geode::Client::IGeodeSerializable.

Property Documentation

ClassId

virtual System:: UInt32 Apache::Geode::Client::CacheableObjectXml::ClassId

get

Returns the classId of the instance being serialized.

This is used by deserialization to determine what instance type to create and deserialize into.

Returns

the classId

ObjectSize

virtual System:: UInt32 Apache::Geode::Client::CacheableObjectXml::ObjectSize

get

return the size of this object in bytes

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.