LocalCache Methods |
14c (14.1.1.0)
F23534-02
The LocalCache type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AcquireReadLock |
Acquire a read lock.
(Inherited from SynchronizedDictionary.) |
| AcquireReadLock(Int32) |
Acquire a read lock.
(Inherited from SynchronizedDictionary.) |
| AcquireWriteLock |
Acquire a write lock.
(Inherited from SynchronizedDictionary.) |
| AcquireWriteLock(Int32) |
Acquire a write lock.
(Inherited from SynchronizedDictionary.) |
| Add |
Adds an element with the provided key and value to the cache.
(Overrides SynchronizedDictionaryAdd(Object, Object).) |
| AddCacheListener(ICacheListener) |
Add a standard cache listener that will receive all events
(inserts, updates, deletes) that occur against the cache, with
the key, old-value and new-value included.
|
| AddCacheListener(ICacheListener, Object, Boolean) |
Add a cache listener for a specific key.
|
| AddCacheListener(ICacheListener, IFilter, Boolean) |
Add a cache listener that receives events based on a filter
evaluation.
|
| AddIndex |
Add an index to this IQueryCache.
|
 | AddInternal |
Add new cache entry and raise Inserted event if necessary.
|
| AdjustUnits |
Adjust current size.
|
| Aggregate(ICollection, IEntryAggregator) |
Perform an aggregating operation against the entries specified by
the passed keys.
|
| Aggregate(IFilter, IEntryAggregator) |
Perform an aggregating operation against the collection of
entries that are selected by the given IFilter.
|
| CheckFlush |
Flush the cache if it needs to be flushed.
|
| CheckSize |
Check if the cache is too big, and if it is prune it by
discarding the lowest priority cache entries.
|
| Clear |
Removes all elements from the ICache object.
(Overrides SynchronizedDictionaryClear.) |
| ClearInternal |
Utility method to support clear and truncation operations.
|
| ConfigureEviction |
Configure the eviction type and policy.
|
| ConfigureUnitCalculator |
Configure the unit calculator type and implementation.
|
| Contains |
Determines whether the object contains an element with the
specified key.
(Overrides SynchronizedDictionaryContains(Object).) |
| ContainsKey |
Determines whether the IDictionary object contains an
element with the specified key.
|
| ContainsValue |
Determines whether the IDictionary object contains an
element with the specified value.
|
| CopyTo |
Copies the elements of the IDictionary to an Array,
starting at a particular index.
(Overrides SynchronizedDictionaryCopyTo(Array, Int32).) |
| CreateEntry |
Creates an ICacheEntry.
|
| DispatchEvent |
Dispatch the passed event.
|
| EnsureEntry |
Create a LocalCacheEntry object for the specified key.
|
| EnsureEntryCollection |
Create an array of LocalCacheEntry objects for the specified
ICache and the keys collection.
|
| EnsureIndexMap |
Obtain the IDictionary of indexes maintained by this cache.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Evict |
Evict all entries from the cache that are no longer valid, and
potentially prune the cache size if the cache is size-limited
and its size is above the caching low water mark.
|
| Evict(Object) |
Evict a specified key from the cache, as if it had expired from
the cache.
|
| EvictAll |
Evict the specified keys from the cache, as if they had each
expired from the cache.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAll |
Get the values for all the specified keys, if they are in the
cache.
|
| GetCacheEntry |
Locate a cache entry in the cache based on its key.
|
| GetEntries(IFilter) |
Return a collection of the entries contained in this cache
that satisfy the criteria expressed by the filter.
|
| GetEntries(IFilter, IComparer) |
Return a collection of the entries contained in this cache
that satisfy the criteria expressed by the filter.
|
| GetEntry |
Locate an LocalCacheEntry in the cache based on its key.
|
| GetEntryInternal |
Locate an LocalCacheEntry in the cache based on its key.
|
| GetEnumerator |
Returns an ICacheEnumerator object for the
ICache instance.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetKeys |
Return a collection of the keys contained in this cache for
entries that satisfy the criteria expressed by the filter.
|
| GetObjectData |
Populates SerializationInfo with the data needed to serialize this
object.
(Inherited from SynchronizedDictionary.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValues(IFilter) |
Return a collection of the values contained in this cache for
entries that satisfy the criteria expressed by the filter.
|
| GetValues(IFilter, IComparer) |
Return a collection of the values contained in this cache for
entries that satisfy the criteria expressed by the filter.
|
| HasListeners |
Determine if the LocalCache has any listeners at all.
|
| Insert(Object, Object) |
Associates the specified value with the specified key in this
cache.
|
| Insert(Object, Object, Int64) |
Associates the specified value with the specified key in this
cache.
|
| InsertAll |
Copies all of the mappings from the specified dictionary to this
cache (optional operation).
|
| InstantiateCacheEnumerator |
Factory method for cache enumerator.
|
| InstantiateCacheEvent |
Factory pattern: instantiate a new CacheEventArgs
corresponding to the specified parameters.
|
| InstantiateEntriesCollection |
Factory method that creates virtual collection of cache entries.
|
| InstantiateInternalListener |
Factory pattern: Instantiate an internal
ICacheListener to listen to this cache and report
changes to the ICacheStore.
|
| InstantiateKeysCollection |
Factory method that creates virtual collection of cache keys.
|
| InstantiateValuesCollection |
Factory method that creates virtual collection of cache values.
|
| Invoke |
Invoke the passed IEntryProcessor against the entry
specified by the passed key, returning the result of the
invocation.
|
| InvokeAll(ICollection, IEntryProcessor) |
Invoke the passed IEntryProcessor against the
entries specified by the passed keys, returning the result of the
invocation for each.
|
| InvokeAll(IFilter, IEntryProcessor) |
Invoke the passed IEntryProcessor against the set
of entries that are selected by the given IFilter,
returning the result of the invocation for each.
|
| IsFlushRequired |
Check if the cache needs to be flushed.
|
| Load |
Indicates to the cache that the specified key should be loaded
into the cache, if it is not already in the cache.
|
| LoadAll |
Indicates to the cache that it should load data from its loader
to fill the cache; this is sometimes referred to as
"pre-loading" or "warming" a cache.
|
| LoadAll(ICollection) |
Indicates to the cache that the specified keys should be loaded
into the cache, if they are not already in the cache.
|
| Lock(Object) |
Attempt to lock the specified item and return immediately.
|
| Lock(Object, Int64) |
Attempt to lock the specified item within the specified period of
time.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Peek |
Checks for a valid entry corresponding to the specified key in
the cache, and returns the corresponding value if it is.
|
| PeekAll |
Checks for a valid entry corresponding to each specified key in
the cache, and places the corresponding value in the returned
dictionary if it is.
|
| PeekEntryInternal |
Locate an LocalCacheEntry in the cache based on its key.
|
| Prune |
Prune the cache by discarding the lowest priority cache entries.
|
| ReleaseReadLock |
Release a read lock.
(Inherited from SynchronizedDictionary.) |
| ReleaseWriteLock |
Release a write lock.
(Inherited from SynchronizedDictionary.) |
| Remove |
Removes the element with the specified key from the
ICache object.
(Overrides SynchronizedDictionaryRemove(Object).) |
| RemoveCacheListener(ICacheListener) |
Remove a standard cache listener that previously signed up for
all events.
|
| RemoveCacheListener(ICacheListener, Object) |
Remove a cache listener that previously signed up for events
about a specific key.
|
| RemoveCacheListener(ICacheListener, IFilter) |
Remove a cache listener that previously signed up for events
based on a filter evaluation.
|
| RemoveExpired |
Remove an entry because it has expired.
|
| RemoveIndex |
Remove an index from this IQueryCache.
|
| RemoveInternal |
Remove an entry.
|
| ResetHitStatistics |
Reset the cache statistics.
|
| ScheduleFlush |
Schedule the next flush.
|
| ToString |
Returns a string representation of this LocalCache object.
(Overrides ObjectToString.) |
| Truncate |
Removes all mappings from this map.
|
| Unlock |
Unlock the specified item.
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetOrDefault |
Returns the value to which the specified key is mapped, or
the defaultValue if this cache contains no mapping for the key.
(Defined by InvocableCacheEx.) |
| InsertIfAbsent |
If the specified key is not already associated with a value
(or is mapped to null) associates it with the given value and
returns null, else returns the current value.
(Defined by InvocableCacheEx.) |
| Remove |
Removes the entry for the specified key only if it is currently
mapped to the specified value.
(Defined by InvocableCacheEx.) |
| Replace(Object, Object) | Overloaded.
Replaces the entry for the specified key only if it is
currently mapped to some value.
(Defined by InvocableCacheEx.) |
| Replace(Object, Object, Object) | Overloaded.
Replaces the entry for the specified key only if currently
mapped to the specified value.
(Defined by InvocableCacheEx.) |
See Also