The Cache type exposes the following members.
Methods
Name | Description | |
---|---|---|
Add(String, CacheItem) |
Add a CacheItem to the cache
| |
Add(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.
| |
Add(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.
| |
Add(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.
| |
Add(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback) |
Add a CacheItem to the cache
| |
Add(String, Object, String, String) | Adds a value to the cache | |
Add(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback) |
Add a CacheItem to the cache.
| |
Add(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority) | ||
AddAsync(String, CacheItem, DSWriteOption, DataSourceItemsAddedCallback) |
Add a CacheItem to the cache asynchronously
| |
AddAsync(String, CacheItem, DSWriteOption, String, DataSourceItemsAddedCallback) | ||
AddAsync(String, Object, AsyncItemAddedCallback, String, String) |
Add the object to the cache asynchronously.
| |
AddAsyncOperation |
Function that choose the appropriate function of NCache's Cache, that need to be called
according to the data provided to it. | |
AddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsAddedCallback) |
Add array of CacheItem to the cache.
| |
AddBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsAddedCallback) |
Add array of CacheItem to the cache.
| |
AddBulkOperation |
Add array of CacheItem to the cache.
| |
AddDependency(String, CacheSyncDependency) | Obsolete.
Add CacheSyncDependency to the cache item.
| |
AddDependency(String, CacheDependency, Boolean) |
Add dependency to the cache item.
| |
Clear()()()() |
Removes all elements from the Cache.
| |
Clear(DSWriteOption, DataSourceClearedCallback) |
Removes all elements from the Cache.
| |
ClearAsync |
Removes all elements from the Cache asynchronously.
| |
ClearClientCache |
Removes all elements from the client cache.
| |
ClearClientCacheAsync | ||
Contains |
Determines whether the cache contains a specific key.
| |
Delete(String) |
Removes the object from the Cache.
| |
Delete(String, CacheItemVersion) |
Removes an item from cache if the specified version is still the most recent version in the cache.
| |
Delete(String, LockHandle) |
Removes an item from cache if it is not already locked or if the correct lock-id is specified.
| |
Delete(String, DSWriteOption, DataSourceItemsRemovedCallback) |
Removes the object from the Cache.
| |
Delete(String, DSWriteOption, String, DataSourceItemsRemovedCallback) | ||
DeleteBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback) |
Removes the objects from the Cache.
| |
DeleteBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback) |
Removes the objects from the Cache.
| |
Dispose |
Decerements the reference count of the cache and performs application-defined tasks
associated with freeing, releasing, or resetting unmanaged resources.
| |
Equals | (Inherited from Object.) | |
Finalize |
Finalizer for this object.
(Overrides Object..::..Finalize()()()().) | |
Get(String) |
Retrieves the specified item from the Cache object.
| |
Get(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.
| |
Get(String, DSReadOption) |
Retrieves the specified item from the Cache object.
| |
Get(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.
| |
Get(String, String, DSReadOption) |
Retrieves the specified item from the Cache object.
| |
Get(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.
| |
Get(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.
| |
Get(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.
| |
GetBulk(array<String>[]()[][], DSReadOption) |
Retrieves the object from the cache for the given keys as key value pairs
| |
GetBulk(array<String>[]()[][], String, DSReadOption) |
Retrieves the object from the cache for the given keys as key value pairs
| |
GetByAllTags |
Returns the cached objects that have all the same tags in common. (Returns the Intersection set.)
| |
GetByAnyTag |
Returns the cached objects that have any of the same tags in common. (Returns the Union set.)
| |
GetByTag |
Gets all the cached objects with the specified tag.
| |
GetCacheItem(String) |
Get the cache item stored in cache.
| |
GetCacheItem(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.
| |
GetCacheItem(String, DSReadOption) |
Retrieves the specified item from the Cache object.
| |
GetCacheItem(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.
| |
GetCacheItem(String, String, DSReadOption) |
Retrieves the specified item from the Cache object.
| |
GetCacheItem(String, String, String) | Obsolete.
Get the cache item stored in cache.
| |
GetCacheItem(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.
| |
GetCacheItem(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.
| |
GetCacheItem(String, TimeSpan, LockHandle%, Boolean) |
Get the cache item stored in cache.
| |
GetCacheStream(String, StreamMode) |
Gets an instance of the CacheStream class.
| |
GetCacheStream(String, StreamMode, CacheItemPriority) |
Gets an instance of the CacheStream class.
| |
GetCacheStream(String, StreamMode, DateTime, TimeSpan, CacheItemPriority) |
Gets an instance of the CacheStream class.
| |
GetCacheStream(String, String, String, StreamMode, CacheItemPriority) |
Gets an instance of the CacheStream class.
| |
GetCacheStream(String, String, String, StreamMode, DateTime, TimeSpan, CacheItemPriority) |
Gets an instance of the CacheStream class.
| |
GetCacheStream(String, String, String, StreamMode, CacheDependency, DateTime, TimeSpan, CacheItemPriority) |
Gets an instance of the CacheStream class.
| |
GetEnumerator |
Retrieves a dictionary enumerator used to iterate
through the key settings and their values
contained in the cache.
| |
GetGroupData |
Retrieves the key and value pairs in a group or sub group.
| |
GetGroupKeys |
Retrieves the keys of items in a group or sub group.
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetIfNewer(String, CacheItemVersion%) |
Gets an object from the cache only if a newer version of the object exists in cache.
| |
GetIfNewer(String, String, String, CacheItemVersion%) |
Gets an object from the cache only if a newer version of the object exists in cache.
| |
GetKeysByAllTags |
Returns keys that have all the same tags in common. (Returns the Intersection set.)
| |
GetKeysByAnyTag |
Returns keys that have any of the same tags in common. (Returns the Union set.)
| |
GetKeysByTag |
Gets all the keys with the specified tag.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Insert(String, CacheItem) |
Add a CacheItem to the cache
| |
Insert(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.
| |
Insert(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.
| |
Insert(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.
| |
Insert(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback) |
Add a CacheItem to the cache
| |
Insert(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.
| |
Insert(String, Object, String, String) | Insert a value to the cache | |
Insert(String, CacheItem, DSWriteOption, String, DataSourceItemsUpdatedCallback) | ||
Insert(String, Object, CacheDependency, DateTime, TimeSpan, CacheItemPriority) |
Inserts an object into the Cache with dependencies, expiration and
priority policies.
| |
InsertAsync(String, CacheItem, DSWriteOption, DataSourceItemsUpdatedCallback) |
Insert a CacheItem to the cache asynchoronously
| |
InsertAsync(String, CacheItem, String, DSWriteOption, DataSourceItemsUpdatedCallback) |
Insert a CacheItem to the cache asynchoronously
| |
InsertAsync(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.
| |
InsertAsyncOperation |
Function that choose the appropriate function of NCache's Cache, that need to be called
according to the data provided to it. | |
InsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, DataSourceItemsUpdatedCallback) | Insert list of CacheItem to the cache | |
InsertBulk(array<String>[]()[][], array<CacheItem>[]()[][], DSWriteOption, String, DataSourceItemsUpdatedCallback) | Insert list of CacheItem to the cache | |
InsertBulkOperation | Insert list of CacheItem to the cache | |
Lock |
Acquire a lock on an item in cache.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
RaiseCustomEvent |
Broadcasts a custom application defined event.
| |
RegisterCQ |
Registers the notifications based on the specified ContinuousQuery .
| |
RegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback) |
Registers the CacheItemUpdatedCallback and/or CacheItemRemovedCallback for the specified key.
| |
RegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback) |
Registers the CacheItemUpdatedCallback and/or CacheItemRemovedCallback for the list of specified keys.
| |
Remove(String) |
Removes the object from the Cache.
| |
Remove(String, CacheItemVersion) |
Removes an item from cache if the specified version is still the most recent version in the cache.
| |
Remove(String, LockHandle) |
Removes an item from cache if it is not already locked or if the correct lock-id is specified.
| |
Remove(String, DSWriteOption, DataSourceItemsRemovedCallback) |
Removes the object from the Cache.
| |
Remove(String, DSWriteOption, String, DataSourceItemsRemovedCallback) |
Removes the object from the Cache.
| |
RemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, DataSourceItemsRemovedCallback) |
Removes the object from the Cache asynchronously.
| |
RemoveAsync(String, AsyncItemRemovedCallback, DSWriteOption, String, DataSourceItemsRemovedCallback) |
Removes the object from the Cache asynchronously.
| |
RemoveBulk(array<String>[]()[][], DSWriteOption, DataSourceItemsRemovedCallback) |
Removes the objects from the Cache.
| |
RemoveBulk(array<String>[]()[][], DSWriteOption, String, DataSourceItemsRemovedCallback) |
Removes the objects from the Cache.
| |
RemoveByAllTags |
Removes the cached objects that have any of the same tags in common. (Returns the Union set.)
| |
RemoveByAnyTag |
Removes the cached objects that have any of the same tags in common.
| |
RemoveByTag |
Removes the cached objects with the specified tag.
| |
RemoveGroupData |
Remove the group from cache.
| |
Search |
Performs search on the Cache based on the query specified.
| |
SearchCQ |
Performs search on the Cache based on the specified ContinuousQuery and registers the notifications.
| |
SearchEntries | ||
SearchEntriesCQ |
Performs search on the Cache based on the specified ContinuousQuery and registers the notifications.
| |
SetAttributes |
Add Attribute existing cache item.
| |
ToString |
The string representation of the cache object.
(Overrides Object..::..ToString()()()().) | |
Unlock(String) |
Forcefully unlocks a locked cached item.
| |
Unlock(String, LockHandle) |
Unlocks a locked cached item if the correct lock-id is specified.
| |
UnRegisterCQ |
Unregisters notifications for the specified ContinuousQuery.
| |
UnRegisterKeyNotificationCallback(String, CacheItemUpdatedCallback, CacheItemRemovedCallback) |
Unregisters the CacheItemUpdatedCallback and/or CacheItemRemovedCallback already registered
for the specified key.
| |
UnRegisterKeyNotificationCallback(array<String>[]()[][], CacheItemUpdatedCallback, CacheItemRemovedCallback) |
Unregisters the CacheItemUpdatedCallback and/or CacheItemRemovedCallback already registered
for the specified list of keys.
|
Fields
Name | Description | |
---|---|---|
NoAbsoluteExpiration |
Used in the absoluteExpiration parameter in an Insert method call to
indicate the item should never expire. This field is read-only.
| |
NoLockExpiration |
Used as the lockTimeout parameter in Lock method call
to disable locking expirations. This field is read-only.
| |
NoSlidingExpiration |
Used as the slidingExpiration parameter in an Insert method call
to disable sliding expirations. This field is read-only.
|
Properties
Name | Description | |
---|---|---|
Count |
Gets the number of items stored in the cache.
| |
ExceptionsEnabled |
Flag that indicates whether exceptions are enabled or not.
| |
Item |
Gets or sets the cache item at the specified key.
|
Events
Name | Description | |
---|---|---|
CacheCleared |
Occurs after the Cache is cleared.
| |
CacheStopped |
Occurs after the cache has been stopped.
| |
CustomEvent |
Occurs in response to a RaiseCustomEvent(Object, Object) method call.
| |
ItemAdded |
Occurs after an item has been added to the Cache.
| |
ItemRemoved |
Occurs after an has been removed from the Cache.
| |
ItemUpdated |
Occurs after an item has been updated in the Cache.
| |
MemberJoined |
Occurs after a new node has joined the cluster.
| |
MemberLeft |
Occurs after a node has left the cluster.
|