Cache Level Event Notifications

Note

This feature is only available in NCache Enterprise Edition.

Cache level events are general events for cache which are triggered upon the execution of the registered activities/event types. The user can register cache level events for any change in the cache data set i.e add update or remove.

By default, cache level events are disabled (except for Cache Cleared) for any cache configuration and must be enabled for events to be published using NCache Web Manager.

Cache Level Notifications are fired when data is added in cache from clients, loader, read-through etc.

Cache Level Data Notifications can be used to share data across different clients, the purpose of this feature is to notify clients about every operation performed on cache. Following are the operations on performing which event notifications are triggered:

Add Notification

Add notification is triggered when a new item is added to the cache. All applications which have registered this event will receive a notification when data is added to the cache.
Update Notification

Update notification is fired when an existing item is updated in the cache. All applications which have registered this event will receive a notification when data is updated in the cache.
Remove Notification

Remove notification is raised when an item is removed from the cache. All applications which have registered this event will receive a notification when data is removed from the cache.

Note

The application will not be able to receive events unless it registers itself against cache using the specific event registration API call.

Pre-Requisites

Make sure that event notifications are enabled using NCache Web Manager.
Install the following NuGet packages in your application:
- Alachisoft.NCache.SDK
Include the following namespaces in your application:
- Alachisoft.NCache.Client
- Alachisoft.NCache.Runtime.Events
- Alachisoft.NCache.Runtime.Exceptions
The application must be connected to cache before performing the operation.
Cache must be running.
Make sure that the data being added is serializable.
For API details, refer to: ICache, RegisterCacheNotification, EventType, EventDataFilter, UnRegisterCacheNotification, CacheEventDescriptor.
To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
To handle any unseen exceptions, refer to the Troubleshooting section.

Add the following Maven dependencies in your pom.xml file:

<dependency>
    <groupId>com.alachisoft.ncache</groupId>
    <artifactId>ncache-client</artifactId>
    <version>5.2.0</version>
</dependency>

Import the following packages in your application:
- import com.alachisoft.ncache.client.*;
- import com.alachisoft.ncache.runtime.exceptions.*;
- import com.alachisoft.ncache.runtime.events.*;
The application must be connected to cache before performing the operation.
Cache must be running.
Make sure that the data being added is serializable.
For API details, refer to: Cache, CacheDataModificationListener, CacheStatusEventListener, getEventType, removeCacheNotificationListener, CacheEventDescriptor.
To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
To handle any unseen exceptions, refer to the Troubleshooting section.

Include the following modules in your application:
- const ncache = require('ncache-client')
The application must be connected to cache before performing the operation.
Cache must be running.
For API details, refer to: Cache, CacheDataModificationListener, getEventType, removeCacheDataModificationListener.
To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
To handle any unseen exceptions, refer to the Troubleshooting section.

Using Cache Level Events

Cache Level notifications are generic events which will be triggered upon every execution of the appropriate registered event type. To register these events for notification, RegisterCacheNotification method is used.

Appropriate EventType is used to restrict the cache for monitoring only the specific client operation. Event type includes ItemAdded, ItemUpdated and ItemRemovedevent type that must be specified by a separate method call. Multiple event types can also be specified in a single method call.

EventDataFilter is specified to quantify the amount of information returned upon an event execution. Events that are registered then provide the user with the information based on these data filters. Following are the data filters that can be specified by the user.

None:

On specifying this filter, only the affected keys are returned in the event notification.
MetaData:

On specifying this filter, the affected keys along with their metadata are returned in the event notification. The metadata that is returned includes the groups and subgroups, cache item priority, provider name and the expiration of the items.
DataWithMetadata:

On specifying this filter, the keys along with the metadata as well as their entire values are returned. It provides the entire data and metadata in the event notification.

For more detail please refer to the Events Overview section.

Warning

EventDataFilter must be carefully set to avoid unnecessary network bandwidth consumption.

Step 1: Registering Callback for Event Notifications

First step is to register a callback for multiple events. Below is an example showing how to register callbacks for multiple events.

Important

Make sure that event notifications are enabled using NCache Web Manager.

// Create a target method
// Pre-condition: Events have been enabled through NCache Web Manager/ Config Files
public static void OnCacheDataModification(string key, CacheEventArg args)
{
    switch (args.EventType)
    {
        case EventType.ItemAdded:
            // 'key' has been added to the cache
        break;

        case EventType.ItemUpdated:
            // 'key' has been updated in the cache
            // Get the updated product
            if (args.Item != null)
            {
                Product updatedProduct = args.Item.GetValue<Product>();
                // Perform operations
            }
        break;

        case EventType.ItemRemoved:
            // 'key' has been removed from the cache
        break;
    }
}

// Create a target method
// Precondition: Events have been enabled
public void onCacheDataModification(String key, CacheEventArg args) 
{
    switch (args.getEventType()) 
    {
        case ItemAdded:
            // Key has been added to the cache
            break;
        case ItemUpdated:
            // 'key' has been updated in the cache
            // get the updated product
            if (args.getItem() != null) 
            {
                Product updateProduct = args.getItem().getValue(Product.class);
                // perform operations
            }
            break;
        case ItemRemoved:
            // 'key' has been removed from the cache
            break;
    }
}

// Create a target method
// Pre-condition: Events have been enabled 
async onCacheDataModified(key, arg) 
{     
    if (null != arg.getEventType()) 
    {
        switch (arg.getEventType()) 
        {
            // perform operations
        case ncache.EventType.ItemAdded:
            // key has been added to cache
            break;
        case ncache.EventType.ItemUpdated:
            // key has been updated in cache
            break;
        case ncache.EventType.ItemRemoved:
            // key has been removed from cache
            break;
        default:
            break;
        }
    }
}

