←Select platform

ObjectCache Class Members

Summary

The following tables list the members exposed by ObjectCache.

Protected Constructors

Name Description
Protected Constructor ObjectCache Initializes a new instance of ObjectCache

Public Methods

Name Description
Public Method Add Adds a new item into the cache using the specified absolute expiration data and region name
Public Method AddOrGetExisting Adds an entry using key and value pair and absolute expiration date into the cache, and returns an existing cache entry with a matching key.
Public Method BeginAddExternalResource Begins adding a new cache item.
Public Method Contains Checks whether the specified cache entry exists in the cache.
Public Method static | Shared in VB CopyCacheItemPolicy Creates a copy of a cache policy.
Public Method static | Shared in VB CreateFromConfigurations Creates a new cache object from the specified configuration stream and optional additional values.
Public Method static | Shared in VB CreateFromConfigurationsString Creates an ObjectCache derived class from the configuration XML stored in a string.
Public Method static | Shared in VB DateFromString Parses a date / time value stored in a string.
Public Method static | Shared in VB DateToString Converts a date / time value to a string using the current format.
Public Method DeleteAll Deletes the specified items from 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 EndAddExternalResource 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 Get Value of the specified cache entry.
Public Method GetCacheItem Specified cache entry from the cache.
Public Method GetConfigurationString Gets the configurations of this ObjectCache as a string.
Public Method GetCount Total number of cache entries in the cache.
Public Method GetItemCapabilities Gets the capabilities of an existing item in the cache.
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 correspond the specified keys.
Public Method static | Shared in VB IsInfinite Determines whether the specified time span is an infinite value.
Public Method LoadConfiguration Updates this ObjectCache from configuration XML stored in a stream.
Public Method Remove Removes an entry from the cache.
Public Method RemoveItemExternalResource Removes the external resource URI associated with the specified cache item
Public Method ResolveDirectory Gets the full path to a directory.
Public Method SaveConfiguration Saves the configurations of this ObjectCache to an XML stored in a stream.
Public Method Set Adds a key/value pair item into the cache with the specified absolute expiration date.
Public Method SetConfigurationString Updates this ObjectCache from configuration XML stored in a string.
Public Method SetName Sets the unique name of this cache object.
Public Method Update Update an existing item in the cache.
Public Method UpdateCacheItem Update an existing item in the cache.
Public Method UpdatePolicy Update the policy of an existing cache item.

Protected Methods

Name Description
Protected Method GetEnumerator Creates an enumerator that can be used to iterate through a collection of cache entries.
Protected Method LoadConfigurationValues Load the configuration of this cache object from the specified dictionary.
Protected Method OnCacheItemExpired Raises the CacheItemExpired event.
Protected Method OnCacheItemExpiring Raises the CacheItemExpiring event.
Protected Method SaveConfigurationValues Saves the configuration of this cache object to the specified dictionary.

Public Properties

Name Description
Public Property BaseDirectory The base directory where the cache is stored.
Public Property DataSerializationMode Determines the type of serialization to use when the data is saved into the cache.
Public Property DefaultCacheCapabilities The capabilities of this cache
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 Events

Name Description
Public Event CacheItemExpired Occurs when an expired item has been removed from the cache.
Public Event CacheItemExpiring Occurs when an item has expired and is about to be removed from the cache.

Public Fields

Name Description
Public Field BASE_DIRECTORY_KEY Name of the key used to store BaseDirectory.
Public Field DATA_SERIALIZATION_MODE_KEY Name of the key used to store DataSerializationMode.
Public Field DateFormat Format to use when storing dates in the XML and JSON formats.
Public Field static | Shared in VB InfiniteAbsoluteExpiration Value that indicates that a cache entry has no absolute expiration.
Public Field static | Shared in VB NoSlidingExpiration Value that indicates that a cache entry has no sliding expiration.
Public Field POLICY_SERIALIZATION_MODE_KEY Name of the key used to store PolicySerializationMode.

See Also

ObjectCache Class

Leadtools.Caching Namespace

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

Leadtools.Caching Assembly
Introduction
Getting Started
Namespaces
Leadtools.Caching Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.