CacheEntryUpdateArguments Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides information about a cache entry that will be removed from the cache.

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

System.Object
  System.Runtime.Caching.CacheEntryUpdateArguments

public class CacheEntryUpdateArguments

NameDescription
System_CAPS_pubmethodCacheEntryUpdateArguments(ObjectCache, CacheEntryRemovedReason, String, String)

Initializes a new instance of the CacheEntryUpdateArguments class.

NameDescription
System_CAPS_pubpropertyKey

Gets the unique identifier for a cache entry that is about to be removed.

System_CAPS_pubpropertyRegionName

Gets the name of a region in the cache that contains a cache entry.

System_CAPS_pubpropertyRemovedReason

Gets the reason that a cache entry is about to be removed from the cache.

System_CAPS_pubpropertySource

Gets a reference to the ObjectCache instance that contains a cache entry that is about to be removed.

System_CAPS_pubpropertyUpdatedCacheItem

Gets or sets the value of CacheItem entry that is used to update the cache object.

System_CAPS_pubpropertyUpdatedCacheItemPolicy

Gets or sets the cache eviction or expiration policy of the CacheItem entry that is updated.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The arguments in the CacheEntryUpdateArguments class contain details about an entry that the cache implementation is about to remove. The arguments include a key to the cache entry, a reference to the ObjectCache instance that the entry will be removed from, a reason for the removal, and the region name in the cache that contains the entry. The constructor of the CacheEntryUpdateArguments class uses these arguments to create a new instance of the class.

A CacheEntryUpdateArguments object is passed to a CacheEntryUpdateCallback handler, which notifies the cache about the entry to remove.

Notes to Implementers:

A callback handler must notify the cache implementation whether to insert a replacement entry into the cache in place of the cache entry that is about to be removed. If you want to exchange cache entries, you must assign a value other than null to the UpdatedCacheItem property. Cache implementations will interpret a null value for the UpdatedCacheItem property as a notice that the current cache entry should be removed but not replaced.

.NET Framework
Available since 4.0

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

Return to top
Show: