Class DisconnectedClientCache

Namespace:

Assembly: Alachisoft.NCache.Web.dll

Syntax

public sealed class DisconnectedClientCache : Cache, IEnumerable, IDisposable

Remarks

Properties

ClientInfo

Declaration

public override ClientInfo ClientInfo { get; }

Property Value

Overrides

Count

Declaration

public override long Count { get; }

Property Value

Overrides

Remarks

ExceptionsEnabled

Declaration

public override bool ExceptionsEnabled { get; set; }

Property Value

Overrides

Remarks

Examples

This sample shows how to set the ExceptionsEnabled property.

NCache.Cache.ExceptionsEnabled = true;

Item[String]

Declaration

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

Parameters

Property Value

Overrides

Remarks

Examples

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

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

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

Or simply in a class deriving from or .

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 override IMessagingService MessagingService { get; }

Property Value

Overrides

Password

Declaration

public byte[] Password { get; set; }

Property Value

UserId

Declaration

public string UserId { get; set; }

Property Value

Methods

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 override 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 dsItemAddedCallback)

Parameters

Overrides

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

Declaration

public override IDictionary AddBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOptions, DataSourceItemsAddedCallback onDataSourceItemsAdded)

Parameters

Returns

Overrides

Remarks

Examples

The following example demonstrates how to add items to the cache with an absolute expiration defined by a variable d, a sliding expiration defined by a variable t, a priority of high, and that notifies the application when the item is removed from the cache.

First create a CacheItems.

string keys = {"ORD_23", "ORD_67"};
CacheItem items = new CacheItem[2]
items[0] = new CacheItem(new Order());
items[0].AbsoluteExpiration = d;
items[0].SlidingExpiration = t;
items[0].Priority = CacheItemPriority.High;
items[0].ItemRemoveCallback = onRemove;

items[1] = new CacheItem(new Order());
items[1].AbsoluteExpiration = d;
items[1].SlidingExpiration = t;
items[1].Priority = CacheItemPriority.Low;
items[1].ItemRemoveCallback = onRemove;

Then add CacheItem to the cache

NCache.Cache.Add(keys, items, "Customer", "Orders");

Cache.Add(keys, items, "Customer", "Orders");

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

Declaration

public override IDictionary AddBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOptions, string providerName, DataSourceItemsAddedCallback onDataSourceItemsAdded)

Parameters

Returns

Overrides

AddDependency(String, CacheDependency, Boolean)

Declaration

public override bool AddDependency(string key, CacheDependency dependency, bool isResyncRequired)

Parameters

Returns

Overrides

AddDependency(String, CacheSyncDependency)

Declaration

public override bool AddDependency(string key, CacheSyncDependency syncDependency)

Parameters

Returns

Overrides

Aggregate(IValueExtractor, IAggregator)

Declaration

public override object Aggregate(IValueExtractor extractor, IAggregator aggregator)

Parameters

Returns

Overrides

Aggregate(IValueExtractor, IAggregator, IKeyFilter)

Declaration

public override object Aggregate(IValueExtractor extractor, IAggregator aggregator, IKeyFilter keyFilter)

Parameters

Returns

Overrides

Aggregate(IValueExtractor, IAggregator, IKeyFilter, Int32)

Declaration

public override object Aggregate(IValueExtractor extractor, IAggregator aggregator, IKeyFilter keyFilter, int timeout)

Parameters

Returns

Overrides

Aggregate(IValueExtractor, IAggregator, Int32)

Declaration

public override object Aggregate(IValueExtractor extractor, IAggregator aggregator, int timeout)

Parameters

Returns

Overrides

Aggregate(IValueExtractor, IAggregator, String, Hashtable)

Declaration

public override object Aggregate(IValueExtractor extractor, IAggregator aggregator, string query, Hashtable parameters)

Parameters

Returns

Overrides

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

Declaration

public override object Aggregate(IValueExtractor extractor, IAggregator aggregator, string query, Hashtable parameters, int timeout)

Parameters

Returns

Overrides

Clear(DSWriteOption, DataSourceClearedCallback)

Declaration

public override void Clear(DSWriteOption updateOpt, DataSourceClearedCallback dataSourceClearedCallback)

Parameters

