DataCache.AddRegionLevelCallback Method

Article
08/26/2011

Adds a cache notification callback for cache operations occurring on one specific region.

Namespace: Microsoft.ApplicationServer.Caching
Assembly: Microsoft.ApplicationServer.Caching.Client (in microsoft.applicationserver.caching.client.dll)

Usage

'Usage
Dim instance As DataCache
Dim region As String
Dim filter As DataCacheOperations
Dim clientCallback As DataCacheNotificationCallback
Dim returnValue As DataCacheNotificationDescriptor

returnValue = instance.AddRegionLevelCallback(region, filter, clientCallback)

Syntax

'Declaration
Public MustOverride Function AddRegionLevelCallback ( _
    region As String, _
    filter As DataCacheOperations, _
    clientCallback As DataCacheNotificationCallback _
) As DataCacheNotificationDescriptor

public abstract DataCacheNotificationDescriptor AddRegionLevelCallback (
    string region,
    DataCacheOperations filter,
    DataCacheNotificationCallback clientCallback
)

public:
virtual DataCacheNotificationDescriptor^ AddRegionLevelCallback (
    String^ region, 
    DataCacheOperations filter, 
    DataCacheNotificationCallback^ clientCallback
) abstract

public abstract DataCacheNotificationDescriptor AddRegionLevelCallback (
    String region, 
    DataCacheOperations filter, 
    DataCacheNotificationCallback clientCallback
)

public abstract function AddRegionLevelCallback (
    region : String, 
    filter : DataCacheOperations, 
    clientCallback : DataCacheNotificationCallback
) : DataCacheNotificationDescriptor

Parameters

region
The name of the region for which the specified item or region operations can trigger cache notifications.

filter
The type of cache operation(s) that will trigger cache notifications.

clientCallback
The name of the method you want to invoke when these notifications occur.

Return Value

A DataCacheNotificationDescriptor object used to identify the cache notification callback.

Remarks

Use the DataCacheOperations enumeration in the filter parameter to specify what type of item operations you want to trigger cache notifications. Select more than one enumeration by separating the enumerations with the binary OR operator to perform a bitwise OR. To do this, use the | character in C#, and the Or operator in Visual Basic.

The clientCallback method you invoke with the cache notification must accept the same parameters as the DataCacheNotificationCallback delegate.

For more information about using this method, see How to: Add a Cache Notification Callback. For more information about cache notifications, see Cache Notifications.

Thread Safety

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

Platforms

Development Platforms

Visual Studio 2010 and later, .NET Framework 4

Target Platforms

Windows 7; Windows Server 2008 R2; Windows Server 2008 Service Pack 2; Windows Vista Service Pack 2