DataCacheLocalCacheSyncPolicy Enumeration
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Specifies the way locally cached objects should be invalidated.
Namespace: Microsoft.Data.Caching
Assembly: ClientLibrary (in clientlibrary.dll)
Syntax
'Declaration
Public Enumeration DataCacheLocalCacheSyncPolicy
'Usage
Dim instance As DataCacheLocalCacheSyncPolicy
public enum DataCacheLocalCacheSyncPolicy
public enum class DataCacheLocalCacheSyncPolicy
public enum DataCacheLocalCacheSyncPolicy
public enum DataCacheLocalCacheSyncPolicy
Members
| Member name | Description | |
|---|---|---|
| NotificationBased | Specifies that objects will stay in local cache until they are automatically invalidated by a cache notification. | |
| TimeoutBased | Specifies that objects will stay in local cache until their lifetime reaches the localCacheTimeout duration specified in the DataCacheCacheFactory constructor. |
Remarks
When using the TimeoutBased enumeration to specify local cache sync policy, once objects are downloaded to local cache, they will stay there until they reach the object timeout value specified in the DataCacheCacheFactory constructor's localCacheTimeout parameter. When the objects reach the time-out value, they are invalidated so that each object can be refreshed from the cache cluster the next time that it is requested.
When using the NotificationBased enumeration, locally cached objects will be automatically invalidated by cache notifications. The object lifetime can only be as short as the notification polling interval specified by the DataCacheCacheFactory constructor's pollInterval parameter.
For more information, see Expiration and Eviction (Velocity) and Cache Notifications (Velocity).
Note
In order for your application to use notifications you need to enable them on a named cache. Use the notificationsEnabled parameter with the New-Cache or Set-CacheConfig commands. For more information, see Cache Administration with PowerShell (Velocity).