Class Cache

Namespace:

Assembly: Alachisoft.NCache.Web.dll

Syntax

public class Cache : IEnumerable, IDisposable

Remarks

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

Fields

DefaultAbsolute

Declaration

public static readonly DateTime DefaultAbsolute

Field Value

Examples

The following example demonstrates how to use DefaultAbsolute to add an item to the cache.

Product product = new Product();
product.ProductID = 1001;
product.ProductName = "Chai";
string key = "Product:" + product.ProductID;
cache.Add(key, product, null, Cache.DefaultAbsolute, Cache.NoSlidingExpiration, CacheItemPriority.Default);

DefaultAbsoluteLonger

Declaration

public static readonly DateTime DefaultAbsoluteLonger

Field Value

Examples

The following example demonstrates how to use DefaultAbsoluteLonger to add an item to the cache.

Product product = new Product();
product.ProductID = 1001;
product.ProductName = "Coffee";
string key = "Product:" + product.ProductID;
cache.Add(key, product, null, Cache.DefaultAbsoluteLonger, Cache.NoSlidingExpiration, CacheItemPriority.Default);

DefaultSliding

Declaration

public static readonly TimeSpan DefaultSliding

Field Value

Examples

The following example demonstrates how to use DefaultSliding to add an item to the cache.

Product product = new Product();
product.ProductID = 1001;
product.ProductName = "Tea";
string key = "Product:" + product.ProductID;
cache.Add(key, product, null, Cache.NoAbsoluteExpiration, Cache.DefaultSliding,  CacheItemPriority.Default);

DefaultSlidingLonger

Declaration

public static readonly TimeSpan DefaultSlidingLonger

Field Value

Examples

The following example demonstrates how to use DefaultSlidingLonger to add an item to the cache.

Product product = new Product();
product.ProductID = 1001;
product.ProductName = "Tea";
string key = "Product:" + product.ProductID;
cache.Add(key, product, null, Cache.NoAbsoluteExpiration, Cache.DefaultSlidingLonger,  CacheItemPriority.Default);

NoAbsoluteExpiration

Declaration

public static readonly DateTime NoAbsoluteExpiration

Field Value

Remarks

Examples

The following example demonstrates how to use the NoAbsoluteExpiration field to disable absolute expirations when inserting an item in the Cache.

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("DSN", connectionString, null, Cache.NoAbsoluteExpiration, TimeSpan.FromSeconds(10));

NoLockExpiration

Declaration

public static readonly TimeSpan NoLockExpiration

Field Value

Remarks

Examples

The following example demonstrates how to use the Lock method to add an item to the Cache object using the NoLockExpiration field.

Cache cache = NCache.InitializeCache("myCache");
LockHandle lockHandle = new LockHandle();
cache.Lock("DSN", Cache.NoLockExpiration, out lockHandle);

NoSlidingExpiration

Declaration

public static readonly TimeSpan NoSlidingExpiration

Field Value

Remarks

Examples

The following example demonstrates how to use the Insert method to add an item to the Cache object using the NoSlidingExpiration field.

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("DSN", connectionString, null, DateTime.Now.AddMinutes(2), Cache.NoSlidingExpiration);

Properties

ClientInfo

Declaration

public virtual ClientInfo ClientInfo { get; }

Property Value

Count

Declaration

[TargetMethod(1)]
public virtual long Count { get; }

Property Value

Remarks

ExceptionsEnabled

Declaration

public virtual bool ExceptionsEnabled { get; set; }

Property Value

Remarks

Examples

This sample shows how to set the ExceptionsEnabled property.

Cache cache = NCache.InitializeCache("myCache");
cache.ExceptionsEnabled = true;

Item[String]

Declaration

public virtual object this[string key] { get; set; }

Parameters

Property Value

Remarks

Examples

The following examples demonstrates using this property to retrieve and insert the values of cached item.

Cache cache = NCache.InitializeCache("myCache");

void cmdReset_Click(object objSender, EventArgs objArgs)
{   
    txtValue.Text = cache[txtName.Text].ToString();
}

void cmdAdd_Click(object objSender, EventArgs objArgs)
{
    if (txtName.Text != "")
    {
        // Add this item to the cache.
        cache[txtName.Text] = txtValue.Text;
    }
}

void cmdReset_Click(object objSender, EventArgs objArgs)
{
    txtValue.Text = cache[txtName.Text].ToString();
}

void cmdAdd_Click(object objSender, EventArgs objArgs)
{
    if (txtName.Text != "")
    {
        // Add this item to the cache.
        cache[txtName.Text] = txtValue.Text;
    }
}

Exceptions

MessagingService

Declaration

public virtual IMessagingService MessagingService { get; }

Property Value

Methods

Add(String, CacheItem)

Declaration

[TargetMethod(7)]
public virtual CacheItemVersion Add(string key, CacheItem item)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item to the cache with an absolute expiration of 2 minutes from now, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItem.

object someData = new object();
CacheItem item = new CacheItem(someData);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(2);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