Overrides

Remarks

Examples

The following example demonstrates how to clear the Cache.

NCache.Cache.Clear();

Or simply in a class deriving from or .

Cache.Clear();

ClearAsync(AsyncCacheClearedCallback)

Declaration

public override void ClearAsync(AsyncCacheClearedCallback onAsyncCacheClearCallback)

Parameters

Overrides

Remarks

Examples

The following example demonstrates how to clear the Cache.

void OnAsyncCacheCleared(object result)
{
...
}

NCache.Cache.ClearAsync(new AsyncCacheClearedCallback(OnAsyncCacheCleared));

Or simply in a class deriving from or .

Cache.ClearAsync(new AsyncCacheClearedCallback(OnAsyncCacheCleared));

ClearAsync(DSWriteOption, AsyncCacheClearedCallback, DataSourceClearedCallback)

Declaration

public override void ClearAsync(DSWriteOption updateOpt, AsyncCacheClearedCallback onAsyncCacheClearCallback, DataSourceClearedCallback dataSourceClearedCallback)

Parameters

Overrides

ClearClientCache()

Declaration

public override void ClearClientCache()

Overrides

ClearClientCacheAsync(AsyncCacheClearedCallback)

Declaration

public override void ClearClientCacheAsync(AsyncCacheClearedCallback onAsyncCacheClearCallback)

Parameters

Overrides

Remarks

Examples

The following example demonstrates how to clear the client cache.

void OnAsyncCacheCleared(object result)
{
...
}

NCache.Cache.ClearClientCacheAsync(new AsyncCacheClearedCallback(OnAsyncCacheCleared));

Or simply in a class deriving from or .

Cache.ClearClientCacheAsync(new AsyncCacheClearedCallback(OnAsyncCacheCleared));

Contains(String)

Declaration

public override bool Contains(string key)

Parameters

Returns

Overrides

Remarks

Examples

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

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

Or simply in a class deriving from or .

if(Cache.Contains("MyTextBox.Value"))
{
    Response.Write("Item found!");
}

Exceptions

Delete(String, CacheItemVersion)

Declaration

public override void Delete(string key, CacheItemVersion version)

Parameters

Overrides

Delete(String, DSWriteOption, DataSourceItemsRemovedCallback)

Declaration

public override void Delete(string key, DSWriteOption dsWriteOption, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Overrides

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, new DataSourceItemsRemovedCallback(OnDataSourceItemsRemoved));

Exceptions

Delete(String, DSWriteOption, String, DataSourceItemsRemovedCallback)

Declaration

public override void Delete(string key, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Overrides

Delete(String, LockHandle)

Declaration

public override void Delete(string key, LockHandle lockHandle)

Parameters

Overrides

DeleteBulk(String[], DSWriteOption, DataSourceItemsRemovedCallback)

Declaration

public override void DeleteBulk(string[] keys, DSWriteOption dsWriteOption, DataSourceItemsRemovedCallback onDataSourceItemsRemovedCallback)

Parameters

Overrides

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.DeleteBulk(keys, DSWriteOption.WriteBehind, new DataSourceItemsRemovedCallback(OnDataSourceItemsRemoved));

Exceptions

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

Declaration

public override void DeleteBulk(string[] keys, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemsRemovedCallback)

Parameters

Overrides

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.DeleteBulk(keys, DSWriteOption.WriteBehind, "writeThruProvider", new DataSourceItemsRemovedCallback(OnDataSourceItemsRemoved));

Exceptions

Dispose()

Declaration

public override void Dispose()

Overrides

Remarks

ExecuteNonQuery(String, IDictionary)

Declaration

public override int ExecuteNonQuery(string query, IDictionary values)

Parameters

Returns

Overrides

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

public override ICacheReader ExecuteReader(string query, IDictionary values)

Parameters

Returns

Overrides

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 result=_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)";
result=_cache.ExecuteReader(query,values);

ExecuteReader(String, IDictionary, Boolean)

Declaration

public override ICacheReader ExecuteReader(string query, IDictionary values, bool getData)

Parameters

Returns

Overrides

ExecuteReader(String, IDictionary, Boolean, Int32)

Declaration

public override ICacheReader ExecuteReader(string query, IDictionary values, bool getData, int chunkSize)

