←Select platform
In This Topic ▼

FileCache Class Members

Summary

The following tables list the members exposed by FileCache.

Public Constructors

Name Description
Public Constructor
 FileCache Initializes a new instance of FileCache.

Public Methods

Name Description
Public Method
 AddOrGetExisting<T> Adds a cache entry into the cache, and returns an existing cache entry with a matching key.
Public Method BeginAdd Begins adding a new cache item.
Public Method BeginAddExternalResource Begins adding a new cache item.
Public Method CheckPolicies Checks the policy of all items in the cache and purge any item that has been expired.
Public Method CheckPolicy Checks the policy of an existing cache item or items in a region and purge it if it has expired.
Public Method Contains Checks whether the specified cache entry exists in the cache.
Public Method DeleteItem Deletes the specified item from the cache.
Public Method DeleteRegion Deletes the specified region and all its data.
Public Method EndAdd Ends adding a new cache item and commit the changes.
Public Method EndAddExternalResource<T> Ends adding a new cache item and commit the changes.
Public Method EnumerateKeys Enumerates all the items in a region.
Public Method EnumerateRegions Enumerates all the regions in this cache.
Public Method GetCacheFilePath Path to the physical file holding the data for the specified item.
Public Method GetCacheItem<T> Specified cache entry from the cache.
Public Method GetCacheUrl URI to the physical file holding the data for the specified item.
Public Method GetCount Total number of cache entries in the cache.
Public Method GetEnumerator Creates an enumerator that can be used to iterate through a collection of cache entries.
Public Method GetItemExternalResource Get a URI to the cache item
Public Method GetItemVirtualDirectoryUrl Gets a URI that provides HTTP GET access to data for the specified item.
Public Method GetPolicy Gets the policy stored with the specified cache item.
Public Method GetStatistics Returns a snapshot of the number of items in the specified region.
Public Method GetValues Cache entries that corresponds the specified keys.
Public Method Remove<T> Removes an entry from the cache.
Public Method RemoveItemExternalResource Removes the external resource URI associated with the specified cache item
Public Method SetName Sets the unique name of this file cache object.
Public Method UpdateCacheItem<T> Update an existing item in the cache.
Public Method UpdatePolicy Update the policy of an existing cache item.

Protected Methods

Name Description
Protected Method
 GetRegionName Actual region name.
Protected Method LoadConfigurationValues Load the configuration of this cache object from the specified dictionary.
Protected Method OnCacheItemExpired Overrides OnCacheItemExpired.
Protected Method OnCacheItemExpiring Overrides OnCacheItemExpiring.
Protected Method SaveConfigurationValues Saves the configuration of this cache object to the specified dictionary.

Public Properties

Name Description
Public Property
 AccessTimeout Determines how long to wait between file access errors before an exception is thrown.
Public Property Binder Binder to use when serializing cache items.
Public Property CacheDirectory Location in the file system to use for storing cache items.
Public Property CacheVirtualDirectory Location in a web server to use for storing cache items.
Public Property DataSerializationMode Determines the type of serialization to use when the data is saved into the cache.
Public Property DefaultCacheCapabilities Capabilities of this cache.
Public Property DefaultPolicy Default policy when setting cache values using the properties and methods that do not use a region name.
Public Property DefaultRegion Name of the region to use when calling the properties and methods that do not use a region name.
Public Property Item The cache item.
Public Property Name Unique name of this cache object
Public Property PolicySerializationMode Determines the type of serialization to use when the policy is saved into the cache.
Public Property
static | Shared in VB</div>
 Trace Trace source associated with FileCache.

Public Fields

Name Description
Public Field
 ACCESS_TIMEOUT_KEY Name of the key used to store AccessTimeout.
Public Field CACHE_DIRECTORY_KEY Name of the key used to store FileCache.
Public Field CACHE_VIRTUAL_DIRECTORY_KEY Name of the key used to store CacheVirtualDirectory.
Public Field DEFAULT_POLICY_KEY Name of the key used to store DefaultPolicy.
Public Field DEFAULT_REGION_KEY Name of the key used to store DefaultRegion.

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Caching Assembly
Introduction
Getting Started
Namespaces
Leadtools.Caching Namespace
Assemblies