OnDataSourceItemAdded(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
cache.Add("someData", item);

Add(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback)

Declaration

[TargetMethod(8)]
public virtual CacheItemVersion Add(string key, CacheItem item, DSWriteOption dsWriteOption, DataSourceItemsAddedCallback onDataSourceItemAdded)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item to the cache with an absolute expiration of 2 minutes from now, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItem.

object someData = new object();
CacheItem item = new CacheItem(someData);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(2);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

OnDataSourceItemAdded(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
cache.Add("someData", item, DSWriteOption.WriteBehind, new DataSourceItemsAddedCallback(OnDataSourceItemAdded));

Add(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback)

Declaration

[TargetMethod(9)]
public virtual CacheItemVersion Add(string key, CacheItem item, DSWriteOption dsWriteOption, string providerName, DataSourceItemsAddedCallback onDataSourceItemAdded)

Parameters

Returns

Add(String, Object)

Declaration

[TargetMethod(1)]
public virtual CacheItemVersion Add(string key, object value)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item into an application's cache.

Cache cache = NCache.InitializeCache("myCache");
cache.Add("DSN", connectionString);

Exceptions

Add(String, Object, NamedTagsDictionary)

Declaration

[TargetMethod(3)]
public virtual CacheItemVersion Add(string key, object value, NamedTagsDictionary namedTags)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item into an application's cache.

Cache cache = NCache.InitializeCache("myCache");
NamedTagsDictionary namedTags = new NamedTagsDictionary();
namedTags.Add("Attribute", "value");
cache.Add("DSN", connectionString, namedTags);

Exceptions

Add(String, Object, Tag[])

Declaration

[TargetMethod(2)]
public virtual CacheItemVersion Add(string key, object value, Tag[] tags)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item into an application's cache.

Cache cache = NCache.InitializeCache("myCache");
Tag[] tags = new Tag[1];
tags[0] = new Tag("tag-name");
cache.Add("DSN", connectionString, tags);

Exceptions

Add(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(5)]
public virtual CacheItemVersion Add(string key, object value, CacheDependency dependency, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item to the cache with no abolute expiration, a sliding expiration of 5 minutes and with a priority of high.

Cache cache = NCache.InitializeCache("myCache");
cache.Add("timestamp", timeStamp, null, Cache.NoAbsoluteExpiration, new TimeSpan(0,5,0), CacheItemPriority.High);

Exceptions

Add(String, Object, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(6)]
public virtual CacheItemVersion Add(string key, object value, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

Add(String, Object, String, String)

Declaration

[TargetMethod(4)]
public virtual CacheItemVersion Add(string key, object value, string group, string subGroup)

Parameters

Returns

Examples

Cache cache = NCache.InitializeCache("myCache");
cache.Add("DSN", value, "CONNECTIONS", null);

AddAsync(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback)

Declaration

[TargetMethod(2)]
public virtual void AddAsync(string key, CacheItem item, DSWriteOption dsWriteOption, DataSourceItemsAddedCallback onDataSourceItemAdded)

Parameters

Remarks

Examples

The following example demonstrates how to add an item to the cache with a sliding expiration of 5 minutes, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItem.

CacheItem item = new CacheItem(timeStamp);
item.SlidingExpiration = new TimeSpan(0,5,0);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

OnDataSourceItemAdded(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
cache.AddAsync("timestamp", item, DSWriteOption.WriteBehind, new DataSourceItemsAddedCallback(OnDataSourceItemAdded));

AddAsync(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback)

Declaration

[TargetMethod(3)]
public virtual void AddAsync(string key, CacheItem item, DSWriteOption dsWriteOption, string providerName, DataSourceItemsAddedCallback onDataSourceItemAdded)

Parameters

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

AddAsync(String, Object, AsyncItemAddedCallback, String, String)

Declaration

[TargetMethod(1)]
public virtual void AddAsync(string key, object value, AsyncItemAddedCallback onAsyncItemAddCallback, string group, string subGroup)

Parameters

Examples

The following example demonstrates how to add an object to the cache with group, subGroup and a delegate that notifies the application about the operation status.

First create the AsyncItemAddedCallback.

AsyncItemAddedCallback asyncItemAdded = new AsyncItemAddedCallback(OnAsyncItemAdded);

OnAsyncItemAdded(string key, object result)
{
...
}

Then add the object to the cache.

Cache cache = NCache.InitializeCache("myCache");
cache.AddAsync("timestamp", timestamp, asyncItemAdded, "group-name", "subGroup-name");

AddAsyncOperation(String, Object, CacheDependency, CacheSyncDependency, DateTime, TimeSpan, CacheItemPriority, DSWriteOption, CacheItemRemovedCallback, CacheItemUpdatedCallback, AsyncItemAddedCallback, DataSourceItemsAddedCallback, Boolean, String, String, Tag[], String, String, NamedTagsDictionary, CacheDataNotificationCallback, CacheDataNotificationCallback, EventDataFilter, EventDataFilter, String, Int16, Int16, Int16)

Declaration

protected virtual void AddAsyncOperation(string key, object value, CacheDependency dependency, CacheSyncDependency syncDependency, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority, DSWriteOption dsWriteOption, CacheItemRemovedCallback onRemoveCallback, CacheItemUpdatedCallback onUpdateCallback, AsyncItemAddedCallback onAsyncItemAddCallback, DataSourceItemsAddedCallback onDataSourceItemAdded, bool isResyncExpiredItems, string group, string subGroup, Tag[] tags, string providerName, string resyncProviderName, NamedTagsDictionary namedTags, CacheDataNotificationCallback cacheItemUdpatedCallback, CacheDataNotificationCallback cacheItemRemovedCallaback, EventDataFilter itemUpdateDataFilter, EventDataFilter itemRemovedDataFilter, string clientId, short updateCallbackId, short removeCallbackId, short dsItemAddedCallbackId)

Parameters

AddBulk(String[], CacheItem[])

Declaration

[TargetMethod(2)]
public virtual IDictionary AddBulk(string[] keys, CacheItem[] items)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add items to the cache with an absolute expiration 2 minutes from now, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItems.

string keys = {"First", "Second"};
CacheItem items = new CacheItem[2]
items[0] = new CacheItem(firstTimeStamp);
items[0].AbsoluteExpiration = DateTime.Now.AddMinutes(2);
items[0].Priority = CacheItemPriority.High;
items[0].ItemRemoveCallback = onRemove;

items[1] = new CacheItem(secondTimeStamp);
items[1].AbsoluteExpiration = DateTime.Now.AddMinutes(2);
items[1].Priority = CacheItemPriority.Low;
items[1].ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

OnDataSourceItemAdded(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
cache.Add(keys, items);

AddBulk(String[], CacheItem[], DSWriteOption, DataSourceItemsAddedCallback)

Declaration

[TargetMethod(1)]
public virtual IDictionary AddBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOption, DataSourceItemsAddedCallback onDataSourceItemsAdded)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add items to the cache with an absolute expiration 2 minutes from now, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItems.

string keys = {"First", "Second"};
CacheItem items = new CacheItem[2]
items[0] = new CacheItem(firstTimeStamp);
items[0].AbsoluteExpiration = DateTime.Now.AddMinutes(2);
items[0].Priority = CacheItemPriority.High;
items[0].ItemRemoveCallback = onRemove;

items[1] = new CacheItem(secondTimeStamp);
items[1].AbsoluteExpiration = DateTime.Now.AddMinutes(2);
items[1].Priority = CacheItemPriority.Low;
items[1].ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

OnDataSourceItemAdded(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
cache.Add(keys, items, DSWriteOption.WriteBehind, new DataSourceItemsAddedCallback(OnDataSourceItemAdded));

AddBulk(String[], CacheItem[], DSWriteOption, String, DataSourceItemsAddedCallback)

Declaration

[TargetMethod(3)]
public virtual IDictionary AddBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOption, string providerName, DataSourceItemsAddedCallback onDataSourceItemsAdded)

Parameters

Returns

AddDependency(String, CacheDependency, Boolean)

Declaration

[TargetMethod(1)]
public virtual bool AddDependency(string key, CacheDependency dependency, bool isResyncRequired)

Parameters

Returns

AddDependency(String, CacheSyncDependency)

Declaration

[TargetMethod(2)]
[Obsolete("This method is deprecated. 'Please use AddDependency(string key, CacheDependency dependency, bool isResyncRequired)'", false)]
public virtual bool AddDependency(string key, CacheSyncDependency syncDependency)

Parameters

Returns

Aggregate(IValueExtractor, IAggregator)

Declaration

[TargetMethod(1)]
public virtual object Aggregate(IValueExtractor extractor, IAggregator aggregator)

Parameters

Returns

Examples

IAggregator can perform following operations Average, Sum, Min, Max, Count, Distinct. If result after aggregation execution is null than default value of built in Aggregator for that specific type is returned. User can also implement custom aggregator, as well as aggregator for custom data types and also for custom functions like Mean, Median, Mode.

Cache _cache= NCache.InitializeCache("myCache");
product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);
_cache.Add("2202", product1);
_cache.Add("2203", product2);
int value = (int)cache.Aggregate(new BasicTypeExtractor(), BuiltInAggregator.IntegerSum());

// IValueExtractor Implementaion
public class BasicTypeExtractor : IValueExtractor
{
    public object Extract(object value)
    {
        try
        {
            if (value.GetType() == typeof(int))
            {
                return 0;
            }
            if (value.GetType() == typeof(float))
            {
                return 0.0;
            }
        }
        catch (Exception e)
        {
            //handle exception
        }
        return value;
    }
}

Aggregate(IValueExtractor, IAggregator, IKeyFilter)

Declaration

[TargetMethod(3)]
public virtual object Aggregate(IValueExtractor extractor, IAggregator aggregator, IKeyFilter keyFilter)

Parameters

Returns

Examples

IAggregator can perform following operations Average, Sum, Min, Max, Count, Distinct. If result after aggregation execution is null than default value of built in Aggregator for that specific type is returned. User can also implement custom aggregator, as well as aggregator for custom data types and also for custom functions like Mean, Median, Mode.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

AggregatorKeyFilter keyFilter= new AggregatorKeyFilter();

object result =_cache.Aggregate(new BasicTypeExtractor(), BuiltInAggregator.Count(),keyFilter);

// IValueExtractor Implementaion
public class BasicTypeExtractor : IValueExtractor
{
    public object Extract(object value)
    {
        try
        {
            if (value.GetType() == typeof(int))
            {
                return 0;
            }
            if (value.GetType() == typeof(float))
            {
                return 0.0;
            }
        }
        catch (Exception e)
        {
            //handle exception
        }
        return value;
    }
}


//implementation of IKeyFilter
public class AggregatorKeyFilter : IKeyFilter
{
 public bool FilterKey(object key)
  {
   try
   {
       if (key.ToString().Contains("hungry"))
       {
           return true;
       }

   }
   catch (Exception exp)
   {
       //handle exception
   }
   return false;
  }
}

Aggregate(IValueExtractor, IAggregator, IKeyFilter, Int32)

Declaration

[TargetMethod(6)]
public virtual object Aggregate(IValueExtractor extractor, IAggregator aggregator, IKeyFilter keyFilter, int timeout)

Parameters

Returns

Examples

IAggregator can perform following operations: Average, Sum, Min, Max, Count, Distinct. If result after aggregation execution is null than default value of built in Aggregator for that specific type is returned. User can also implement custom aggregator, as well as aggregator for custom data types and also for custom functions like Mean, Median, Mode.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

AggregatorKeyFilter keyFilter= new AggregatorKeyFilter();

object result =_cache.Aggregate(new BasicTypeExtractor(), BuiltInAggregator.IntegerMax(),keyFilter,40000);

// IValueExtractor Implementaion
public class BasicTypeExtractor : IValueExtractor
{
    public object Extract(object value)
    {
        try
        {
            if (value.GetType() == typeof(int))
            {
                return 0;
            }
            if (value.GetType() == typeof(float))
            {
                return 0.0;
            }
        }
        catch (Exception e)
        {
            //handle exception
        }
        return value;
    }
}


//implementation of IKeyFilter
public class AggregatorKeyFilter : IKeyFilter
{
 public bool FilterKey(object key)
  {
   try
   {
       if (key.ToString().Contains("hungry"))
       {
           return true;
       }

   }
   catch (Exception exp)
   {
       //handle exception
   }
   return false;
  }
}

Aggregate(IValueExtractor, IAggregator, Int32)

Declaration

[TargetMethod(2)]
public virtual object Aggregate(IValueExtractor extractor, IAggregator aggregator, int timeout)

Parameters

Returns

Examples

IAggregator can perform following operations Average, Sum, Min, Max, Count, Distinct. If result after aggregation execution is null than default value of built in Aggregator for that specific type is returned. User can also implement custom aggregator, as well as aggregator for custom data types and also for custom functions like Mean, Median, Mode.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

object result =_cache.Aggregate(new BasicTypeExtractor(), BuiltInAggregator.Count(), 60000);

// IValueExtractor Implementaion
public class BasicTypeExtractor : IValueExtractor
{
    public object Extract(object value)
    {
        try
        {
            if (value.GetType() == typeof(int))
            {
                return 0;
            }
            if (value.GetType() == typeof(float))
            {
                return 0.0;
            }
        }
        catch (Exception e)
        {
            //handle exception
        }
        return value;
    }
}

Aggregate(IValueExtractor, IAggregator, String, Hashtable)

Declaration

[TargetMethod(4)]
public virtual object Aggregate(IValueExtractor extractor, IAggregator aggregator, string query, Hashtable parameters)

Parameters

Returns

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

Aggregate(IValueExtractor, IAggregator, String, Hashtable, Int32)

Declaration

[TargetMethod(5)]
public virtual object Aggregate(IValueExtractor extractor, IAggregator aggregator, string query, Hashtable parameters, int timeout)

Parameters

Returns

Examples

IAggregator can perform following operations Average, Sum, Min, Max, Count, Distinct. If result after aggregation execution is null than default value of built in Aggregator for that specific type is returned. User can also implement custom aggregator, as well as aggregator for custom data types and also for custom functions like Mean, Median, Mode.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Clothes", "", 4, 2);
product2 = new Product(4, "Shoes", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

Hashtable values = new Hashtable();
values.Add("Category", "Clothes");
String query = "SELECT Product WHERE this.Category=?;

object result =_cache.Aggregate(new BasicTypeExtractor(), BuiltInAggregator.Count(),query,values, 50000);

// IValueExtractor Implementaion
public class BasicTypeExtractor : IValueExtractor
{
    public object Extract(object value)
    {
        try
        {
            if (value.GetType() == typeof(int))
            {
                return 0;
            }
            if (value.GetType() == typeof(float))
            {
                return 0.0;
            }
        }
        catch (Exception e)
        {
            //handle exception
        }
        return value;
    }
}

Clear()

Declaration

[TargetMethod(1)]
public virtual void Clear()

Remarks

Examples

The following example demonstrates how to check for containment of an item in the Cache.

Cache cache = NCache.InitializeCache("myCache");
cache.Clear();

Clear(DSWriteOption, DataSourceClearedCallback)

Declaration

[TargetMethod(2)]
[Obsolete("This method is deprecated. 'Please use Clear()'", false)]
public virtual void Clear(DSWriteOption updateOpt, DataSourceClearedCallback dataSourceClearedCallback)

Parameters

Remarks

Examples

The following example demonstrates how to clear the Cache.

OnDataSourceCleared(object result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
cache.Clear(DSWriteOption.WriteBehind, new DataSourceClearedCallback(OnDataSourceCleared));

ClearAsync(AsyncCacheClearedCallback)

Declaration

[TargetMethod(1)]
public virtual void ClearAsync(AsyncCacheClearedCallback onAsyncCacheClearCallback)

Parameters

Remarks

Examples

The following example demonstrates how to clear the Cache.

void OnAsyncCacheCleared(object result)
{
...
}
Cache _cache = NCache.InitializeCache("myCache");
_cache.ClearAsync(new AsyncCacheClearedCallback(OnAsyncCacheCleared));

ClearAsync(DSWriteOption, AsyncCacheClearedCallback, DataSourceClearedCallback)

Declaration

[TargetMethod(2)]
[Obsolete("This method is deprecated. 'Please use Clear()'", false)]
public virtual void ClearAsync(DSWriteOption updateOpt, AsyncCacheClearedCallback onAsyncCacheClearCallback, DataSourceClearedCallback dataSourceClearedCallback)

Parameters

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

ClearClientCache()

Declaration

[TargetMethod(1)]
public virtual void ClearClientCache()

Examples

The following example demonstrates how to clear the client cache.

Cache cache = NCache.InitializeCache("myCache");
cache.ClearClientCache();

ClearClientCacheAsync(AsyncCacheClearedCallback)

Declaration

[TargetMethod(1)]
public virtual void ClearClientCacheAsync(AsyncCacheClearedCallback onAsyncCacheClearCallback)

Parameters

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

Contains(String)

Declaration

[TargetMethod(1)]
public virtual bool Contains(string key)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to check for containment of an item in the Cache.

Cache cache = NCache.InitializeCache("myCache");
if(cache.Contains("MyTextBox.Value"))
{
    Response.Write("Item found!");
}

Exceptions

Delete(String)

Declaration

[TargetMethod(1)]
public virtual void Delete(string key)

Parameters

Remarks

Examples

The following example demonstrates how you can remove an item from your application's Cache object.

Cache cache = NCache.InitializeCache("myCache");
cache.Delete("timestamp");

Exceptions

Delete(String, CacheItemVersion)

Declaration

[TargetMethod(5)]
public virtual void Delete(string key, CacheItemVersion version)

Parameters

Examples

The following example demonstrates how to remove a locked item from the cache.

First create a CacheItem.

Cache theCache = NCache.InitializeCache("myreplicatedcache");

Add an item in the cache.

theCache.Add("cachedItemKey", new "cachedItemValue");

Create the CacheItemVersion.

CacheItemVersion version = new CacheItemVersion();

Get the added item from cache and get the item version.

object cachedItem = theCache.Get("cachedItemKey", DSReadOption.None, ref version);
if (cachedItem != null)
{
    try
    {
        //Now remove the cached item using version acquired earlier.
        object removedItem = theCache.Remove("cachedItemKey", version);
    }
    catch (OperationFailedException ex)
    {
        //Do something
    }
}

Delete(String, DSWriteOption, DataSourceItemsRemovedCallback)

Declaration

[TargetMethod(2)]
public virtual void Delete(string key, DSWriteOption dsWriteOption, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Remarks

Examples

The following example demonstrates how you can remove an item from your application's Cache object.

Cache cache = NCache.InitializeCache("myCache");
cache.Remove("timestamp", DSWriteOption.None, null, "group-name", "subGroup-name");

Exceptions

Delete(String, DSWriteOption, String, DataSourceItemsRemovedCallback)

Declaration

[TargetMethod(3)]
public virtual void Delete(string key, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

Delete(String, LockHandle)

Declaration

[TargetMethod(4)]
public virtual void Delete(string key, LockHandle lockHandle)

Parameters

Examples

The following example demonstrates how to remove a locked item from the cache.

First create a CacheItem.

Cache theCache = NCache.InitializeCache("myreplicatedcache");

Add an item int the cache.

theCache.Add("cachedItemKey", "cachedItemValue");

Create the lock-handle.

LockHandle lockHandle = new LockHandle();

Get the added item from cache and acquire a lock.

object cachedItem = theCache.Get("cachedItemKey", ref lockHandle, true);
if (cachedItem != null)
{
    try
    {
        //Now remove the cached item using lockHandle acquired earlier.
        object removedItem = theCache.Remove("cachedItemKey", lockHandle);
    }
    catch (OperationFailedException ex)
    {
        //Do something
    }
}

DeleteBulk(String[])

Declaration

[TargetMethod(2)]
public virtual void DeleteBulk(string[] keys)

Parameters

Remarks

Examples

The following example demonstrates how you can remove an item from your application's Cache object.

OnDataSourceItemsRemoved(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
cache.Remove(keys);

Exceptions

DeleteBulk(String[], DSWriteOption, DataSourceItemsRemovedCallback)

Declaration

[TargetMethod(1)]
public virtual void DeleteBulk(string[] keys, DSWriteOption dsWriteOption, DataSourceItemsRemovedCallback onDataSourceItemsRemovedCallback)

Parameters

Remarks

Examples

The following example demonstrates how you can remove an item from your application's Cache object.

OnDataSourceItemsRemoved(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
cache.Remove(keys, DSWriteOption.WriteBehind, new DataSourceItemsRemovedCallback(OnDataSourceItemsRemoved), "group-name", "subGroup-name");

Exceptions

DeleteBulk(String[], DSWriteOption, String, DataSourceItemsRemovedCallback)

Declaration

[TargetMethod(3)]
public virtual void DeleteBulk(string[] keys, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemsRemovedCallback)

Parameters

Remarks

Examples

The following example demonstrates how you can remove an item from your application's Cache object.

OnDataSourceItemsRemoved(IDictionary result)
{
...
}
Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
cache.Remove(keys, DSWriteOption.WriteBehind, new DataSourceItemsRemovedCallback(OnDataSourceItemsRemoved), "group-name", "subGroup-name");

Exceptions

Dispose()

Declaration

public virtual void Dispose()

Remarks

ExecuteNonQuery(String, IDictionary)

Declaration

[TargetMethod(1)]
public virtual int ExecuteNonQuery(string query, IDictionary values)

Parameters

Returns

Examples

Only Delete Query is supported yet.

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

Cache _cache = NCache.InitializeCache("myCache");

Hashtable values = new Hashtable();
values.Add("Name", "Paul Jones");
string query="delete Test.Application.Employee where this.Name = ?";
ICacheReader reader=_cache.ExecuteNonQuery(query,values);

values.Clear();
values.Add("Salary", 2000);
query="delete Test.Application.Employee where this.Salary > ?";
reader=_cache.ExecuteNonQuery(query,values);

values.Clear();
values.Add("Name", "Paul jones");
values.Add("Salary", 2000);
query="delete Test.Application.Employee where this.Name = ? and this.Salary > ?";
reader=_cache.ExecuteNonQuery(query,values);

values.Clear();
values.Add("Name", "Paul Jones");
values.Add("Salary", 2000);
query="delete Test.Application.Employee where Not(this.Name = 'Paul Jones' and this.Salary > 2000)";
reader=_cache.ExecuteNonQuery(query,values);

ExecuteReader(String, IDictionary)

Declaration

[TargetMethod(2)]
public virtual ICacheReader ExecuteReader(string query, IDictionary values)

Parameters

Returns

Examples

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

Cache _cache = NCache.InitializeCache("myCache");

Hashtable values = new Hashtable();
values.Add("Name", "Paul Jones");
string query="select Test.Application.Employee where this.Name = ?";
ICacheReader reader=_cache.ExecuteReader(query,values);

values.Clear();
values.Add("Salary", 2000);
query="select Test.Application.Employee where this.Salary > ?";
result=_cache.ExecuteReader(query,values);

values.Clear();
values.Add("Name", "Paul jones");
values.Add("Salary", 2000);
query="select Test.Application.Employee where this.Name = ? and this.Salary > ?";
result=_cache.ExecuteReader(query,values);

values.Clear();
values.Add("Name", "Paul Jones");
values.Add("Salary", 2000);
query="select Test.Application.Employee where Not(this.Name = 'Paul Jones' and this.Salary > 2000)";
reader=_cache.ExecuteReader(query,values);
if (reader.FieldCount > 0)
    {
     while (reader.Read())
        {
          object category = reader.GetValue(0);
          //perform operations
        }
    }
else
   {
      //perform operations
   }
reader.Close();

ExecuteReader(String, IDictionary, Boolean)

Declaration

[TargetMethod(3)]
public virtual ICacheReader ExecuteReader(string query, IDictionary values, bool getData)

Parameters

Returns

Examples

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

string query="SELECT Product  WHERE this.ProductName = ? and this.UnitsInStock > ?";
Hashtable values = new Hashtable();
values.Add("ProductName", "Chai");
values.Add("UnitsInStock", 250);
try
 {
    ICacheReader reader = cache.ExecuteReader(query, values, true);
    if (reader.FieldCount > 0)
      {
          while (reader.Read())
          {
             object category = reader.GetValue(0);
              //perform operations
          }
      }
    else
      {
         //perform operations
      }
     reader.Close();
 }
catch
 {
 //handle exception
 }

ExecuteReader(String, IDictionary, Boolean, Int32)

Declaration

[TargetMethod(1)]
public virtual ICacheReader ExecuteReader(string query, IDictionary values, bool getData, int chunkSize)

Parameters

Returns

Examples

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

Cache _cache= NCache.InitializeCache("myCache");

Hashtable values = new Hashtable();
values.Add("ProductName", "Chai");
values.Add("UnitsInStock", 250);

// Instead of Product, specify fully qualified name of your custom class.
string query = "SELECT Product where this.ProductName = ?";

try
 {
    ICacheReader reader = cache.ExecuteReader(query, values, true, 50);
    if (reader.FieldCount > 0)
      {
          while (reader.Read())
          {
             object category = reader.GetValue(0);
              //perform operations
          }
      }
    else
      {
         //perform operations
      }
     reader.Close();
 }

catch
 {
 //handle exception
 }

ExecuteReaderCQ(ContinuousQuery)

Declaration

[TargetMethod(1)]
public virtual ICacheReader ExecuteReaderCQ(ContinuousQuery cquery)

Parameters

Returns

Examples

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

   Cache _cache = NCache.InitializeCache("mycache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2); product2 = new Product(4, "Tunnbr?d", "", 5, 9); string qry = "SELECT Product WHERE this.ProductQuantity = ?;" Hashtable indexTable = new Hashtable(); indexTable.Add("ProductQuantity", 9); ContinuousQuery cQuery = new ContinuousQuery(qry, indexTable);

_cache.Add("2202", product1); _cache.Add("2203", product2); cQuery.RegisterNotification(new QueryDataNotificationCallback(QueryItemCallBack), EventType.ItemUpdated | EventType.ItemRemoved, EventDataFilter.None);

ICacheReader reader = _cache.ExecuteReaderCQ(cQuery); if (reader.FieldCount > 0) { while (reader.Read()) { object category = reader.GetValue(0); //perform operations } } else { //perform operations } reader.Close();

public void QueryItemCallBack(string key, CQEventArg arg) { switch (arg.EventType) { case EventType.ItemRemoved: //do something break; case EventType.ItemUpdated: //do something break; case EventType.ItemAdded: //do something break; } }

ExecuteReaderCQ(ContinuousQuery, Boolean)

Declaration

[TargetMethod(2)]
public virtual ICacheReader ExecuteReaderCQ(ContinuousQuery cquery, bool getData)

Parameters

Returns

Examples

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

   Cache _cache = NCache.InitializeCache("mycache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2); product2 = new Product(4, "Tunnbr?d", "", 5, 9); string qry = "SELECT Product WHERE this.ProductID = ?;" Hashtable indexTable = new Hashtable(); indexTable.Add("ProductID", 4); ContinuousQuery cQuery = new ContinuousQuery(qry, indexTable);

_cache.Add("2202", product1); _cache.Add("2203", product2); cQuery.RegisterNotification(new QueryDataNotificationCallback(QueryItemCallBack), EventType.ItemUpdated | EventType.ItemRemoved, EventDataFilter.None);

ICacheReader reader = _cache.ExecuteReaderCQ(cQuery,true);

if (reader.FieldCount > 0) { while (reader.Read()) { object category = reader.GetValue(0); //perform operations } } else { //perform operations } reader.Close();

public void QueryItemCallBack(string key, CQEventArg arg) { switch (arg.EventType) { case EventType.ItemRemoved: //do something break; case EventType.ItemUpdated: //do something break; case EventType.ItemAdded: //do something break; } }

ExecuteReaderCQ(ContinuousQuery, Boolean, Int32)

Declaration

[TargetMethod(3)]
public virtual ICacheReader ExecuteReaderCQ(ContinuousQuery query, bool getData, int chunkSize)

Parameters

Returns

Examples

These operators are supported by NCache Queries.

1. Comparison Operators = , == , != , <> , < , > , <=, >=, IN
2. Logical Operators AND , OR , NOT
3. Miscellaneous () , DateTime.Now , DateTime("any date time compatible string")

   Cache _cache = NCache.InitializeCache("mycache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2); product2 = new Product(4, "Tunnbr?d", "", 5, 9); string qry = "SELECT Product where this.ProductName = ?"; Hashtable indexTable = new Hashtable(); indexTable.Add("ProductName", "Tunnbr?d"); ContinuousQuery cQuery = new ContinuousQuery(qry, indexTable);

_cache.Add("2202", product1); _cache.Add("2203", product2);

cQuery.RegisterNotification(new QueryDataNotificationCallback(QueryItemCallBack), EventType.ItemUpdated | EventType.ItemRemoved, EventDataFilter.None);

ICacheReader reader = _cache.ExecuteReaderCQ(cQuery,true,50); if (reader.FieldCount > 0) { while (reader.Read()) { object category = reader.GetValue(0); //perform operations } } else { //perform operations } reader.Close();

public void QueryItemCallBack(string key, CQEventArg arg) { switch (arg.EventType) { case EventType.ItemRemoved: //do something break; case EventType.ItemUpdated: //do something break; case EventType.ItemAdded: //do something break; } }

ExecuteTask(MapReduceTask)

Declaration

[TargetMethod(1)]
public virtual ITrackableTask ExecuteTask(MapReduceTask task)

Parameters

Returns

Examples

Note: Implemeting IReducerFactory,ICombinerFactory and ICmobiner is optional.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

MapReduceTask mapReduceTask = new MapReduceTask();
mapReduceTask.Mapper = new WordCountMapper();
mapReduceTask.Combiner = new WordCountCombinerFactory();
mapReduceTask.Reducer = new WordCountReducerFactory();

ITrackableTask trackableInstance = _cache.ExecuteTask(mapReduceTask);

//Mapper implementation
public class WordCountMapper : IMapper
{
    string[] parsedline;
    string line;
    public void Map(Object key, Object value, IOutputMap context)
    {
        line = value.ToString();
        parsedline = line.Split(' ');
        for (int i = parsedline.Length; i>=0; i++)
        {
            context.Emit(parsedline[i], 1);
        }
    }
    public void Dispose()
   {
       // Release Resources
   }
}

//CombinerFactory Implementation
public class WordCountCombinerFactory : ICombinerFactory
{
    public ICombiner Create(object key)
    {
        WordCountCombiner wcCombiner = new WordCountCombiner();
        return wcCombiner;
    }
}

//ICombiner Implementation
public class WordCountCombiner : ICombiner
{
    int count = 0;
    public void BeginCombine()
    {
        //any initialization
    }
     public void Combine(object value)
    {
        count += int.Parse(value.ToString());
    }
    public object FinishChunk()
    {
        return count;
    }
    public void Dispose()
    {
        // Release Resources
    }
}

//IReducerFactory Implementation
public class WordCountReducerFactory : IReducerFactory
{
    public IReducer Create(object key)
    {
        WordCountReducer wcReducer = new WordCountReducer(key);
        return wcReducer;
    }
}

//IReducer Implementation

public class WordCountReducer : IReducer
{
    int count = 0;
    object key;
    public WordCountReducer(object value)
    {
        key = value;
    }
    public void BeginReduce()
    {
        //perform operations
    }
    public void Reduce(object value)
    {
        count += int.Parse(value.ToString());
    }
    public KeyValuePair FinishReduce()
    {
        KeyValuePair kvp = null;
        kvp.Key = key;
        kvp.Value = count;
        return kvp;
    }
    public void Dispose()
    {
        // Release Resources
    }
}

ExecuteTask(MapReduceTask, IKeyFilter)

Declaration

[TargetMethod(2)]
public virtual ITrackableTask ExecuteTask(MapReduceTask task, IKeyFilter keyFilter)

Parameters

Returns

Examples

Note: Implemeting IReducerFactory,ICombinerFactory and ICmobiner is optional.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

MapReduceKeyFilter keyFilter= new  MapReduceKeyFilter();
MapReduceTask mapReduceTask = new MapReduceTask();
mapReduceTask.Mapper = new WordCountMapper();
mapReduceTask.Combiner = new WordCountCombinerFactory();
mapReduceTask.Reducer = new WordCountReducerFactory();

ITrackableTask trackableInstance = _cache.ExecuteTask(mapReduceTask,keyFilter);


//implementation of IKeyFilter
public class MapReduceKeyFilter : IKeyFilter
{
 public bool FilterKey(object key)
  {
   try
   {
       if (key.ToString().Contains("hungry"))
       {
           return true;
       }

   }
   catch (Exception exp)
   {
       //handle exception
   }
   return false;
  }
}


//Mapper implementation
public class WordCountMapper : IMapper
{
    string[] parsedline;
    string line;
    public void Map(Object key, Object value, IOutputMap context)
    {
        line = value.ToString();
        parsedline = line.Split(' ');
        for (int i = parsedline.Length; i>=0; i++)
        {
            context.Emit(parsedline[i], 1);
        }
    }
    public void Dispose()
   {
       // Release Resources
   }
}

//CombinerFactory Implementation
public class WordCountCombinerFactory : ICombinerFactory
{
    public ICombiner Create(object key)
    {
        WordCountCombiner wcCombiner = new WordCountCombiner();
        return wcCombiner;
    }
}

//ICombiner Implementation
public class WordCountCombiner : ICombiner
{
    int count = 0;
    public void BeginCombine()
    {
        //any initialization
    }
     public void Combine(object value)
    {
        count += int.Parse(value.ToString());
    }
    public object FinishChunk()
    {
        return count;
    }
    public void Dispose()
    {
        // Release Resources
    }
}

//IReducerFactory Implementation
public class WordCountReducerFactory : IReducerFactory
{
    public IReducer Create(object key)
    {
        WordCountReducer wcReducer = new WordCountReducer(key);
        return wcReducer;
    }
}

//IReducer Implementation

public class WordCountReducer : IReducer
{
    int count = 0;
    object key;
    public WordCountReducer(object value)
    {
        key = value;
    }
    public void BeginReduce()
    {
        //perform operations
    }
    public void Reduce(object value)
    {
        count += int.Parse(value.ToString());
    }
    public KeyValuePair FinishReduce()
    {
        KeyValuePair kvp = null;
        kvp.Key = key;
        kvp.Value = count;
        return kvp;
    }
    public void Dispose()
    {
        // Release Resources
    }
}

ExecuteTask(MapReduceTask, String, Hashtable)

Declaration

[TargetMethod(3)]
public virtual ITrackableTask ExecuteTask(MapReduceTask task, string query, Hashtable parameters)

Parameters

Returns

Examples

Note: Implemeting IReducerFactory,ICombinerFactory and ICmobiner is optional.

Cache _cache= NCache.InitializeCache("myCache");

product1 = new Product(3, "Clothes", "", 4, 2);
product2 = new Product(4, ""Shoes", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);

MapReduceTask mapReduceTask = new MapReduceTask();
mapReduceTask.Mapper = new WordCountMapper();
mapReduceTask.Combiner = new WordCountCombinerFactory();
mapReduceTask.Reducer = new WordCountReducerFactory();

Hashtable values = new Hashtable();
values.Add("Category", "Clothes");

string query = "SELECT Product WHERE this.Category IN (?)";
ITrackableTask trackableInstance = _cache.ExecuteTask(mapReduceTask,query,values);  


//Mapper implementation
public class WordCountMapper : IMapper
{
    string[] parsedline;
    string line;
    public void Map(Object key, Object value, IOutputMap context)
    {
        line = value.ToString();
        parsedline = line.Split(' ');
        for (int i = parsedline.Length; i>=0; i++)
        {
            context.Emit(parsedline[i], 1);
        }
    }
    public void Dispose()
   {
       // Release Resources
   }
}

//CombinerFactory Implementation
public class WordCountCombinerFactory : ICombinerFactory
{
    public ICombiner Create(object key)
    {
        WordCountCombiner wcCombiner = new WordCountCombiner();
        return wcCombiner;
    }
}

//ICombiner Implementation
public class WordCountCombiner : ICombiner
{
    int count = 0;
    public void BeginCombine()
    {
        //any initialization
    }
     public void Combine(object value)
    {
        count += int.Parse(value.ToString());
    }
    public object FinishChunk()
    {
        return count;
    }
    public void Dispose()
    {
        // Release Resources
    }
}

//IReducerFactory Implementation
public class WordCountReducerFactory : IReducerFactory
{
    public IReducer Create(object key)
    {
        WordCountReducer wcReducer = new WordCountReducer(key);
        return wcReducer;
    }
}

//IReducer Implementation

public class WordCountReducer : IReducer
{
    int count = 0;
    object key;
    public WordCountReducer(object value)
    {
        key = value;
    }
    public void BeginReduce()
    {
        //perform operations
    }
    public void Reduce(object value)
    {
        count += int.Parse(value.ToString());
    }
    public KeyValuePair FinishReduce()
    {
        KeyValuePair kvp = null;
        kvp.Key = key;
        kvp.Value = count;
        return kvp;
    }
    public void Dispose()
    {
        // Release Resources
    }
}

Finalize()

Declaration

protected void Finalize()

Get(String)

Declaration

[TargetMethod(7)]
public virtual object Get(string key)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
cache.Get("MyTextBox.Value");

Exceptions

Get(String, ref CacheItemVersion)

Declaration

[TargetMethod(4)]
public virtual object Get(string key, ref CacheItemVersion version)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.

Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", ref version);

Exceptions

Get(String, DSReadOption)

Declaration

[TargetMethod(8)]
public virtual object Get(string key, DSReadOption dsReadOption)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
string textBoxValue = (string) cache.Get("MyTextBox.Value", DSReadOption.ReadThru);

Exceptions

Get(String, DSReadOption, ref CacheItemVersion)

Declaration

[TargetMethod(3)]
public virtual object Get(string key, DSReadOption dsReadOption, ref CacheItemVersion version)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.

Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", DSReadOption.ReadThru, ref version);

Exceptions

Get(String, String, DSReadOption)

Declaration

[TargetMethod(1)]
public virtual object Get(string key, string providerName, DSReadOption dsReadOption)

Parameters

Returns

Get(String, String, DSReadOption, ref CacheItemVersion)

Declaration

[TargetMethod(5)]
public virtual object Get(string key, string providerName, DSReadOption dsReadOption, ref CacheItemVersion version)

Parameters

Returns

Get(String, String, String, DSReadOption)

Declaration

[TargetMethod(6)]
public virtual object Get(string key, string group, string subGroup, DSReadOption dsReadOption)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.

Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", "Customer", null, DSReadOption.ReadThru);

Exceptions

Get(String, TimeSpan, ref LockHandle, Boolean)

Declaration

[TargetMethod(2)]
public virtual object Get(string key, TimeSpan lockTimeout, ref LockHandle lockHandle, bool acquireLock)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the cached value and acquire a lock at the same time.

Cache theCache = NCache.InitializeCache("myreplicatedcache");
theCache.Add("cachedItemKey", new CacheItem("cachedItemValue"));

LockHandle lockHandle = new LockHandle();

object cachedItem = theCache.Get("cachedItemKey", Cache.NoLockingExpiration, ref lockHandle, true);

Exceptions

GetBulk(String[])

Declaration

[TargetMethod(2)]
public virtual IDictionary GetBulk(string[] keys)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
IDictionary items = cache.Get(keys);

Exceptions

GetBulk(String[], DSReadOption)

Declaration

[TargetMethod(1)]
public virtual IDictionary GetBulk(string[] keys, DSReadOption dsReadOption)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
IDictionary items = cache.Get(keys, DSReadOption.ReadThru);

Exceptions

GetBulk(String[], String, DSReadOption)

Declaration

[TargetMethod(3)]
public virtual IDictionary GetBulk(string[] keys, string providerName, DSReadOption dsReadOption)

Parameters

Returns

GetByAllTags(Tag[])

Declaration

[TargetMethod(1)]
public virtual Hashtable GetByAllTags(Tag[] tags)

Parameters

Returns

Examples

The following example demonstrates how to get the objects that have all the specified tags in common.

Cache cache = NCache.InitializeCache("myCache");
Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");
Hashtable table = cache.GetByAllTags(tags);

GetByAnyTag(Tag[])

Declaration

[TargetMethod(1)]
public virtual Hashtable GetByAnyTag(Tag[] tags)

Parameters

Returns

Examples

The following example demonstrates how to get the objects that have any of the specified tags in common.

Cache cache = NCache.InitializeCache("myCache");
Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");
Hashtable table = cache.GetByAnyTag(tags);

GetByTag(Tag)

Declaration

[TargetMethod(1)]
public virtual Hashtable GetByTag(Tag tag)

Parameters

Returns

Examples

The following example demonstrates how to get the objects with the specified tag.

Cache cache = NCache.InitializeCache("myCache");
Tag tag = new Tag("Sports");
Hashtable table = cache.GetByTag(tag);

GetCacheItem(String)

Declaration

[TargetMethod(1)]
public virtual CacheItem GetCacheItem(string key)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
CacheItem item = cache.GetCacheItem(key);

GetCacheItem(String, ref CacheItemVersion)

Declaration

[TargetMethod(6)]
public virtual CacheItem GetCacheItem(string key, ref CacheItemVersion version)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.

Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", ref version);

Exceptions

GetCacheItem(String, DSReadOption)

Declaration

[TargetMethod(4)]
public virtual CacheItem GetCacheItem(string key, DSReadOption dsReadOption)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
string textBoxValue = (string) cache.Get("MyTextBox.Value", DSReadOption.ReadThru);

Exceptions

GetCacheItem(String, DSReadOption, ref CacheItemVersion)

Declaration

[TargetMethod(5)]
public virtual CacheItem GetCacheItem(string key, DSReadOption dsReadOption, ref CacheItemVersion version)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.

Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", DSReadOption.ReadThru, ref version);

Exceptions

GetCacheItem(String, String, DSReadOption)

Declaration

[TargetMethod(5)]
public virtual CacheItem GetCacheItem(string key, string providerName, DSReadOption dsReadOption)

Parameters

Returns

GetCacheItem(String, String, DSReadOption, ref CacheItemVersion)

Declaration

[TargetMethod(7)]
public virtual CacheItem GetCacheItem(string key, string providerName, DSReadOption dsReadOption, ref CacheItemVersion version)

Parameters

Returns

GetCacheItem(String, String, String)

Declaration

[TargetMethod(2)]
[Obsolete("Use GetCacheItem(string key, string group, string subGroup, DSReadOption dsReadOption)")]
public virtual CacheItem GetCacheItem(string key, string group, string subGroup)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
CacheItem item = cache.GetCacheItem(key, "group-name", "subgroup-name");

GetCacheItem(String, String, String, DSReadOption)

Declaration

[TargetMethod(8)]
public virtual CacheItem GetCacheItem(string key, string group, string subGroup, DSReadOption dsReadOption)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.

Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", "Customer", null, DSReadOption.ReadThru);

Exceptions

GetCacheItem(String, TimeSpan, ref LockHandle, Boolean)

Declaration

[TargetMethod(3)]
public virtual CacheItem GetCacheItem(string key, TimeSpan lockTimeout, ref LockHandle lockHandle, bool acquireLock)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
LockHandle lockHandle = new LockHandle();
CacheItem item = cache.GetCacheItem("cachedItemKey",TimeSpan.FromSeconds(30) , ref lockHandle, true);

GetCacheStream(String, StreamMode)

Declaration

[TargetMethod(1)]
public virtual CacheStream GetCacheStream(string key, StreamMode streamMode)

Parameters

Returns

GetCacheStream(String, StreamMode, CacheItemPriority)

Declaration

[TargetMethod(2)]
public virtual CacheStream GetCacheStream(string key, StreamMode streamMode, CacheItemPriority priority)

Parameters

Returns

GetCacheStream(String, StreamMode, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(3)]
public virtual CacheStream GetCacheStream(string key, StreamMode streamMode, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

GetCacheStream(String, String, String, StreamMode, CacheItemPriority)

Declaration

[TargetMethod(4)]
public virtual CacheStream GetCacheStream(string key, string group, string subgroup, StreamMode streamMode, CacheItemPriority priority)

Parameters

Returns

GetCacheStream(String, String, String, StreamMode, CacheDependency, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(6)]
public virtual CacheStream GetCacheStream(string key, string group, string subGroup, StreamMode streamMode, CacheDependency dependency, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

GetCacheStream(String, String, String, StreamMode, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(5)]
public virtual CacheStream GetCacheStream(string key, string group, string subgroup, StreamMode streamMode, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

GetConnectedClientList()

Declaration

public virtual IList<ClientInfo> GetConnectedClientList()

Returns

GetEnumerator()

Declaration

[TargetMethod(1)]
public virtual IEnumerator GetEnumerator()

Returns

Remarks

GetGroupData(String, String)

Declaration

[TargetMethod(1)]
public virtual IDictionary GetGroupData(string group, string subGroup)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
Hashtable table = (Hashtable) cache.GetGroupData("Customer", "Orders");

Exceptions

GetGroupKeys(String, String)

Declaration

[TargetMethod(1)]
public virtual ArrayList GetGroupKeys(string group, string subGroup)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.

Cache cache = NCache.InitializeCache("myCache");
ArrayList list = (ArrayList) cache.GetGroupKeys("Customer", "Orders");

Exceptions

GetIfNewer(String, ref CacheItemVersion)

Declaration

[TargetMethod(1)]
public virtual object GetIfNewer(string key, ref CacheItemVersion version)

Parameters

Returns

Examples

The following example demonstrates how to get a newer version of the item from cache if it exists.

Cache cache = NCache.InitializeCache("myCache");
cache.GetIfNewer("key", ref itemVersion);

GetIfNewer(String, String, String, ref CacheItemVersion)

Declaration

[TargetMethod(2)]
public virtual object GetIfNewer(string key, string group, string subGroup, ref CacheItemVersion version)

Parameters

Returns

Examples

The following example demonstrates how to get a newer version of the item from cache if it exists.

Cache cache = NCache.InitializeCache("myCache");
cache.GetIfNewer("key", "Alpha", null, ref itemVersion);

GetKeysByAllTags(Tag[])

Declaration

[TargetMethod(1)]
public virtual ICollection GetKeysByAllTags(Tag[] tags)

Parameters

Returns

Examples

The following example demonstrates how to get the keys that have all the specified tags in common.

Cache cache = NCache.InitializeCache("myCache");
Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");
ICollection keys = cache.GetKeysByAllTags(tags);

GetKeysByAnyTag(Tag[])

Declaration

[TargetMethod(1)]
public virtual ICollection GetKeysByAnyTag(Tag[] tags)

Parameters

Returns

Examples

The following example demonstrates how to get the keys that have any of the specified tags in common.

Cache cache = NCache.InitializeCache("myCache");
Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");
ICollection keys = cache.GetKeysByAnyTag(tags);

GetKeysByTag(Tag)

Declaration

[TargetMethod(1)]
public virtual ICollection GetKeysByTag(Tag tag)

Parameters

Returns

Examples

The following example demonstrates how to get the keys with the specified tag.

Cache cache = NCache.InitializeCache("myCache");
Tag tag = new Tag("Sports");
ICollection keys = cache.GetKeysByTag(tag);

GetRunningTasks()

Declaration

[TargetMethod(1)]
public virtual ArrayList GetRunningTasks()

Returns

Examples

Cache _cache = NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);
// Implement Map Reduce Interferaces

MapReduceTask mapReduceTask = new MapReduceTask();
IList runningTasks = _cache.GetRunningTasks();

GetTaskResult(String)

Declaration

[TargetMethod(1)]
public virtual ITrackableTask GetTaskResult(string taskId)

Parameters

Returns

Examples

Cache _cache = NCache.InitializeCache("myCache");

product1 = new Product(3, "Tunnbr?d", "", 4, 2);
product2 = new Product(4, "Tunnbr?d", "", 5, 9);

_cache.Add("2202", product1);
_cache.Add("2203", product2);
// Implement Map Reduce Interferaces
MapReduceTask mapReduceTask = new MapReduceTask();

ITrackableTask trackableTask = _cache.ExecuteTask(mapReduceTask);
string taskID1=trackableTask.TaskId;
Random randomNumber = new Random();
string taskId2 = randomNumber.Next(2).ToString();

ITrackableTask testResult = _cache.GetTaskResult(taskId1); //returns the trackable instance

testResult = _cache.GetTaskResult(taskId12); //returns nothing as no task with such id is being running

Insert(String, CacheItem)

Declaration

[TargetMethod(7)]
public virtual CacheItemVersion Insert(string key, CacheItem item)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item to the cache with a sliding expiration of 5 minutes and a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItem.

CacheItem item = new CacheItem(timeStamp);
item.SlidingExpiration = new TimeSpan(0,5,0);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("timestamp", item);

Insert(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback)

Declaration

[TargetMethod(8)]
public virtual CacheItemVersion Insert(string key, CacheItem item, DSWriteOption dsWriteOption, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item to the cache with a sliding expiration of 5 minutes, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItem.

CacheItem item = new CacheItem(timeStamp);
item.SlidingExpiration = new TimeSpan(0,5,0);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("timestamp", item, DSWriteOption.WriteThru, new DataSourceItemsUpdatedCallback(OnDSItemsUpdated));

Insert(String, CacheItem, DSWriteOption, String, DataSourceItemsUpdatedCallback)

Declaration

[TargetMethod(9)]
public virtual CacheItemVersion Insert(string key, CacheItem item, DSWriteOption dsWriteOption, string providerName, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Returns

Examples

To create an instance of Cache class you can use code as follows:

Cache cache = NCache.InitializeCache("myReplicatedCache");
Application[�CacheHandle�] = cache;

Insert(String, CacheItem, LockHandle, Boolean)

Declaration

[TargetMethod(10)]
public virtual CacheItemVersion Insert(string key, CacheItem item, LockHandle lockHandle, bool releaseLock)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to update a locked item in the cache.

First create a CacheItem.

Cache theCache = NCache.InitializeCache("myreplicatedcache");

Add an item int the cache.

theCache.Add("cachedItemKey", new CacheItem("cachedItemValue"));

Create the objects for lockid and lockdate.

LockHandle lockHandle = new LockHandle();

Get the added item from cache and acquire a lock.

object cachedItem = theCache.Get("cachedItemKey", Cache.NoLockingExpiration, ref lockHandle, true);
if (cachedItem != null)
{
    try
    {
        theCache.Insert("cachedItemKey", new CacheItem("someothervalue"), lockHandle, true);
        string cachedValue = (string)theCache.Get("cachedItemKey");
    }
    catch (OperationFailedException ex)
    {
        //Do something
    }
}

Insert(String, Object)

Declaration

[TargetMethod(2)]
public virtual CacheItemVersion Insert(string key, object value)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to insert an item into an application's cache.

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("DSN", connectionString);

Exceptions

Insert(String, Object, NamedTagsDictionary)

Declaration

[TargetMethod(1)]
public virtual CacheItemVersion Insert(string key, object value, NamedTagsDictionary namedTags)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item into an application's cache.

Cache cache = NCache.InitializeCache("myCache");
NamedTagsDictionary namedTags = new NamedTagsDictionary();
namedTags.Add("Attribute", "value");
cache.Insert("DSN", connectionString, namedTags);

Exceptions

Insert(String, Object, Tag[])

Declaration

[TargetMethod(4)]
public virtual CacheItemVersion Insert(string key, object value, Tag[] tags)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to add an item into an application's cache.

Cache cache = NCache.InitializeCache("myCache");
Tag[] tags = new Tag[1];
tags[0] = new Tag("tag-name");
cache.Insert("DSN", connectionString, tags);

Exceptions

Insert(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(5)]
public virtual CacheItemVersion Insert(string key, object value, CacheDependency dependency, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to assign an item high priority when you insert it into your application's Cache object.

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("DSN", connectionString, null, DateTime.Now.AddMinutes(2), TimeSpan.Zero, CacheItemPriority.High);

Exceptions

Insert(String, Object, DateTime, TimeSpan, CacheItemPriority)

Declaration

[TargetMethod(6)]
public virtual CacheItemVersion Insert(string key, object value, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to assign an item high priority when you insert it into your application's Cache object.

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("DSN", connectionString, null, DateTime.Now.AddMinutes(2), TimeSpan.Zero, CacheItemPriority.High);

Exceptions

Insert(String, Object, String, String)

Declaration

[TargetMethod(3)]
public virtual CacheItemVersion Insert(string key, object value, string group, string subGroup)

Parameters

Returns

Examples

Cache cache = NCache.InitializeCache("myCache");
cache.Insert("DSN", value, "CONNECTIONS", null);

InsertAsync(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback)

Declaration

[TargetMethod(2)]
public virtual void InsertAsync(string key, CacheItem item, DSWriteOption dsWriteOption, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Remarks

Examples

The following example demonstrates how to insert an item into the cache asynchronously. It also provides the option to udpate the data source and registers a delegate to get the result of the data source operation.

CacheItem item = new CacheItem(connectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(2);
item.SlidingExpiration = TimeSpan.Zero;
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;
item.AsyncItemUpdateCallback = OnAsyncItemUpdated;

Then insert CacheItem to the cache

Cache cache = NCache.InitializeCache("myCache");
cache.InsertAsync("DSN", item, DSWriteOption.WriteThru, new DataSourceItemsUpdatedCallback(onDSItemsUpdated));

InsertAsync(String, CacheItem, String, DSWriteOption, DataSourceItemsUpdatedCallback)

Declaration

[TargetMethod(3)]
public virtual void InsertAsync(string key, CacheItem item, string providerName, DSWriteOption dsWriteOption, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

InsertAsync(String, Object, AsyncItemUpdatedCallback, String, String)

Declaration

[TargetMethod(1)]
public virtual void InsertAsync(string key, object value, AsyncItemUpdatedCallback onAsyncItemUpdateCallback, string group, string subGroup)

Parameters

Remarks

Examples

The following example demonstrates how to insert an item into the cache asynchronously with associated group and subGroup. It also registers a delegate to get the result of the asynchronous operation. it into your application's Cache object.

Cache cache = NCache.InitializeCache("myCache");
cache.InsertAsync("DSN", connectionString, new AsyncItemUpdatedCallback(onAsyncItemUpdated), "group-name", "subGroup-name");

Exceptions

InsertAsyncOperation(String, Object, CacheDependency, CacheSyncDependency, DateTime, TimeSpan, CacheItemPriority, DSWriteOption, CacheItemRemovedCallback, CacheItemUpdatedCallback, AsyncItemUpdatedCallback, DataSourceItemsUpdatedCallback, Boolean, String, String, Tag[], String, NamedTagsDictionary, CacheDataNotificationCallback, CacheDataNotificationCallback, EventDataFilter, EventDataFilter, String, Int16, Int16, Int16)

Declaration

protected virtual void InsertAsyncOperation(string key, object value, CacheDependency dependency, CacheSyncDependency syncDependency, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority, DSWriteOption dsWriteOption, CacheItemRemovedCallback onRemoveCallback, CacheItemUpdatedCallback onUpdateCallback, AsyncItemUpdatedCallback onAsyncItemUpdateCallback, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback, bool isResyncExpiredItems, string group, string subGroup, Tag[] tags, string providerName, NamedTagsDictionary namedTags, CacheDataNotificationCallback cacheItemUdpatedCallback, CacheDataNotificationCallback cacheItemRemovedCallaback, EventDataFilter itemUpdateDataFilter, EventDataFilter itemRemovedDataFilter, string clientId, short updateCallbackID, short removeCallbackId, short dsItemAddedCallbackID)

Parameters

InsertBulk(String[], CacheItem[])

Declaration

[TargetMethod(2)]
public virtual IDictionary InsertBulk(string[] keys, CacheItem[] items)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to assign an item high priority when you insert it into your application's Cache object. First create CacheItems.

string[] keys = {"SQLDSN", "ORADSN"};
CacheItem items[] = new CacheItem[2];
items[0] = new CacheItem(sqlConnectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(2);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

items[1] = new CacheItem(oraConnectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(1);
item.Priority = CacheItemPriority.Low;
item.ItemRemoveCallback = onRemove;

Then insert CacheItems to the cache

Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
CacheItem[] items = new CacheItem[]{myItem1, myItem2};
cache.InsertBulk(keys, items);

InsertBulk(String[], CacheItem[], DSWriteOption, DataSourceItemsUpdatedCallback)

Declaration

[TargetMethod(1)]
public virtual IDictionary InsertBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOption, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to assign an item high priority when you insert it into your application's Cache object.

Note: For more information about how to use this method with the CacheItemRemovedCallback delegate, see CacheItemRemovedCallback.

string[] keys = {"SQLDSN", "ORADSN"};
CacheItem items[] = new CacheItem[2];
items[0] = new CacheItem(sqlConnectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(2);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

items[1] = new CacheItem(oraConnectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(1);
item.Priority = CacheItemPriority.Low;
item.ItemRemoveCallback = onRemove;

Then insert CacheItems to the cache

Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
CacheItem[] items = new CacheItem[]{myItem1, myItem2};
cache.InsertBulk(keys, items, DSWriteOption.WriteThru, new DataSourceItemsUpdatedCallback(onDSItemsUpdated));

InsertBulk(String[], CacheItem[], DSWriteOption, String, DataSourceItemsUpdatedCallback)

Declaration

[TargetMethod(3)]
public virtual IDictionary InsertBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOption, string providerName, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to assign an item high priority when you insert it into your application's Cache object.

Note: For more information about how to use this method with the CacheItemRemovedCallback delegate, see CacheItemRemovedCallback.

string[] keys = {"SQLDSN", "ORADSN"};
CacheItem items[] = new CacheItem[2];
items[0] = new CacheItem(sqlConnectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(2);
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

items[1] = new CacheItem(oraConnectionString);
item.AbsoluteExpiration = DateTime.Now.AddMinutes(1);
item.Priority = CacheItemPriority.Low;
item.ItemRemoveCallback = onRemove;

Then insert CacheItems to the cache

Cache cache = NCache.InitializeCache("myCache");
string[] keys = new string[]{"myItem1", "myItem2"};
CacheItem[] items = new CacheItem[]{myItem1, myItem2};
cache.InsertBulk(keys, items, DSWriteOption.WriteThru, providerName, new DataSourceItemsUpdatedCallback(onDSItemsUpdated));

Invoke(String, IEntryProcessor, DSReadOption, String, DSWriteOption, String, Object[])

Declaration

[TargetMethod(1)]
public object Invoke(string key, IEntryProcessor entryProcessor, DSReadOption dsReadOption = DSReadOption.None, string readProviderName = "default", DSWriteOption dsWriteOption = DSWriteOption.None, string writeProviderName = "default", params object[] arguments)

Parameters

Returns

Examples

Argumetns is optional. Also exception can be thrown explicitily by specifying such cases while implementing IEntryProcessor interface.

Cache _cache= NCache.InitializeCache("myCache");

//Get a new instance of sample Class implementing EntryProcessor interface.
CustomEntryProcessor myProcessor = new CustomEntryProcessor();

_cache.Insert("1", "Value1");
_cache.Insert("2", "Value2");
_cache.Insert("15", "Value3");
//Invoking the Entry processor on a single item.

Object invokerVal = _cache.Invoke("1", myProcessor); 
//Invoking the Entry processor against a single item.
invokerVal = _cache.Invoke("15", myProcessor);

//Implementation of IEntryProcesser Interface
public class CustomEntryProcessor : IEntryProcessor
{
    public bool IgnoreLock()
    {
        return true;
    }
    public object ProcessEntry(IMutableEntry entry, params object[] arguments)
    {
     if (entry.Key.Equals("1"))
       {
        if (entry.Exists())
         {
           entry.Remove();
           return 0;
         }
        else
        {
           entry.Remove();
           return -1;
        }
      }
     else if (entry.Equals("15"))
    {
       object value = "Greater Than 10";
       entry.Value = value;
       return value;
     }

   return 1;
   }
}

Invoke(String[], IEntryProcessor, DSReadOption, String, DSWriteOption, String, Object[])

Declaration

[TargetMethod(2)]
public virtual ICollection Invoke(string[] keys, IEntryProcessor entryProcessor, DSReadOption dsReadOption = DSReadOption.None, string readProviderName = "default", DSWriteOption dsWriteOption = DSWriteOption.None, string writeProviderName = "default", params object[] arguments)

Parameters

Returns

Examples

Cache _cache= NCache.InitializeCache("myCache");

//Get a new instance of sample Class implementing EntryProcessor interface.
CustomEntryProcessor myProcessor = new CustomEntryProcessor();
string[] keys = new string[] { "1", "5", "12", "15" };

_cache.Insert(keys[0], "Value1");
_cache.Insert(keys[1], "Value1");
_cache.Insert(keys[2], "Value1");
_cache.Insert(keys[3], "Value1");
//Invoking the Entry processor against a set of items.

ICollection retEntries = _cache.Invoke(keys, myProcessor);

//Implementation of IEntryProcesser Interface
public class CustomEntryProcessor : IEntryProcessor
{
    public bool IgnoreLock()
    {
        return true;
    }
    public object ProcessEntry(IMutableEntry entry, params object[] arguments)
    {
     if (entry.Key.Equals("1"))
       {
        if (entry.Exists())
         {
           entry.Remove();
           return 0;
         }
        else
        {
           entry.Remove();
           return -1;
        }
      }
     else if (entry.Equals("15"))
    {
       object value = "Greater Than 10";
       entry.Value = value;
       return value;
     }

   return 1;
   }
}

Lock(String, TimeSpan, out LockHandle)

Declaration

[TargetMethod(1)]
public virtual bool Lock(string key, TimeSpan lockTimeout, out LockHandle lockHandle)

Parameters

Returns

Examples

Following example demonstrates how to lock a cached item.

...
LockHandle lockHandle = new LockHandle();
bool locked = theCache.lock("cachedItemKey", new TimeSpan(0,0,10), out lockHandle);
...

Log(String, String)

Declaration

public virtual void Log(string module, string message)

Parameters

RaiseCustomEvent(Object, Object)

Declaration

[TargetMethod(1)]
public virtual void RaiseCustomEvent(object notifId, object data)

Parameters

Remarks

Examples

The following example demonstrates how to raise a custom application defined event.

Cache cache = NCache.InitializeCache("myCache");
cache.RaiseCustomEvent(MyNotificationCodes.ConsumeItem,
      new ItemData(DateTime.Now));

RegisterCacheNotification(CacheDataNotificationCallback, EventType, EventDataFilter)

Declaration

public virtual CacheEventDescriptor RegisterCacheNotification(CacheDataNotificationCallback cacheDataNotificationCallback, EventType eventType, EventDataFilter datafilter)

Parameters

Returns

Remarks

Examples

First create an ItemCallback

ItemCallback(string key, CacheEventArg e)
{
   ...
}

Then register the Cache Notification

Cache cache = NCache.InitializeCache("myCache");
CacheEventDescriptor descriptor=cache.RegisterCacheNotification(new CacheDataNotificationCallback(ItemCallback), EventType.ItemAdded, EventDataFilter.None);

RegisterCacheNotification(String, CacheDataNotificationCallback, EventType)

Declaration

public void RegisterCacheNotification(string key, CacheDataNotificationCallback selectiveCacheDataNotificationCallback, EventType eventType)

Parameters

Examples

First create an ItemCallback

ItemCallback(string key, CacheEventArg e)
{
   ...
}

Then register the Key Notification

Cache cache = NCache.InitializeCache("myCache");
cache.RegisterCacheNotification(key, new CacheDataNotificationCallback(ItemCallback), EventType.ItemUpdated);

RegisterCacheNotification(String, CacheDataNotificationCallback, EventType, EventDataFilter)

Declaration

public virtual void RegisterCacheNotification(string key, CacheDataNotificationCallback selectiveCacheDataNotificationCallback, EventType eventType, EventDataFilter datafilter)

Parameters

Examples

First create an ItemCallback

ItemCallback(string key, CacheEventArg e)
{
   ...
}

Then register the Key Notification

Cache cache = NCache.InitializeCache("myCache");
cache.RegisterCacheNotification(key, new CacheDataNotificationCallback(ItemCallback), EventType.ItemUpdated, EventDataFilter.None);

RegisterCacheNotification(String[], CacheDataNotificationCallback, EventType)

Declaration

public void RegisterCacheNotification(string[] keys, CacheDataNotificationCallback selectiveCacheDataNotificationCallback, EventType eventType)

Parameters

Examples

First create an ItemCallback

ItemCallback(string key, CacheEventArg e)
{
   ...
}

Then register the Key Notification

Cache cache = NCache.InitializeCache("myCache");
string[] keys=new string[size];
cache.RegisterCacheNotification(keys,new CacheDataNotificationCallback(ItemCallback), EventType.ItemUpdated);

RegisterCacheNotification(String[], CacheDataNotificationCallback, EventType, EventDataFilter)

Declaration

public virtual void RegisterCacheNotification(string[] keys, CacheDataNotificationCallback selectiveCacheDataNotificationCallback, EventType eventType, EventDataFilter datafilter)

Parameters