CacheDependency Class

CacheDependency Class

 

Establishes a dependency relationship between an item stored in an ASP.NET application's Cache object and a file, cache key, an array of either, or another CacheDependency object. The CacheDependency class monitors the dependency relationships so that when any of them changes, the cached item will be automatically removed.

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


public class CacheDependency : IDisposable

NameDescription
System_CAPS_protmethodCacheDependency()

Initializes a new instance of the CacheDependency class.

System_CAPS_pubmethodCacheDependency(String)

Initializes a new instance of the CacheDependency class that monitors a file or directory for changes.

System_CAPS_pubmethodCacheDependency(String, DateTime)

Initializes a new instance of the CacheDependency class that monitors a file or directory for changes.

System_CAPS_pubmethodCacheDependency(String[])

Initializes a new instance of the CacheDependency class that monitors an array of paths (to files or directories) for changes.

System_CAPS_pubmethodCacheDependency(String[], DateTime)

Initializes a new instance of the CacheDependency class that monitors an array of paths (to files or directories) for changes and specifies a time when change monitoring begins.

System_CAPS_pubmethodCacheDependency(String[], String[])

Initializes a new instance of the CacheDependency class that monitors an array of paths (to files or directories), an array of cache keys, or both for changes.

System_CAPS_pubmethodCacheDependency(String[], String[], CacheDependency)

Initializes a new instance of the CacheDependency class that monitors an array of paths (to files or directories), an array of cache keys, or both for changes. It also makes itself dependent upon a separate instance of the CacheDependency class.

System_CAPS_pubmethodCacheDependency(String[], String[], CacheDependency, DateTime)

Initializes a new instance of the CacheDependency class that monitors an array of paths (to files or directories), an array of cache keys, or both for changes. It also makes itself dependent upon another instance of the CacheDependency class and a time when the change monitoring begins.

System_CAPS_pubmethodCacheDependency(String[], String[], DateTime)

Initializes a new instance of the CacheDependency class that monitors an array of paths (to files or directories), an array of cache keys, or both for changes.

NameDescription
System_CAPS_pubpropertyHasChanged

Gets a value indicating whether the CacheDependency object has changed.

System_CAPS_pubpropertyUtcLastModified

Gets the time when the dependency was last changed.

NameDescription
System_CAPS_protmethodDependencyDispose()

Releases the resources used by the CacheDependency class and any classes that derive from CacheDependency.

System_CAPS_pubmethodDispose()

Releases the resources used by the CacheDependency object.

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_protmethodFinishInit()

Completes initialization of the CacheDependency 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_pubmethodGetUniqueID()

Retrieves a unique identifier for a CacheDependency object.

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_protmethodNotifyDependencyChanged(Object, EventArgs)

Notifies the base CacheDependency object that the dependency represented by a derived CacheDependency class has changed.

System_CAPS_protmethodSetUtcLastModified(DateTime)

Marks the time when a dependency last changed.

System_CAPS_pubmethodToString()

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

If you add an item to the cache that is dependent on another object, such as a file or array of files, the dependent item is automatically removed from the cache when the object changes. For example, suppose you create a DataSet object based on data in an XML file. You can add the DataSet to the cache with a CacheDependency object that makes the DataSet dependent on the XML file. If the XML file changes, the DataSet is removed from the cache.

You can add items with dependencies to your application's cache with the Add and Cache.Insert methods. You cannot use the Item property to add items to the cache with dependencies.

To set up a dependency, you create an instance of the CacheDependency class, specifying the files, keys, or directories on which the item is dependent, and then pass the dependency to the Add or Cache.Insert method. The CacheDependency instance can represent a single file or directory, an array of files or directories, or an array of files or directories along with an array of cache keys (these represent other items stored in the Cache object).

The following code example demonstrates using the HasChanged property to determine whether a CacheDependency changed since the previous request for an item in the Cache. The dt value passed in the start parameter is set to DateTime.Now.

// Insert the cache item.
CacheDependency dep = new CacheDependency(fileName, dt);
cache.Insert("key", "value", dep);

// Check whether CacheDependency.HasChanged is true.
if (dep.HasChanged)
  Response.Write("<p>The dependency has changed.");  
else Response.Write("<p>The dependency has not changed.");

.NET Framework
Available since 1.1

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:
© 2016 Microsoft