ObjectCache.CreateCacheEntryChangeMonitor Method

Definition

Namespace:

System.Runtime.Caching

Assembly:

System.Runtime.Caching.dll

Package:

System.Runtime.Caching v9.0.0

Source:

ObjectCache.cs

When overridden in a derived class, creates a CacheEntryChangeMonitor object that can trigger events in response to changes to specified cache entries.

public abstract System.Runtime.Caching.CacheEntryChangeMonitor CreateCacheEntryChangeMonitor (System.Collections.Generic.IEnumerable<string> keys, string regionName = default);

abstract member CreateCacheEntryChangeMonitor : seq<string> * string -> System.Runtime.Caching.CacheEntryChangeMonitor

Public MustOverride Function CreateCacheEntryChangeMonitor (keys As IEnumerable(Of String), Optional regionName As String = Nothing) As CacheEntryChangeMonitor

Parameters

keys

IEnumerable<String>

The unique identifiers for cache entries to monitor.

regionName

String

Optional. A named region in the cache where the cache keys in the keys parameter exist, if regions are implemented. The default value for the optional parameter is null.

Returns

CacheEntryChangeMonitor

A change monitor that monitors cache entries in the cache.

Remarks

When a derived ObjectCache class overrides the base CreateCacheEntryChangeMonitor method, the cache implementation must create a CacheEntryChangeMonitor object. This specialized change monitor notifies callers when there are changes to the cache entries that are specified in the keys parameter. For example, if a monitored item in the keys parameter is updated or removed from the cache, the change monitor created by this method triggers an event.

If a cache implementation supports named cache regions, a string value can be specified as the regionName parameter. Otherwise, the parameter defaults to null.

Note

Not all cache implementations support cache-entry change monitors. To determine whether your cache implementation supports CacheEntryChangeMonitor objects, see the documentation for the specific cache implementation.