The DataCache class is used by the WSAF Caching Compatibility Library for storing and retrieving objects from a ScaleOut StateServer
in-memory data grid. To simplify migration of AppFabric centric applications to ScaleOut StateServer, methods and properties
on this class are the same as those defined by the Microsoft.ApplicationServer.Caching.DataCache class.
Inheritance Hierarchy
Soss.Compat.WSAFDataCache
Namespace: Soss.Compat.WSAF
Assembly: soss_wsaf_compat (in soss_wsaf_compat.dll) Version: 1.1.0.100 (1.1.0.100)
Syntax
The DataCache type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Add(String, Object) |
Inserts an object into the cache.
|
| Add(String, Object, IEnumerableDataCacheTag) |
Inserts an object to the cache with a specified list of tags.
|
| Add(String, Object, String) |
Inserts an object to a region in the cache.
|
| Add(String, Object, TimeSpan) |
Inserts an object to the cache with a specified object timeout.
|
| Add(String, Object, IEnumerableDataCacheTag, String) |
Inserts an object to a region in the cache with a specified list of tags.
|
| Add(String, Object, TimeSpan, IEnumerableDataCacheTag) |
Inserts an object to the cache with a specified list of tags.
|
| Add(String, Object, TimeSpan, String) |
Inserts an object to a region in the cache with a specified object timeout.
|
| Add(String, Object, TimeSpan, IEnumerableDataCacheTag, String) |
Inserts an object to a region in the cache with a specified list of tags and expiration timeout.
|
| AddCacheLevelBulkCallback | Obsolete.
This method is not supported by this implementation.
|
| AddCacheLevelCallback |
Adds a cache notification callback for cache operations occurring on all regions and items.
|
| AddFailureNotificationCallback |
Adds a failure notification that is used to notify a client that it has missed one or more cache notifications.
|
| AddItemLevelCallback(String, DataCacheOperations, DataCacheNotificationCallback) |
Adds a cache notification callback for cache operations occurring on one specific item that is not stored in a region.
|
| AddItemLevelCallback(String, DataCacheOperations, DataCacheNotificationCallback, String) |
Adds a cache notification callback for cache operations occurring on the object
with specified key that is stored in a given region.
|
| AddRegionLevelCallback |
Adds a cache notification callback for cache operations occurring on a specific region.
|
| BulkGet(IEnumerableString) |
Gets all of the objects associated with the specified keys across all system regions.
This method does not search user-defined regions.
|
| BulkGet(IEnumerableString, String) |
Gets objects for the specified keys from the specified region of the cache.
|
| Clear |
Clears the cache.
|
| ClearRegion |
Deletes all objects in the specified region.
|
| CreateRegion |
Creates a region.
|
| Equals | (Inherited from Object.) |
| Get(String) |
Gets an object from the cache using the specified key.
|
| Get(String, DataCacheItemVersion) |
Gets an object from the cache using the specified key and returns its current version.
|
| Get(String, String) |
Gets an object from the specified region using object's key.
|
| Get(String, DataCacheItemVersion, String) |
Gets an object from the specified region using object's key and returns its current version.
|
| GetAndLock(String, DataCacheLockHandle) |
Locks the cached object to prevent other clients from updating or removing it and returns the object corresponding to the key.
|
| GetAndLock(String, TimeSpan, DataCacheLockHandle, Boolean) | Obsolete.
Locks the cached object to prevent other clients from updating or removing it and returns the object corresponding to the key.
|
| GetAndLock(String, TimeSpan, DataCacheLockHandle, String) | Obsolete.
Locks the cached object to prevent other clients from updating or removing it and returns the object corresponding to the key.
|
| GetAndLock(String, TimeSpan, DataCacheLockHandle, String, Boolean) | Obsolete.
Locks the cached object to prevent other clients from updating or removing it and returns the object corresponding to the key.
|
| GetCacheItem(String) |
Retrieves all information associated with the cached object in the ScaleOut data grid.
|
| GetCacheItem(String, String) |
Retrieves all information associated with the cached object in the ScaleOut data grid.
This version retrieves objects stored in regions.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetIfNewer(String, DataCacheItemVersion) |
Retrieves an object from the cache, but only if a newer version of the object resides in the cache.
|
| GetIfNewer(String, DataCacheItemVersion, String) |
Retrieves an object from the specified region, but only if a newer version of the object resides in this region.
|
| GetObjectsByAllTags |
Gets list of all objects in the region that have all specified tags in common.
|
| GetObjectsByAnyTag |
Gets list of all objects in the region that have at least one of the specified tags.
|
| GetObjectsByTag |
Retrieves a list of all cached objects in the region that match the specified tag.
|
| GetObjectsInRegion |
Gets a list of all objects stored in the specified region.
|
| GetSystemRegionName |
Returns the system region name for the specified key. ScaleOut StateServer does have
a notion of a system region, so this method returns the name of pseudo system region
as "Default_Region_{CacheName}", where {CacheName} represents the cache name associated
with the current DataCache instance.
|
| GetSystemRegions |
Gets the list of internal system regions.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Put(String, Object) |
Adds or replaces an object in the cache.
|
| Put(String, Object, DataCacheItemVersion) |
Replaces an object in the cache if the specified object version matches
the version of object stored in the cache.
|
| Put(String, Object, IEnumerableDataCacheTag) |
Adds or replaces an object in the cache with a new value and the specified collection of tags.
|
| Put(String, Object, String) |
Adds or replaces an object in the specified region.
|
| Put(String, Object, TimeSpan) |
Adds or replaces an object in the cache with a specified object timeout.
|
| Put(String, Object, DataCacheItemVersion, IEnumerableDataCacheTag) |
Replaces an object in the cache if the provided object version matches
the version of object stored in the specified region.
|
| Put(String, Object, DataCacheItemVersion, String) |
Replaces an object in the specified region if the provided object version matches
the version of object stored in the cache.
|
| Put(String, Object, DataCacheItemVersion, TimeSpan) |
Replaces an object in the cache if the specified object version matches
the version of object stored in the cache.
|
| Put(String, Object, IEnumerableDataCacheTag, String) |
Adds or replaces an object in the region with a new value and the specified collection of tags.
|
| Put(String, Object, TimeSpan, IEnumerableDataCacheTag) |
Adds or replaces an object in the cache with a specified object timeout.
|
| Put(String, Object, TimeSpan, String) |
Adds or replaces an object in the region with a specified object timeout.
|
| Put(String, Object, DataCacheItemVersion, IEnumerableDataCacheTag, String) |
Replaces an object in the specified region if the provided object version matches
the version of object stored in the region.
|
| Put(String, Object, DataCacheItemVersion, TimeSpan, IEnumerableDataCacheTag) |
Replaces an object in the cache if the provided object version matches
the version of object stored in the specified region.
|
| Put(String, Object, DataCacheItemVersion, TimeSpan, String) |
Replaces an object in the specified region if the provided object version matches
the version of object stored in the region.
|
| Put(String, Object, TimeSpan, IEnumerableDataCacheTag, String) |
Adds or replaces an object in the region with a specified object timeout.
|
| Put(String, Object, DataCacheItemVersion, TimeSpan, IEnumerableDataCacheTag, String) |
Replaces an object in the specified region if the provided object version matches
the version of object stored in the region.
|
| PutAndUnlock(String, Object, DataCacheLockHandle) |
Replaces and unlocks an object in the cache.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, IEnumerableDataCacheTag) |
Replaces and unlocks an object in the cache.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, String) |
Replaces and unlocks an object in the specified region.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, TimeSpan) |
Replaces and unlocks an object in the cache.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, IEnumerableDataCacheTag, String) |
Replaces and unlocks an object in the specified region.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, TimeSpan, IEnumerableDataCacheTag) |
Replaces and unlocks an object in the cache.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, TimeSpan, String) |
Replaces and unlocks an object in the specified region.
|
| PutAndUnlock(String, Object, DataCacheLockHandle, TimeSpan, IEnumerableDataCacheTag, String) |
Replaces and unlocks an object in the specified region.
|
| Remove(String) |
Removes object from the cache.
|
| Remove(String, DataCacheItemVersion) |
Removes object from the cache.
|
| Remove(String, DataCacheLockHandle) |
Removes object from the cache.
|
| Remove(String, String) |
Removes an object from the cache in a region.
|
| Remove(String, DataCacheItemVersion, String) |
Removes an object with a specific version from the cache in a region.
|
| Remove(String, DataCacheLockHandle, String) |
Removes object from the cache with an associated lock handle in a region.
|
| RemoveCallback |
Removes a cache notification callback.
|
| RemoveRegion |
Deletes a region and removes cached objects inside the region.
|
| ResetObjectTimeout(String, TimeSpan) | Obsolete.
This method is not supported by this implementation.
|
| ResetObjectTimeout(String, TimeSpan, String) | Obsolete.
This method is not supported by this implementation.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unlock(String, DataCacheLockHandle) |
Unlocks the object in the cache.
|
| Unlock(String, DataCacheLockHandle, String) |
Unlocks the object in the cache region.
|
| Unlock(String, DataCacheLockHandle, TimeSpan) |
Unlocks the object in the cache and resets its timeout to a new value specified by timeout.
|
| Unlock(String, DataCacheLockHandle, TimeSpan, String) |
Unlocks the object in the region and resets its timeout to a new value specified by timeout.
|
Properties
| Name | Description | |
|---|---|---|
 | DefaultTTL |
Default timeout for the DataCache class. Default value is MaxValue.
|
| Item |
Gets or sets a cached item using default parameters.
|
| Name |
The cache name.
|
| NotificationsEnabled |
Enables or disables notifications for the current instance of
the DataCache class. Default is false.
|
| PollInterval |
Gets/sets the polling interval (in seconds) that the cache client uses to check for notifications on the cache cluster.
|
See Also