Parameters

Returns

Overrides

ExecuteReaderCQ(ContinuousQuery)

Declaration

public override ICacheReader ExecuteReaderCQ(ContinuousQuery query)

Parameters

Returns

Overrides

ExecuteReaderCQ(ContinuousQuery, Boolean)

Declaration

public override ICacheReader ExecuteReaderCQ(ContinuousQuery cquery, bool getData)

Parameters

Returns

Overrides

ExecuteReaderCQ(ContinuousQuery, Boolean, Int32)

Declaration

public override ICacheReader ExecuteReaderCQ(ContinuousQuery query, bool getData, int chunkSize)

Parameters

Returns

Overrides

ExecuteTask(MapReduceTask)

Declaration

public override ITrackableTask ExecuteTask(MapReduceTask task)

Parameters

Returns

Overrides

ExecuteTask(MapReduceTask, IKeyFilter)

Declaration

public override ITrackableTask ExecuteTask(MapReduceTask task, IKeyFilter keyFilter)

Parameters

Returns

Overrides

ExecuteTask(MapReduceTask, String, Hashtable)

Declaration

public override ITrackableTask ExecuteTask(MapReduceTask task, string query, Hashtable parameters)

Parameters

Returns

Overrides

Get(String, DSReadOption)

Declaration

public override object Get(string key, DSReadOption dsReadOption)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Get("MyTextBox.Value");

Or simply in a class deriving from or .

Cache.Get("MyTextBox.Value");

Exceptions

Get(String, DSReadOption, ref CacheItemVersion)

Declaration

public override object Get(string key, DSReadOption dsReadOption, ref CacheItemVersion version)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Get("MyTextBox.Value", "Customer", null);

Or simply in a class deriving from or .

Cache.Get("MyTextBox.Value", "Customer", null);

Exceptions

Get(String, String, DSReadOption)

Declaration

public override object Get(string key, string providerName, DSReadOption dsReadOption)

Parameters

Returns

Overrides

Get(String, String, DSReadOption, ref CacheItemVersion)

Declaration

public override object Get(string key, string providerName, DSReadOption dsReadOption, ref CacheItemVersion version)

Parameters

Returns

Overrides

Get(String, String, String, DSReadOption)

Declaration

public override object Get(string key, string group, string subGroup, DSReadOption dsReadOpt)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Get("MyTextBox.Value", "Customer", null);

Or simply in a class deriving from or .

Cache.Get("MyTextBox.Value", "group", "subGroup", "Customer", null);

Exceptions

Get(String, TimeSpan, ref LockHandle, Boolean)

Declaration

public override object Get(string key, TimeSpan lockTimeout, ref LockHandle lockHandle, bool acquireLock)

Parameters

Returns

Overrides

Remarks

Examples

The following example demonstrates how to retrieve the value cached and acquire a lock

object lockId = null;
DateTime nowTime = DateTime.Now;

object cachedItem = theCache.Get("cachedItemKey", ref lockId, ref nowTime, true);

Exceptions

GetBulk(String[], DSReadOption)

Declaration

public override IDictionary GetBulk(string[] keys, DSReadOption dsReadOption)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Get(keys);

Or simply in a class deriving from or .

Cache.Get(keys,DSReadOption.ReadThru);

Exceptions

GetBulk(String[], String, DSReadOption)

Declaration

public override IDictionary GetBulk(string[] keys, string providerName, DSReadOption dsReadOption)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Get(keys);

Or simply in a class deriving from or .

Cache.Get(keys,DSReadOption.ReadThru);

Exceptions

GetByAllTags(Tag[])

Declaration

public override Hashtable GetByAllTags(Tag[] tags)

Parameters

Returns

Overrides

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

public override Hashtable GetByAnyTag(Tag[] tags)

Parameters

Returns

Overrides

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

public override Hashtable GetByTag(Tag tag)

Parameters

Returns

Overrides

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

public override CacheItem GetCacheItem(string key)

Parameters

Returns

Overrides

GetCacheItem(String, String, String)

Declaration

public override CacheItem GetCacheItem(string key, string group, string subGroup)

Parameters

Returns

Overrides