Recommendation: To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.

Step 2: Register Cache Notifications

After registering the callbacks, a target method is created which can have multiple callbacks. The method contains an event type and an event filter. The EventType is adjusted according to the type of operation whose notifications the user want. The EventDataFilter can have one of the three possible values(none, metadata, datawithmetadata). For Java, cache level events' type is specified using CacheEventsListener.

The following example creates a method which registers callbacks for cache notifications with certain event types.

Important

Make sure that event notifications are enabled using NCache Web Manager.

try
{
    // Pre-conditions: Cache is already connected &
    // Events have been enabled through NCache Web Manager/Config Files

    // Register target method
    var dataNotificationCallback = new CacheDataNotificationCallback(OnCacheDataModification);

    // Register cache notification with "ItemAdded" EventType and "None" 
    // EventDataFilter which means only keys will be returned

    CacheEventDescriptor eventDescriptor = cache.MessagingService.RegisterCacheNotification(dataNotificationCallback, EventType.ItemAdded | EventType.ItemRemoved, EventDataFilter.None);

    // Register cache notifications with all three event types and sets the 
    // EventDataFilter as DataWithMetadata which returns keys along with their entire data
    CacheEventDescriptor eventDescriptor = cache.RegisterCacheNotification(dataNotificationCallback,
    EventType.ItemAdded | EventType.ItemRemoved | EventType.ItemUpdated,
    EventDataFilter.DataWithMetadata);

    // Save the event descriptor for further usage
    // Perform your business logic
}
catch (OperationFailedException ex)
{
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
}
catch (Exception ex)
{
    // Any generic exception like ArgumentException, ArgumentNullException
}

try 
{
    // Precondition: Cache is already connected
    // Events have been enabled through NCache Web Manager/Config Files

    // Create event listener and enum set of event type ItemAdded
    var eventListener = new CacheDataModificationListener();
    EnumSet<com.alachisoft.ncache.runtime.events.EventType> enumSet = EnumSet.of(EventType.ItemAdded);

    // Register cache notification with "ItemAdded" EventType and "None"
    // EventDataFilter which means only keys will be returned
    cache.getMessagingService().addCacheNotificationListener(eventListener.onCacheDataModified(key1, arg1), enumSet, EventDataFilter.None);

    // Register cache notifications and set the
    // EventDataFilter as DataWithMetadata which returns keys along with their entire data
    CacheEventDescriptor data = cache.getMessagingService().addCacheNotificationListener(eventListener.onCacheDataModified(key2, arg2), enumSet, EventDataFilter.DataWithMetadata);
}
catch (OperationFailedException exception) 
{
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
    // Operation performed during state transfer
}
catch (Exception exception) 
{
    // Any generic exception like IllegalArgumentException or NullPointerException
}

try 
{
    // Pre-conditions: Cache is already connected &
    // Events have been enabled through NCache Web Manager/Config Files

    // Register cache notification with "ItemAdded" EventType and "None" 
    // EventDataFilter which means only keys will be returned
    let eventListener = new ncache.CacheDataModificationListener(this.onCacheDataModified, this.onCacheCleared);

    let messagingService = await this.cache.getMessagingService();
    await messagingService.addCacheNotificationListener(eventListener, ncache.EventType.ItemAdded, ncache.EventDataFilter.None);

    // Register cache notifications and set the 
    // EventDataFilter as DataWithMetadata which returns keys along with their entire data  
    let EventListener = new ncache.CacheDataModificationListener(this.onCacheDataModified, this.onCacheCleared);
    let messagingService2 = await this.cache.getMessagingService();
    let data = await messagingService2.addCacheNotificationListener(eventListener, ncache.EventType.ItemAdded, ncache.EventDataFilter.DataWithMetadata);
} 
catch (error) 
{
    // Handle errors
}

Recommendation: To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.

The events will be notified to their appropriate listeners and handled as implemented by the user.

Step 3: Unregistering Cache Level Events

A previously registered cache level notification can also be unregistered if they are no longer required using the UnRegisterCacheNotification method. Using this method, the CacheEventDescriptor previously returned upon registering of event, needs to be specified in order to unregister the notifications. For the Java section of the code, removeCacheDataModificationListener is used to unregister the event notifications.

The following example shows how to unregister notifications using this method.

try
{
    // Unregister Notifications using the EventDescriptor 
    cache.MessagingService.UnRegisterCacheNotification(eventDescriptor);
}
catch (OperationFailedException ex)
{
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
}
catch (Exception ex)
{
    // Any generic exception like ArgumentException, ArgumentNullException
}

try
{
    // Unregister Notifications using the EventDescriptor
    cache.getMessagingService().removeCacheDataNotificationListener(eventDescriptor);
}
catch (OperationFailedException ex)
{
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
    // Operation performed during state transfer
}
catch (Exception ex) 
{
    // Any generic exception like IllegalArgumentException or NullPointerException
}

try
{
    // Unregister notifications using EventDescriptor
    await cache.getMessagingService().removeCacheDataNotificationListener(eventDescriptor);
}
catch(error)
{
    // Handle any errors
}

Recommendation: To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.

Note

Using Cache Level events might affect the performance of your application, since it fires notifications for all specified operations performed on the entire cache data set. Item Level Events is the better recommended approach to avoid this problem.

Additional Resources

For a full functioning .NET application executing events, you can use the sample shipped on GitHub.

Cache Level Event Notifications

Note

Note

Pre-Requisites

Using Cache Level Events

Warning

Step 1: Registering Callback for Event Notifications

Important

Step 2: Register Cache Notifications

Important

Step 3: Unregistering Cache Level Events

Note

Additional Resources

See Also