Oracle® Coherence .NET API Reference Release 3.7.1
E22844-03

The LocalCache type exposes the following members.

Constructors

  NameDescription
LocalCacheOverloaded.

Methods

  NameDescription
AcquireReadLockOverloaded.
AcquireWriteLockOverloaded.
Add
Adds an element with the provided key and value to the cache.
(Overrides SynchronizedDictionary..::.Add(Object, Object).)
AddCacheListenerOverloaded.
AddIndex
Add an index to this IQueryCache.
AddInternal
Add new cache entry and raise Inserted event if necessary.
AdjustUnits
Adjust current size.
AggregateOverloaded.
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 SynchronizedDictionary..::.Clear()()().)
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 SynchronizedDictionary..::.Contains(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 SynchronizedDictionary..::.CopyTo(Array, Int32).)
CreateEntry
Creates an ICacheEntry.
DispatchEvent
Dispatch the passed event.
EnsureEntry
Create a LocalCache..::.Entry object for the specified key.
EnsureEntryCollection
Create an array of LocalCache..::.Entry 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.)
EvictOverloaded.
EvictAll
Evict the specified keys from the cache, as if they had each expired from the cache.
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object 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.
GetEntriesOverloaded.
GetEntry
Locate an LocalCache..::.Entry in the cache based on its key.
GetEntryInternal
Locate an LocalCache..::.Entry in the cache based on its key.
GetEnumerator
Returns an ICacheEnumerator object for the ICache instance.
GetHashCode
Serves as a hash function for a particular type.
(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.)
GetValuesOverloaded.
HasListeners
Determine if the LocalCache has any listeners at all.
InsertOverloaded.
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.
InvokeAllOverloaded.
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.
LoadAllOverloaded.
LockOverloaded.
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 LocalCache..::.Entry 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 SynchronizedDictionary..::.Remove(Object).)
RemoveCacheListenerOverloaded.
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 Object..::.ToString()()().)
Unlock
Unlock the specified item.

Fields

  NameDescription
DEFAULT_EXPIRE
By default, the cache entries never expire.
DEFAULT_FLUSH
By default, expired cache entries are flushed on a minute interval.
DEFAULT_KEY_MASK
The default key mask that ignores nothing.
DEFAULT_PRUNE
By default, when the cache prunes, it reduces its entries by 25%, meaning it retains 75% (.75) of its entries.
DEFAULT_UNITS
By default, the cache size (in units) is infinite.
m_avgTouch
For a prune cycle, this value is the average number of touches that an entry should have. This value is used by the hybrid eviction policy.
m_dict
Wrapped, non-thread safe dictionary.
(Inherited from SynchronizedDictionary.)
m_lastPrune
The last time that a prune was run. This value is used by the hybrid eviction policy.

Properties

  NameDescription
CacheHits
Gets the rough number of cache hits since the cache statistics were last reset.
CacheLoader
Gets or sets the loader used by this LocalCache.
CacheMisses
Gets the rough number of cache misses since the cache statistics were last reset.
CacheStatistics
Gets the ICacheStatistics for this cache.
CacheStore
Determine the store used by this LocalCache, if any.
CalculatorType
Gets or sets the current unit calculator type for the cache.
Count
Gets the number of elements contained in the ICache.
(Overrides SynchronizedDictionary..::.Count.)
CurrentKeyMask
Gets or sets the current key mask for the current thread.
Delegate
Return the delegate IDictionary.
(Inherited from SynchronizedDictionary.)
Entries
Get a collection of ICacheEntry instances within the cache.
EvictionPolicy
Determine the current external eviction policy, if any.
EvictionType
Gets or sets the current eviction type.
ExpiryDelay
Gets or sets the "time to live" for each individual cache entry.
FlushDelay
Gets or sets the delay between cache flushes.
FlushTime
Gets or sets the date/time offset in milliseconds at which the next cache flush is scheduled.
HighUnits
Gets or sets the limit of the cache size in units.
HitProbability
Gets the rough probability (0 <= p <= 1) that any particular "get" invocation will be satisfied by an existing entry in the cache, based on the statistics collected since the last reset of the cache statistics.
IndexMap
The index IDictionary used by this LocalCache.
IsFixedSize
Get a value indicating whether this dictionary has a fixed size.
(Inherited from SynchronizedDictionary.)
IsReadLockHeld
Determines whether or not the current thread holds a read lock.
(Inherited from SynchronizedDictionary.)
IsReadOnly
Get a value indicating whether this dictionary is read-only.
(Inherited from SynchronizedDictionary.)
IsSynchronized
Gets a value indicating whether access to this dictionary is thread-safe.
(Inherited from SynchronizedDictionary.)
IsWriteLockHeld
Determines whether or not the current thread holds the write lock.
(Inherited from SynchronizedDictionary.)
Item
Gets or sets the element with the specified key.
(Overrides SynchronizedDictionary..::.Item[([(Object])]).)
Keys
Get the keys collection.
(Overrides SynchronizedDictionary..::.Keys.)
LowUnits
Gets or sets the point to which the cache will shrink when it prunes.
PruneLevel
The percentage of the total number of units that will remain after the cache manager prunes the cache.
Storage
Get underlying cache storage.
SyncRoot
Get an object that can be used to synchronize access to this dictionary.
(Inherited from SynchronizedDictionary.)
UnitCalculator
Gets or sets the current external unit calculator, if any.
Units
Gets the number of units that the cache currently stores.
Values
Get the values collection.
(Overrides SynchronizedDictionary..::.Values.)

See Also