GetCacheItem(String, TimeSpan, ref LockHandle, Boolean)

Declaration

public override CacheItem GetCacheItem(string key, TimeSpan lockTimeout, ref LockHandle lockHandle, bool acquireLock)

Parameters

Returns

Overrides

Remarks

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

Declaration

public override CacheStream GetCacheStream(string key, string group, string subGroup, StreamMode streamMode, CacheDependency dependency, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority)

Parameters

Returns

Overrides

GetConnectedClientList()

Declaration

public override IList<ClientInfo> GetConnectedClientList()

Returns

Overrides

GetEnumerator()

Declaration

public override IEnumerator GetEnumerator()

Returns

Overrides

Remarks

GetGroupData(String, String)

Declaration

public override IDictionary GetGroupData(string group, string subGroup)

Parameters

Returns

Overrides

Remarks

Examples

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

Hashtable table = NCache.Cache.Get("Customer", "Orders");

Or simply in a class deriving from or .

Hashtable table = Cache.Get("Customer", "Orders");

Exceptions

GetGroupKeys(String, String)

Declaration

public override ArrayList GetGroupKeys(string group, string subGroup)

Parameters

Returns

Overrides

Remarks

Examples

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

ArrayList list = NCache.Cache.Get("Customer", "Orders");

Or simply in a class deriving from or .

ArrayList list = Cache.Get("Customer", "Orders");

Exceptions

GetIfNewer(String, String, String, ref CacheItemVersion)

Declaration

public override object GetIfNewer(string key, string group, string subGroup, ref CacheItemVersion version)

Parameters

Returns

Overrides

GetKeysByAllTags(Tag[])

Declaration

public override ICollection GetKeysByAllTags(Tag[] tags)

Parameters

Returns

Overrides

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

public override ICollection GetKeysByAnyTag(Tag[] tags)

Parameters

Returns

Overrides

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

public override ICollection GetKeysByTag(Tag tag)

Parameters

Returns

Overrides

GetRunningTasks()

Declaration

public override ArrayList GetRunningTasks()

Returns

Overrides

GetTaskResult(String)

Declaration

public override ITrackableTask GetTaskResult(string taskId)

Parameters

Returns

Overrides

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 override 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

Overrides

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

Declaration

public override IDictionary InsertBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOptions, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Returns

Overrides

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.SlidingExpiration = TimeSpan.Zero;
item.Priority = CacheItemPriority.High;
item.ItemRemoveCallback = onRemove;

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

Then insert CacheItems to the cache

NCache.Cache.Insert(keys, items, "Connection", null);

Or simply in a class deriving from or .

Cache.Insert(keys, items, "Connection", null);

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

Declaration

public override IDictionary InsertBulk(string[] keys, CacheItem[] items, DSWriteOption dsWriteOptions, string provider, DataSourceItemsUpdatedCallback onDataSourceItemUpdatedCallback)

Parameters

Returns

Overrides

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));

Lock(String, TimeSpan, out LockHandle)

Declaration

public override bool Lock(string key, TimeSpan lockTimeout, out LockHandle lockHandle)

Parameters

Returns

Overrides

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);
...

RaiseCustomEvent(Object, Object)

Declaration

public override void RaiseCustomEvent(object notifId, object data)

Parameters

Overrides

Remarks

Examples

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

NCache.Cache.RaiseCustomEvent(MyNotificationCodes.ConsumeItem,
      new ItemData(DateTime.Now));

Cache.RaiseCustomEvent(MyNotificationCodes.ConsumeItem,
      new ItemData(DateTime.Now)); 

RegisterCacheNotification(CacheDataNotificationCallback, EventType, EventDataFilter)

Declaration

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

Parameters

Returns

Overrides

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, EventDataFilter)

Declaration

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

Parameters

Overrides

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.ItemAdded, EventDataFilter.None);

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

Declaration

public override void RegisterCacheNotification(string[] key, CacheDataNotificationCallback selectiveCacheDataNotificationCallback, EventType eventType, EventDataFilter datafilter)

Parameters

Overrides

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, EventDataFilter.None);

RegisterCQ(ContinuousQuery)

Declaration

public override void RegisterCQ(ContinuousQuery query)

Parameters

Overrides

RegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback)

