An application plug-in that can be installed on a region. Defines methods that are called before entry modification, such as writing the value to a database.

Namespace: GemStone.GemFire.Cache
Assembly:  GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll)
Version: 2.5.0.1

Syntax

C#
public interface ICacheWriter
Visual Basic (Declaration)
Public Interface ICacheWriter
Visual C++
public interface class ICacheWriter

Remarks

A distributed region will typically have a single cache writer. If the application is designed such that all or most updates to a region occur on a node, the cache writer for the region should be installed at that node.

A cache writer is defined in the RegionAttributes.

Cache writer invocations are initiated by the node where the entry or region modification occurs.

Before a region is updated via a put, create, or destroy operation, GemFire will call an ICacheWriter that is installed anywhere in any participating cache for that region, preferring a local ICacheWriter if there is one. Usually there will be only one ICacheWriter in the distributed system. If there are multiple ICacheWriters available in the distributed system, the GemFire implementation always prefers one that is stored locally, or else picks one arbitrarily. In any case, only one ICacheWriter will be invoked.

The typical use for a ICacheWriter is to update a database. Application writers should implement these methods to execute application-specific behavior before the cache is modified.

Note that cache writer callbacks are synchronous callbacks and have the ability to veto the cache update. Since cache writer invocations require communications over the network, (especially if they are not co-located on the nodes where the change occurs) the use of cache writers presents a performance penalty.

The ICacheWriter is capable of aborting the update to the cache by throwing a CacheWriterException. This exception or any runtime exception thrown by the ICacheWriter will abort the operation, and the exception will be propagated to the initiator of the operation, regardless of whether the initiator is in the same process as the ICacheWriter.

See Also