This documentation is archived and is not being maintained.

CacheEntryChangeMonitor Class

Provides a base class that represents a ChangeMonitor type that can be implemented in order to monitor changes to cache entries.


Namespace:  System.Runtime.Caching
Assembly:  System.Runtime.Caching (in System.Runtime.Caching.dll)

public abstract class CacheEntryChangeMonitor : ChangeMonitor

The CacheEntryChangeMonitor type exposes the following members.

Protected methodCacheEntryChangeMonitorInitializes a new instance of the CacheEntryChangeMonitor class. This constructor is called from constructors in derived classes to initialize the base class.

Public propertyCacheKeysGets a collection of cache keys that are monitored for changes.
Public propertyHasChangedGets a value that indicates that the state that is monitored by the ChangeMonitor class has changed. (Inherited from ChangeMonitor.)
Public propertyIsDisposedGets a value that indicates that the derived instance of a ChangeMonitor class is disposed. (Inherited from ChangeMonitor.)
Public propertyLastModifiedGets a value that indicates the latest time (in UTC time) that the monitored cache entry was changed.
Public propertyRegionNameGets the name of a region of the cache.
Public propertyUniqueIdGets a value that represents the ChangeMonitor class instance. (Inherited from ChangeMonitor.)

Public methodDispose()Releases all resources that are used by the current instance of the ChangeMonitor class. (Inherited from ChangeMonitor.)
Protected methodDispose(Boolean)Releases all managed and unmanaged resources and any references to the ChangeMonitor instance. This overload must be implemented by derived change-monitor classes. (Inherited from ChangeMonitor.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializationCompleteCalled from the constructor of derived classes to indicate that initialization is finished. (Inherited from ChangeMonitor.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNotifyOnChangedCalled by Cache implementers to register a callback and notify an ObjectCache instance through the OnChangedCallback delegate when a dependency has changed. (Inherited from ChangeMonitor.)
Protected methodOnChangedCalled by derived classes to raise the event when a dependency changes. (Inherited from ChangeMonitor.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The CacheEntryChangeMonitor class provides abstract, read-only properties that can be implemented for monitoring cache entries. This class is used when a cache implementation has to monitor changes to entries in its own cache. For caches that are ObjectCache cache implementations, an instance of the CacheEntryChangeMonitor type is returned by the CreateCacheEntryChangeMonitor(IEnumerable<String>, String) method.

Notes to Inheritors

For information about the inheritance contract that must be followed, see the information for inheritors in the ChangeMonitor class overview.

.NET Framework

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.