Declaration

public override void RegisterKeyNotificationCallback(string key, CacheItemUpdatedCallback updateCallback, CacheItemRemovedCallback removeCallback)

Parameters

Overrides

Remarks

Remove(String, CacheItemVersion)

Declaration

public override object Remove(string key, CacheItemVersion version)

Parameters

Returns

Overrides

Remove(String, DSWriteOption, DataSourceItemsRemovedCallback)

Declaration

public override object Remove(string key, DSWriteOption dsWriteOption, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Remove("timestamp");

Or simply in a class deriving from or .

Cache.Remove("timestamp");

Exceptions

Remove(String, DSWriteOption, String, DataSourceItemsRemovedCallback)

Declaration

public override object Remove(string key, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Returns

Overrides

Remove(String, LockHandle)

Declaration

public override object Remove(string key, LockHandle lockHandle)

Parameters

Returns

Overrides

RemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, String, DataSourceItemsRemovedCallback)

Declaration

public override void RemoveAsync(string key, AsyncItemRemovedCallback onAsyncItemRemoveCallback, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback)

Parameters

Overrides

Remarks

Examples

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

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

NCache.Cache.RemoveAsync("timestamp", new AsyncItemRemovedCallback(OnAsyncItemRemoved));

Or simply in a class deriving from or .

Cache.RemoveAsync("timestamp", new AsyncItemRemovedCallback(OnAsyncItemRemoved));

Exceptions

RemoveBulk(String[], DSWriteOption, DataSourceItemsRemovedCallback)

Declaration

public override IDictionary RemoveBulk(string[] keys, DSWriteOption dsWriteOption, DataSourceItemsRemovedCallback onDataSourceItemsRemovedCallback)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Remove(keys);

Or simply in a class deriving from or .

Cache.Remove(keys);

Exceptions

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

Declaration

public override IDictionary RemoveBulk(string[] keys, DSWriteOption dsWriteOption, string providerName, DataSourceItemsRemovedCallback onDataSourceItemsRemovedCallback)

Parameters

Returns

Overrides

Remarks

Examples

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

NCache.Cache.Remove(keys);

Or simply in a class deriving from or .

Cache.Remove(keys);

Exceptions

RemoveByAllTags(Tag[])

Declaration

public override void RemoveByAllTags(Tag[] tags)

Parameters

Overrides

Examples

The following example demonstrates how to remove the objects that have all 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");
cache.RemoveByAllMatchingTags(tags);

RemoveByAnyTag(Tag[])

Declaration

public override void RemoveByAnyTag(Tag[] tags)

Parameters

Overrides

Examples

The following example demonstrates how to remove 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");
cache.RemoveByAnyMatchingTag(tags);

RemoveByTag(Tag)

Declaration

public override void RemoveByTag(Tag tag)

Parameters

Overrides

Examples

The following example demonstrates how to remove the objects that have the specified tag.

Cache cache = NCache.InitializeCache("myCache");
Tag tag = new Tag("Alpha");
cache.RemoveByTag(tag);

RemoveGroupData(String, String)

Declaration

public override void RemoveGroupData(string group, string subGroup)

Parameters

Overrides

Search(String, IDictionary)

Declaration

public override ICollection Search(string query, IDictionary values)

Parameters

Returns

Overrides

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")

Hashtable values = new Hashtable();
values.add("Name", "Paul Jones");
"select Test.Application.Employee where this.Name = ?"

values.add("Salary", 2000);
"select Test.Application.Employee where this.Salary > ?"

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

values.Add("Name", "Paul Jones");
values.Add("Salary", 2000);
"select Test.Application.Employee where Not(this.Name = 'Paul Jones' and this.Salary > 2000)"

SearchCQ(ContinuousQuery)

Declaration

public override ICollection SearchCQ(ContinuousQuery query)

Parameters

Returns

Overrides

SearchEntries(String, IDictionary)

Declaration

public override IDictionary SearchEntries(string query, IDictionary values)

Parameters

Returns

Overrides

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")

Hashtable values = new Hashtable();
values.add("Name", "Paul Jones");
"select Test.Application.Employee where this.Name = ?"

values.add("Salary", 2000);
"select Test.Application.Employee where this.Salary > ?"

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

values.Add("Name", "Paul Jones");
values.Add("Salary", 2000);
"select Test.Application.Employee where Not(this.Name = 'Paul Jones' and this.Salary > 2000)"

SearchEntriesCQ(ContinuousQuery)

Declaration

public override IDictionary SearchEntriesCQ(ContinuousQuery query)

Parameters

Returns

Overrides

SetAttributes(String, CacheItemAttributes)

Declaration

public override bool SetAttributes(string key, CacheItemAttributes attributes)

Parameters

Returns

Overrides

ToString()

Declaration

public override string ToString()

Returns

Overrides

Unlock(String)

Declaration

public override void Unlock(string key)

Parameters

Overrides

Examples

Following example demonstrates how to unlock a cached item.

...
theCache.Unlock("cachedItemKey");
...

Unlock(String, LockHandle)

Declaration

public override void Unlock(string key, LockHandle lockHandle)

Parameters

Overrides

Examples

Following example demonstrates how to unlock a cached item.

...
theCache.Unlock("cachedItemKey", lockHandle);
...

UnRegisterCacheNotification(CacheEventDescriptor)

Declaration

public override void UnRegisterCacheNotification(CacheEventDescriptor discriptor)

Parameters

Overrides

Examples

Let us consider you registered an event against a cache

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

Now, Unregister this event by using the CacheEventDescriptor returned by regitering the event

cache.UnRegisterCacheNotification(eDescriptor);

UnRegisterCacheNotification(String, CacheDataNotificationCallback, EventType)

Declaration

public override void UnRegisterCacheNotification(string key, CacheDataNotificationCallback callback, EventType eventType)

Parameters

Overrides

Examples

Let us consider you registered an event against a key

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

Now, Unregister this event by providing the key, callback and eventtype

cache.UnRegisterCacheNotification(key, new CacheDataNotificationCallback(ItemCallback), EventType.ItemAdded);

UnRegisterCacheNotification(String[], CacheDataNotificationCallback, EventType)

Declaration

public override void UnRegisterCacheNotification(string[] key, CacheDataNotificationCallback callback, EventType eventType)

Parameters

Overrides

Examples

Let us consider you registered an event against a bulk of keys

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

Now, Unregister this event by providing the key, callback and eventtype

cache.UnRegisterCacheNotification(keys, new CacheDataNotificationCallback(ItemCallback), EventType.ItemAdded);

UnRegisterCQ(ContinuousQuery)

Declaration

public override void UnRegisterCQ(ContinuousQuery query)

Parameters

Overrides

UnRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback)

