The ClientCache type exposes the following members.

Methods

  NameDescription
Public methodAdd(String, CacheItem)
Add a CacheItem to the cache
(Inherited from Cache.)
Public methodAdd(String, Object)
Adds an item into the Cache object with a cache key to reference its location and using default values provided by the CacheItemPriority enumeration.
(Inherited from Cache.)
Public methodAdd(String, Object, NamedTagsDictionary)
Adds an item into the Cache object with a cache key to reference its location and using default values provided by the CacheItemPriority enumeration. It also enables associating named tags with the object.
(Inherited from Cache.)
Public methodAdd(String, Object, array<Tag>[]()[][])
Adds an item into the Cache object with a cache key to reference its location and using default values provided by the CacheItemPriority enumeration. It also enables the associating tags with the object.
(Inherited from Cache.)
Public methodAdd(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback)
Add a CacheItem to the cache
(Inherited from Cache.)
Public methodAdd(String, Object, String, String)
Adds a value to the cache
(Inherited from Cache.)
Public methodAdd(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback)
Add a CacheItem to the cache.
(Inherited from Cache.)
Public methodAdd(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority) (Inherited from Cache.)
Public methodAddAsync(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback)
Add a CacheItem to the cache asynchronously
(Inherited from Cache.)
Public methodAddAsync(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback) (Inherited from Cache.)
Public methodAddAsync(String, Object, AsyncItemAddedCallback, String, String)
Add the object to the cache asynchronously.
(Inherited from Cache.)
Protected methodAddAsyncOperation
This function tries to do an Add asynchronously in remote cache, if successful the operation is then done to client cache
(Overrides Cache..::..AddAsyncOperation(String, Object, CacheDependency, CacheSyncDependency, DateTime, TimeSpan, CacheItemPriority, DSWriteOption, CacheItemRemovedCallback, CacheItemUpdatedCallback, AsyncItemAddedCallback, DataSourceItemsAddedCallback, Boolean, String, String, array<Tag>[]()[][], String, String, NamedTagsDictionary, CacheDataNotificationCallback, CacheDataNotificationCallback, EventDataFilter, EventDataFilter).)
Public methodAddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsAddedCallback)
Add array of CacheItem to the cache.
(Overrides Cache..::..AddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsAddedCallback).)
Public methodAddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsAddedCallback) (Overrides Cache..::..AddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsAddedCallback).)
Public methodAddDependency(String, CacheSyncDependency)
Add CacheSyncDependency to the cache item.
(Overrides Cache..::..AddDependency(String, CacheSyncDependency).)
Public methodAddDependency(String, CacheDependency, Boolean)
Add dependency to the cache item.
(Overrides Cache..::..AddDependency(String, CacheDependency, Boolean).)
Public methodClear()()()()
Removes all elements from the Cache.
(Inherited from Cache.)
Public methodClear(DSWriteOption, DataSourceClearedCallback)
Removes all elements from the Cache.
(Overrides Cache..::..Clear(DSWriteOption, DataSourceClearedCallback).)
Public methodClearAsync(AsyncCacheClearedCallback)
Removes all elements from the Cache asynchronously.
(Overrides Cache..::..ClearAsync(AsyncCacheClearedCallback).)
Public methodClearAsync(DSWriteOption, AsyncCacheClearedCallback, DataSourceClearedCallback) Obsolete. (Inherited from Cache.)
Public methodClearClientCache (Overrides Cache..::..ClearClientCache()()()().)
Public methodClearClientCacheAsync
Removes all elements from the client cache asynchronously.
(Overrides Cache..::..ClearClientCacheAsync(AsyncCacheClearedCallback).)
Public methodContains
Determines whether the cache contains a specific key.
(Overrides Cache..::..Contains(String).)
Public methodDelete(String)
Removes the object from the Cache.
(Inherited from Cache.)
Public methodDelete(String, CacheItemVersion) (Overrides Cache..::..Delete(String, CacheItemVersion).)
Public methodDelete(String, LockHandle) (Overrides Cache..::..Delete(String, LockHandle).)
Public methodDelete(String, DSWriteOption, DataSourceItemsRemovedCallback)
Removes the object from the Cache.
(Overrides Cache..::..Delete(String, DSWriteOption, DataSourceItemsRemovedCallback).)
Public methodDelete(String, DSWriteOption, String, DataSourceItemsRemovedCallback) (Overrides Cache..::..Delete(String, DSWriteOption, String, DataSourceItemsRemovedCallback).)
Public methodDeleteBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
(Overrides Cache..::..DeleteBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback).)
Public methodDeleteBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
(Overrides Cache..::..DeleteBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback).)
Public methodDispose
Decerements the reference count of the cache and performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Overrides Cache..::..Dispose()()()().)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecuteNonQuery
Executes delete statements on Cache.
(Overrides Cache..::..ExecuteNonQuery(String, IDictionary).)
Public methodExecuteReader
Performs search on the Cache based on the query specified where query contains 'group by' clause.
(Overrides Cache..::..ExecuteReader(String, IDictionary).)
Protected methodFinalize
Finalizer for this object.
(Inherited from Cache.)
Public methodGet(String)
Retrieves the specified item from the Cache object.
(Inherited from Cache.)
Public methodGet(String, CacheItemVersion%)
Retrieves the specified item from the Cache object. It accepts the CacheItemVersion by reference. If null is passed for CacheItemVersion, then the version of the object from the cache is returned. If non-null CacheItemVersion is passed, then object is returned from the cache only if that is the current version of the object in the cache.
(Inherited from Cache.)
Public methodGet(String, DSReadOption)
Retrieves the specified item from the Cache object.
(Overrides Cache..::..Get(String, DSReadOption).)
Public methodGet(String, String, DSReadOption)
Retrieves the specified item from the Cache object.
(Inherited from Cache.)
Public methodGet(String, DSReadOption, CacheItemVersion%)
Retrieves the specified item from the Cache object. If the object is read thru the data source, put is against the given group and sub group.
(Overrides Cache..::..Get(String, DSReadOption, CacheItemVersion%).)
Public methodGet(String, String, DSReadOption, CacheItemVersion%)
Retrieves the specified item from the Cache object. If the object is read through the data source, put it in the cache. It accepts the CacheItemVersion by reference. If null is passed for CacheItemVersion, then the version of the object from the cache is returned. If non-null CacheItemVersion is passed, then object is returned from the cache only if that is the current version of the object in the cache.
(Inherited from Cache.)
Public methodGet(String, String, String, DSReadOption)
Retrieves the specified item from the Cache object. If the object is read thru the data source, put is against the given group and sub group.
(Overrides Cache..::..Get(String, String, String, DSReadOption).)
Public methodGet(String, TimeSpan, LockHandle%, Boolean)
Retrieves the specified item from the Cache object and also locks the object if required.
(Overrides Cache..::..Get(String, TimeSpan, LockHandle%, Boolean).)
Public methodGetBulk(array<String>[]()[][], DSReadOption)
Retrieves the object from the cache for the given keys as key value pairs
(Overrides Cache..::..GetBulk(array<String>[]()[][], DSReadOption).)
Public methodGetBulk(array<String>[]()[][], String, DSReadOption)
Retrieves the object from the cache for the given keys as key value pairs
(Overrides Cache..::..GetBulk(array<String>[]()[][], String, DSReadOption).)
Public methodGetByAllTags
Returns the cached objects that have all the same tags in common. (Returns the Intersection set.)
(Overrides Cache..::..GetByAllTags(array<Tag>[]()[][]).)
Public methodGetByAnyTag
Returns the cached objects that have any of the same tags in common. (Returns the Union set.)
(Overrides Cache..::..GetByAnyTag(array<Tag>[]()[][]).)
Public methodGetByTag
Gets all the cached objects with the specified tag.
(Overrides Cache..::..GetByTag(Tag).)
Public methodGetCacheItem(String)
Get the cache item stored in cache.
(Overrides Cache..::..GetCacheItem(String).)
Public methodGetCacheItem(String, CacheItemVersion%)
Retrieves the specified item from the Cache object. It accepts the CacheItemVersion by reference. If null is passed for CacheItemVersion, then the version of the object from the cache is returned. If non-null CacheItemVersion is passed, then object is returned from the cache only if that is the current version of the object in the cache.
(Inherited from Cache.)
Public methodGetCacheItem(String, DSReadOption)
Retrieves the specified item from the Cache object.
(Inherited from Cache.)
Public methodGetCacheItem(String, DSReadOption, CacheItemVersion%)
Retrieves the specified item from the Cache object. If the object is read through the data source, put it in the cache. It accepts the CacheItemVersion by reference. If null is passed for CacheItemVersion, then the version of the object from the cache is returned. If non-null CacheItemVersion is passed, then object is returned from the cache only if that is the current version of the object in the cache.
(Inherited from Cache.)
Public methodGetCacheItem(String, String, DSReadOption)
Retrieves the specified item from the Cache object.
(Inherited from Cache.)
Public methodGetCacheItem(String, String, String)
Get the cache item stored in cache.
(Overrides Cache..::..GetCacheItem(String, String, String).)
Public methodGetCacheItem(String, String, DSReadOption, CacheItemVersion%)
Retrieves the specified item from the Cache object. If the object is read through the data source, put it in the cache. It accepts the CacheItemVersion by reference. If null is passed for CacheItemVersion, then the version of the object from the cache is returned. If non-null CacheItemVersion is passed, then object is returned from the cache only if that is the current version of the object in the cache.
(Inherited from Cache.)
Public methodGetCacheItem(String, String, String, DSReadOption)
Retrieves the specified item from the Cache object. If the object is read through the data source, put it against the given group and sub group.
(Inherited from Cache.)
Public methodGetCacheItem(String, TimeSpan, LockHandle%, Boolean)
Get the cache item stored in cache.
(Overrides Cache..::..GetCacheItem(String, TimeSpan, LockHandle%, Boolean).)
Public methodGetCacheStream(String, StreamMode)
Gets an instance of the CacheStream class.
(Inherited from Cache.)
Public methodGetCacheStream(String, StreamMode, CacheItemPriority)
Gets an instance of the CacheStream class.
(Inherited from Cache.)
Public methodGetCacheStream(String, StreamMode, DateTime, TimeSpan, CacheItemPriority)
Gets an instance of the CacheStream class.
(Inherited from Cache.)
Public methodGetCacheStream(String, String, String, StreamMode, CacheItemPriority)
Gets an instance of the CacheStream class.
(Inherited from Cache.)
Public methodGetCacheStream(String, String, String, StreamMode, DateTime, TimeSpan, CacheItemPriority)
Gets an instance of the CacheStream class.
(Inherited from Cache.)
Public methodGetCacheStream(String, String, String, StreamMode, CacheDependency, DateTime, TimeSpan, CacheItemPriority)
Gets an instance of the CacheStream class.
(Overrides Cache..::..GetCacheStream(String, String, String, StreamMode, CacheDependency, DateTime, TimeSpan, CacheItemPriority).)
Public methodGetEnumerator
Retrieves a dictionary enumerator used to iterate through the key settings and their values contained in the cache.
(Overrides Cache..::..GetEnumerator()()()().)
Public methodGetGroupData
Retrieves the key and value pairs in a group or sub group.
(Overrides Cache..::..GetGroupData(String, String).)
Public methodGetGroupKeys
Retrieves the keys of items in a group or sub group.
(Overrides Cache..::..GetGroupKeys(String, String).)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIfNewer(String, CacheItemVersion%)
Gets an object from the cache only if a newer version of the object exists in cache.
(Inherited from Cache.)
Public methodGetIfNewer(String, String, String, CacheItemVersion%)
Gets an object from the cache only if a newer version of the object exists in cache.
(Overrides Cache..::..GetIfNewer(String, String, String, CacheItemVersion%).)
Public methodGetKeysByAllTags
Returns keys that have all the same tags in common. (Returns the Intersection set.)
(Overrides Cache..::..GetKeysByAllTags(array<Tag>[]()[][]).)
Public methodGetKeysByAnyTag
Returns keys that have any of the same tags in common. (Returns the Union set.)
(Overrides Cache..::..GetKeysByAnyTag(array<Tag>[]()[][]).)
Public methodGetKeysByTag (Overrides Cache..::..GetKeysByTag(Tag).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsert(String, CacheItem)
Add a CacheItem to the cache
(Inherited from Cache.)
Public methodInsert(String, Object)
Inserts an item into the Cache object with a cache key to reference its location and using default values provided by the CacheItemPriority enumeration.
(Inherited from Cache.)
Public methodInsert(String, Object, NamedTagsDictionary)
Inserts an item into the Cache with a cache key to reference its location and using default values provided by the CacheItemPriority enumeration. It also enables associating named tags with the object.
(Inherited from Cache.)
Public methodInsert(String, Object, array<Tag>[]()[][])
Inserts an item into the Cache with a cache key to reference its location and using default values provided by the CacheItemPriority enumeration. It also enables the associating tags with the object.
(Inherited from Cache.)
Public methodInsert(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback)
Add a CacheItem to the cache
(Inherited from Cache.)
Public methodInsert(String, CacheItem, LockHandle, Boolean)
Inserts a CacheItem to the cache if not already existing. Otherwise updates an existing item if it not already locked or if the correct lock-id is specified.
(Inherited from Cache.)
Public methodInsert(String, Object, String, String)
Insert a value to the cache
(Inherited from Cache.)
Public methodInsert(String, CacheItem, DSWriteOption, String, DataSourceItemsUpdatedCallback) (Inherited from Cache.)
Public methodInsert(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority)
Inserts an object into the Cache with dependencies, expiration and priority policies.
(Inherited from Cache.)
Public methodInsertAsync(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback)
Insert a CacheItem to the cache asynchoronously
(Inherited from Cache.)
Public methodInsertAsync(String, CacheItem, String, DSWriteOption, DataSourceItemsUpdatedCallback)
Insert a CacheItem to the cache asynchoronously
(Inherited from Cache.)
Public methodInsertAsync(String, Object, AsyncItemUpdatedCallback, String, String)
Inserts an object into the Cache asynchronously with dependencies, expiration and priority policies, and a delegate you can use to notify your application when the inserted item is removed from the Cache.
(Inherited from Cache.)
Protected methodInsertAsyncOperation
This function tries to do an Insert asynchronously in remote cache, if successful the operation is then done to client cache
(Overrides Cache..::..InsertAsyncOperation(String, Object, CacheDependency, CacheSyncDependency, DateTime, TimeSpan, CacheItemPriority, DSWriteOption, CacheItemRemovedCallback, CacheItemUpdatedCallback, AsyncItemUpdatedCallback, DataSourceItemsUpdatedCallback, Boolean, String, String, array<Tag>[]()[][], String, NamedTagsDictionary, CacheDataNotificationCallback, CacheDataNotificationCallback, EventDataFilter, EventDataFilter).)
Public methodInsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsUpdatedCallback)
Insert list of CacheItem to the cache
(Overrides Cache..::..InsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsUpdatedCallback).)
Public methodInsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsUpdatedCallback)
Insert list of CacheItem to the cache
(Overrides Cache..::..InsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsUpdatedCallback).)
Public methodLock
Acquire a lock on an item in cache.
(Overrides Cache..::..Lock(String, TimeSpan, LockHandle%).)
Public methodLog (Inherited from Cache.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRaiseCustomEvent
Broadcasts a custom application defined event.
(Overrides Cache..::..RaiseCustomEvent(Object, Object).)
Public methodRegisterCacheNotification(CacheDataNotificationCallback, EventType, EventDataFilter)
Registers ItemAdded, ItemUpdate or ItemRemoved events with cache
(Overrides Cache..::..RegisterCacheNotification(CacheDataNotificationCallback, EventType, EventDataFilter).)
Public methodRegisterCacheNotification(String, CacheDataNotificationCallback, EventType, EventDataFilter)
Registers the ItemUpdate or ItemRemoved events for the specified key.
(Overrides Cache..::..RegisterCacheNotification(String, CacheDataNotificationCallback, EventType, EventDataFilter).)
Public methodRegisterCacheNotification(array<String>[]()[][], CacheDataNotificationCallback, EventType, EventDataFilter)
Registers the ItemUpdate or ItemRemoved events for the specified keys.
(Overrides Cache..::..RegisterCacheNotification(array<String>[]()[][], CacheDataNotificationCallback, EventType, EventDataFilter).)
Public methodRegisterCQ (Overrides Cache..::..RegisterCQ(ContinuousQuery).)
Public methodRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback)
Registers the CacheItemUpdatedCallback and/or CacheItemRemovedCallback for the specified key.
(Overrides Cache..::..RegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback).)
Public methodRegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback)
Registers the CacheItemUpdatedCallback and/or CacheItemRemovedCallback for the list of specified keys.
(Overrides Cache..::..RegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback).)
Public methodRemove(String)
Removes the object from the Cache.
(Inherited from Cache.)
Public methodRemove(String, CacheItemVersion) (Overrides Cache..::..Remove(String, CacheItemVersion).)
Public methodRemove(String, LockHandle) (Overrides Cache..::..Remove(String, LockHandle).)
Public methodRemove(String, DSWriteOption, DataSourceItemsRemovedCallback)
Removes the object from the Cache.
(Overrides Cache..::..Remove(String, DSWriteOption, DataSourceItemsRemovedCallback).)
Public methodRemove(String, DSWriteOption, String, DataSourceItemsRemovedCallback) (Overrides Cache..::..Remove(String, DSWriteOption, String, DataSourceItemsRemovedCallback).)
Public methodRemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, DataSourceItemsRemovedCallback) (Inherited from Cache.)
Public methodRemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the object from the Cache asynchronously.
(Overrides Cache..::..RemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, String, DataSourceItemsRemovedCallback).)
Public methodRemoveBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
(Overrides Cache..::..RemoveBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback).)
Public methodRemoveBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
(Overrides Cache..::..RemoveBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback).)
Public methodRemoveByAllTags
Removes the cached objects that have all the same tags in common. (Returns the Union set.)
(Overrides Cache..::..RemoveByAllTags(array<Tag>[]()[][]).)
Public methodRemoveByAnyTag
Removes the cached objects that have any of the same tags in common. (Returns the Union set.)
(Overrides Cache..::..RemoveByAnyTag(array<Tag>[]()[][]).)
Public methodRemoveByTag
Removes the cached objects with the specified tag.
(Overrides Cache..::..RemoveByTag(Tag).)
Public methodRemoveGroupData
Remove the group from cache.
(Overrides Cache..::..RemoveGroupData(String, String).)
Public methodSearch
Performs search on the Cache based on the query specified.
(Overrides Cache..::..Search(String, IDictionary).)
Public methodSearchCQ (Overrides Cache..::..SearchCQ(ContinuousQuery).)
Public methodSearchEntries
Performs search on the Cache based on the query specified.
(Overrides Cache..::..SearchEntries(String, IDictionary).)
Public methodSearchEntriesCQ (Overrides Cache..::..SearchEntriesCQ(ContinuousQuery).)
Public methodSetAttributes
Add Attribute existing cache item.
(Overrides Cache..::..SetAttributes(String, CacheItemAttributes).)
Public methodToString
Returns System.String that represents the current ClientCache object
(Overrides Cache..::..ToString()()()().)
Public methodUnlock(String)
Forcefully unlocks a locked cached item.
(Overrides Cache..::..Unlock(String).)
Public methodUnlock(String, LockHandle)
Unlocks a locked cached item if the correct lock-id is specified.
(Overrides Cache..::..Unlock(String, LockHandle).)
Public methodUnRegisterCacheNotification(CacheEventDescriptor)
Unregisters a cache level event that may have been registered
(Overrides Cache..::..UnRegisterCacheNotification(CacheEventDescriptor).)
Public methodUnRegisterCacheNotification(String, CacheDataNotificationCallback, EventType)
Unregisters event that may have been registered against a specific key
(Overrides Cache..::..UnRegisterCacheNotification(String, CacheDataNotificationCallback, EventType).)
Public methodUnRegisterCacheNotification(array<String>[]()[][], CacheDataNotificationCallback, EventType)
Unregisters any event that may have been registered by the user against multiple cache keys
(Overrides Cache..::..UnRegisterCacheNotification(array<String>[]()[][], CacheDataNotificationCallback, EventType).)
Public methodUnRegisterCQ (Overrides Cache..::..UnRegisterCQ(ContinuousQuery).)
Public methodUnRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback)
Unregisters the CacheItemUpdatedCallback and/or CacheItemRemovedCallback already registered for the specified key.
(Overrides Cache..::..UnRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback).)
Public methodUnRegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback) (Overrides Cache..::..UnRegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback).)

See Also