Apache Geode Native .NET Reference  1.14.0
Apache::Geode::Client::IDelta Interface Reference

This interface is used for delta propagation. More...

Public Member Functions

void FromDelta (DataInput^ in)
 Reads in delta information to this object in a user-defined format. More...
 
bool HasDelta ()
 HasDelta( ) is invoked by Geode during Region.Put( ICacheableKey, ISerializable ) to determine if the object contains a delta. More...
 
void ToDelta (DataOutput^ out)
 Writes out delta information to out in a user-defined format. More...
 

Detailed Description

This interface is used for delta propagation.

To use delta propagation, an application class must implement interfaces IDelta as well as IDataSerializable. The IDelta interface methods HasDelta( ), ToDelta( ) and FromDelta( ) must be implemented by the class, as these methods are used by Geode to detect the presence of delta in an object, to serialize the delta, and to apply a serialized delta to an existing object of the class. If a customized cloning method is required, the class must also implement the interface System.ICloneable. To use cloning in delta propagation for a region, the region attribute for cloning must be enabled.

Member Function Documentation

◆ FromDelta()

void Apache::Geode::Client::IDelta::FromDelta ( DataInput in)

Reads in delta information to this object in a user-defined format.

This is invoked on an existing application object after Geode determines the presence of delta in DataInput instance.

Exceptions
InvalidDeltaExceptionif the delta in the DataInput instance cannot be applied to this instance (possible causes may include mismatch of Delta version or logic error).
GeodeIOException

◆ HasDelta()

bool Apache::Geode::Client::IDelta::HasDelta ( )

HasDelta( ) is invoked by Geode during Region.Put( ICacheableKey, ISerializable ) to determine if the object contains a delta.

If HasDelta( ) returns true, the delta in the object is serialized by invoking ToDelta( DataOutput ). If HasDelta( ) returns false, the object is serialized by invoking ISerializable.ToData( DataOutput ).

◆ ToDelta()

void Apache::Geode::Client::IDelta::ToDelta ( DataOutput out)

Writes out delta information to out in a user-defined format.

This is invoked on an application object after Geode determines the presence of delta in it by calling HasDelta() on the object.

Exceptions
GeodeIOException

Apache Geode C++ Cache .NET API Documentation