Declaration

public override void UnRegisterKeyNotificationCallback(string key, CacheItemUpdatedCallback updateCallback, CacheItemRemovedCallback removeCallback)

Parameters

Overrides

UnRegisterKeyNotificationCallback(String[], CacheItemUpdatedCallback, CacheItemRemovedCallback)

Declaration

public override void UnRegisterKeyNotificationCallback(string[] keys, CacheItemUpdatedCallback updateCallback, CacheItemRemovedCallback removeCallback)

Parameters

Overrides

Events

CacheCleared

Declaration

public override event CacheClearedCallback CacheCleared

Event Type

Overrides

Remarks

CacheClientConnectivityChanged

Declaration

public override event CacheClientConnectivityChangedCallback CacheClientConnectivityChanged

Event Type

Overrides

CacheStopped

Declaration

public override event CacheStoppedCallback CacheStopped

Event Type

Overrides

Remarks

CustomEvent

Declaration

public override event CustomEventCallback CustomEvent

Event Type

Overrides

Remarks

ItemAdded

Declaration

public override event CacheItemAddedCallback ItemAdded

Event Type

Overrides

Remarks

ItemRemoved

Declaration

public override event CacheItemRemovedCallback ItemRemoved

Event Type

Overrides

Remarks

ItemUpdated

Declaration

public override event CacheItemUpdatedCallback ItemUpdated

Event Type

Overrides

Remarks

MemberJoined

Declaration

public override event MemberJoinedCallback MemberJoined

Event Type

Overrides

Remarks

MemberLeft

Declaration

public override event MemberLeftCallback MemberLeft

Event Type

Overrides

Remarks