The Cache type exposes the following members.

Methods

  NameDescription
Public methodAdd(String, CacheItem)
Add a CacheItem to the 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.
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.
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.
Public methodAdd(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback)
Add a CacheItem to the cache
Public methodAdd(String, Object, String, String)
Adds a value to the cache
Public methodAdd(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback)
Add a CacheItem to the cache.
Public methodAdd(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority)
Public methodAddAsync(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback)
Add a CacheItem to the cache asynchronously
Public methodAddAsync(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback)
Public methodAddAsync(String, Object, AsyncItemAddedCallback, String, String)
Add the object to the cache asynchronously.
Protected methodAddAsyncOperation
Function that choose the appropriate function of NCache's Cache, that need to be called according to the data provided to it.
Public methodAddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsAddedCallback)
Add array of CacheItem to the cache.
Public methodAddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsAddedCallback)
Add array of CacheItem to the cache.
Public methodAddDependency(String, CacheSyncDependency) Obsolete.
Add CacheSyncDependency to the cache item.
Public methodAddDependency(String, CacheDependency, Boolean)
Add dependency to the cache item.
Public methodClear()()()()
Removes all elements from the Cache.
Public methodClear(DSWriteOption, DataSourceClearedCallback) Obsolete.
Removes all elements from the Cache.
Public methodClearAsync(AsyncCacheClearedCallback)
Removes all elements from the Cache asynchronously.
Public methodClearAsync(DSWriteOption, AsyncCacheClearedCallback, DataSourceClearedCallback) Obsolete.
Public methodClearClientCache
Removes all elements from the client cache.
Public methodClearClientCacheAsync
Public methodContains
Determines whether the cache contains a specific key.
Public methodDelete(String)
Removes the object from the Cache.
Public methodDelete(String, CacheItemVersion)
Removes an item from cache if the specified version is still the most recent version in the cache.
Public methodDelete(String, LockHandle)
Removes an item from cache if it is not already locked or if the correct lock-id is specified.
Public methodDelete(String, DSWriteOption, DataSourceItemsRemovedCallback)
Removes the object from the Cache.
Public methodDelete(String, DSWriteOption, String, DataSourceItemsRemovedCallback)
Public methodDeleteBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
Public methodDeleteBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
Public methodDispose
Decerements the reference count of the cache and performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecuteNonQuery
Executes delete statements on Cache.
Public methodExecuteReader
Performs search on the Cache based on the query specified where query contains 'group by' clause.
Protected methodFinalize
Finalizer for this object.
(Overrides Object..::..Finalize()()()().)
Public methodGet(String)
Retrieves the specified item from the Cache object.
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.
Public methodGet(String, DSReadOption)
Retrieves the specified item from the Cache object.
Public methodGet(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.
Public methodGet(String, String, DSReadOption)
Retrieves the specified item from the Cache object.
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.
Public methodGet(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.
Public methodGet(String, TimeSpan, LockHandle%, Boolean)
Retrieves the specified item from the Cache object if it is not already locked. Otherwise returns null (Nothing in Visual Basic). This is different from the normal Get operation where an item is returned ignoring the lock altogether.
Public methodGetBulk(array<String>[]()[][], DSReadOption)
Retrieves the object from the cache for the given keys as key value pairs
Public methodGetBulk(array<String>[]()[][], String, DSReadOption)
Retrieves the object from the cache for the given keys as key value pairs
Public methodGetByAllTags
Returns the cached objects that have all the same tags in common. (Returns the Intersection set.)
Public methodGetByAnyTag
Returns the cached objects that have any of the same tags in common. (Returns the Union set.)
Public methodGetByTag
Gets all the cached objects with the specified tag.
Public methodGetCacheItem(String)
Get the cache item stored in cache.
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.
Public methodGetCacheItem(String, DSReadOption)
Retrieves the specified item from the Cache object.
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.
Public methodGetCacheItem(String, String, DSReadOption)
Retrieves the specified item from the Cache object.
Public methodGetCacheItem(String, String, String) Obsolete.
Get the cache item stored in cache.
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.
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.
Public methodGetCacheItem(String, TimeSpan, LockHandle%, Boolean)
Get the cache item stored in cache.
Public methodGetCacheStream(String, StreamMode)
Gets an instance of the CacheStream class.
Public methodGetCacheStream(String, StreamMode, CacheItemPriority)
Gets an instance of the CacheStream class.
Public methodGetCacheStream(String, StreamMode, DateTime, TimeSpan, CacheItemPriority)
Gets an instance of the CacheStream class.
Public methodGetCacheStream(String, String, String, StreamMode, CacheItemPriority)
Gets an instance of the CacheStream class.
Public methodGetCacheStream(String, String, String, StreamMode, DateTime, TimeSpan, CacheItemPriority)
Gets an instance of the CacheStream class.
Public methodGetCacheStream(String, String, String, StreamMode, CacheDependency, DateTime, TimeSpan, CacheItemPriority)
Gets an instance of the CacheStream class.
Public methodGetEnumerator
Retrieves a dictionary enumerator used to iterate through the key settings and their values contained in the cache.
Public methodGetGroupData
Retrieves the key and value pairs in a group or sub group.
Public methodGetGroupKeys
Retrieves the keys of items in a group or sub group.
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.
Public methodGetIfNewer(String, String, String, CacheItemVersion%)
Gets an object from the cache only if a newer version of the object exists in cache.
Public methodGetKeysByAllTags
Returns keys that have all the same tags in common. (Returns the Intersection set.)
Public methodGetKeysByAnyTag
Returns keys that have any of the same tags in common. (Returns the Union set.)
Public methodGetKeysByTag
Gets all the keys with the specified tag.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsert(String, CacheItem)
Add a CacheItem to the 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.
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.
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.
Public methodInsert(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback)
Add a CacheItem to the 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.
Public methodInsert(String, Object, String, String)
Insert a value to the cache
Public methodInsert(String, CacheItem, DSWriteOption, String, DataSourceItemsUpdatedCallback)
Public methodInsert(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority)
Inserts an object into the Cache with dependencies, expiration and priority policies.
Public methodInsertAsync(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback)
Insert a CacheItem to the cache asynchoronously
Public methodInsertAsync(String, CacheItem, String, DSWriteOption, DataSourceItemsUpdatedCallback)
Insert a CacheItem to the cache asynchoronously
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.
Protected methodInsertAsyncOperation
Function that choose the appropriate function of NCache's Cache, that need to be called according to the data provided to it.
Public methodInsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsUpdatedCallback)
Insert list of CacheItem to the cache
Public methodInsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsUpdatedCallback)
Insert list of CacheItem to the cache
Public methodLock
Acquire a lock on an item in cache.
Public methodLog
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRaiseCustomEvent
Broadcasts a custom application defined event.
Public methodRegisterCacheNotification(CacheDataNotificationCallback, EventType, EventDataFilter)
Registers ItemAdded, ItemUpdate or ItemRemoved events with cache
Public methodRegisterCacheNotification(String, CacheDataNotificationCallback, EventType, EventDataFilter)
Registers the ItemUpdate or ItemRemoved events for the specified key.
Public methodRegisterCacheNotification(array<String>[]()[][], CacheDataNotificationCallback, EventType, EventDataFilter)
Registers the ItemUpdate or ItemRemoved events for the specified keys.
Public methodRegisterCQ
Registers the notifications based on the specified ContinuousQuery .
Public methodRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback) Obsolete.
Registers the CacheItemUpdatedCallback and/or CacheItemRemovedCallback for the specified key.
Public methodRegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback) Obsolete.
Registers the CacheItemUpdatedCallback and/or CacheItemRemovedCallback for the list of specified keys.
Public methodRemove(String)
Removes the object from the Cache.
Public methodRemove(String, CacheItemVersion)
Removes an item from cache if the specified version is still the most recent version in the cache.
Public methodRemove(String, LockHandle)
Removes an item from cache if it is not already locked or if the correct lock-id is specified.
Public methodRemove(String, DSWriteOption, DataSourceItemsRemovedCallback)
Removes the object from the Cache.
Public methodRemove(String, DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the object from the Cache.
Public methodRemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, DataSourceItemsRemovedCallback)
Public methodRemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the object from the Cache asynchronously.
Public methodRemoveBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
Public methodRemoveBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback)
Removes the objects from the Cache.
Public methodRemoveByAllTags
Removes the cached objects that have any of the same tags in common. (Returns the Union set.)
Public methodRemoveByAnyTag
Removes the cached objects that have any of the same tags in common.
Public methodRemoveByTag
Removes the cached objects with the specified tag.
Public methodRemoveGroupData
Remove the group from cache.
Public methodSearch
Performs search on the Cache based on the query specified.
Public methodSearchCQ
Performs search on the Cache based on the specified ContinuousQuery and registers the notifications.
Public methodSearchEntries
Public methodSearchEntriesCQ
Performs search on the Cache based on the specified ContinuousQuery and registers the notifications.
Public methodSetAttributes
Add Attribute existing cache item.
Public methodToString
The string representation of the cache object.
(Overrides Object..::..ToString()()()().)
Public methodUnlock(String)
Forcefully unlocks a locked cached item.
Public methodUnlock(String, LockHandle)
Unlocks a locked cached item if the correct lock-id is specified.
Public methodUnRegisterCacheNotification(CacheEventDescriptor)
Unregisters a cache level event that may have been registered
Public methodUnRegisterCacheNotification(String, CacheDataNotificationCallback, EventType)
Unregisters event that may have been registered against a specific key
Public methodUnRegisterCacheNotification(array<String>[]()[][], CacheDataNotificationCallback, EventType)
Unregisters any event that may have been registered by the user against multiple cache keys
Public methodUnRegisterCQ
Unregisters notifications for the specified ContinuousQuery.
Public methodUnRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback)
Unregisters the CacheItemUpdatedCallback and/or CacheItemRemovedCallback already registered for the specified key.
Public methodUnRegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback)
Unregisters the CacheItemUpdatedCallback and/or CacheItemRemovedCallback already registered for the specified list of keys.

See Also