NearCache Class |
14c (14.1.1.0)
F23534-02
A "near cache" is a CompositeCache whose front
cache is a size-limited and/or auto-expiring local cache,
and whose back cache is a distributed cache.
Inheritance HierarchyNamespace: Tangosol.Net.Cache
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
SyntaxC#
public class NearCache : CompositeCache, INamedCache, IObservableCache, IConcurrentCache, IQueryCache, IInvocableCache, ICache, IDictionary, ICollection, IEnumerable, IDisposable
The NearCache type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NearCache(ICache, INamedCache) |
Construct a NearCache, using a backINamedCache as the complete (back) storage and
frontICache as a near (front) storage using
the CompositeCacheStrategyType invalidation
strategy.
|
| NearCache(ICache, INamedCache, CompositeCacheStrategyType) |
Construct a NearCache, using a backINamedCache as the complete (back) storage and
frontICache as a near (front) storage using
the CompositeCacheStrategyType invalidation
strategy.
|
Properties| Name | Description | |
|---|---|---|
 | AverageGetMillis |
Determine the average number of milliseconds per "get"
invocation since the cache statistics were last reset.
(Inherited from CompositeCache.) |
| AverageHitMillis |
Determine the average number of milliseconds per "get"
invocation that is a hit.
(Inherited from CompositeCache.) |
| AverageMissMillis |
Determine the average number of milliseconds per "get" invocation
that is a miss.
(Inherited from CompositeCache.) |
| AveragePruneMillis |
Determine the average number of milliseconds per cache pruning.
(Inherited from CompositeCache.) |
| AveragePutMillis |
Determine the average number of milliseconds per "put"
invocation since the cache statistics were last reset.
(Inherited from CompositeCache.) |
| BackCache |
Obtain the INamedCache object that sits behind this
NearCache.
|
| CacheControl |
Obtain the IConcurrentCache that should be used to
synchronize the front cache modification access.
(Inherited from CompositeCache.) |
| CacheHits |
Determine the rough number of cache hits since the cache
statistics were last reset.
(Inherited from CompositeCache.) |
| CacheHitsMillis |
Determine the total number of milliseconds (since that last
statistics reset) for the "get" operations for which an entry
existed in this cache.
(Inherited from CompositeCache.) |
| CacheMisses |
Determine the rough number of cache misses since the cache
statistics were last reset.
(Inherited from CompositeCache.) |
| CacheMissesMillis |
Determine the total number of milliseconds (since that last
statistics reset) for the "get" operations for which no entry
existed in this map.
(Inherited from CompositeCache.) |
| CacheName |
Gets the cache name.
|
| CachePrunes |
Determine the rough number of cache pruning cycles since the
cache statistics were last reset.
(Inherited from CompositeCache.) |
| CachePrunesMillis |
Determine the total number of milliseconds (since that last
statistics reset) spent on cache pruning.
(Inherited from CompositeCache.) |
| CacheService |
Gets the ICacheService that this INamedCache is a
part of.
|
| CacheStatistics |
Obtain the CacheStatistics for this cache.
(Inherited from CompositeCache.) |
| Count |
Gets the number of elements contained in the
BackCache.
(Inherited from CompositeCache.) |
| Entries |
Gets a collection of ICacheEntry instances
within the cache.
(Inherited from CompositeCache.) |
| FrontCache |
Obtain the front cache reference.
(Inherited from CompositeCache.) |
| HitProbability |
Determine the rough probability (0 <= p <= 1) that the next
invocation will be a hit, based on the statistics collected since
the last reset of the cache statistics.
(Inherited from CompositeCache.) |
| InvalidationHits |
Determine the rough number of front cache invalidation hits
since the cache statistics were last reset.
(Inherited from CompositeCache.) |
| InvalidationMisses |
Determine the rough number of front cache invalidation
misses since the cache statistics were last reset.
(Inherited from CompositeCache.) |
| InvalidationStrategy |
Obtain the invalidation strategy used by this
CompositeCache.
(Inherited from CompositeCache.) |
| IsActive |
Specifies whether or not the INamedCache is active.
|
 | IsCoherent |
Determine if changes to the back cache affect the front cache so
that data in the front cache stays in sync.
(Inherited from CompositeCache.) |
| IsFixedSize |
Gets a value indicating whether the BackCache
object has a fixed size.
(Inherited from CompositeCache.) |
| IsReadOnly |
Gets a value indicating whether the BackCache
object is read-only.
(Inherited from CompositeCache.) |
| IsSynchronized |
Gets a value indicating whether access to the back cache is
synchronized (thread safe).
(Inherited from CompositeCache.) |
| Item |
Gets or sets the element with the specified key.
(Inherited from CompositeCache.) |
| Keys |
Obtain an ICollection of the keys contained in this cache.
(Inherited from CompositeCache.) |
| SyncRoot |
Gets an object that can be used to synchronize access to the back
cache.
(Inherited from CompositeCache.) |
| TotalGets |
Determine the total number of "get" operations since the cache
statistics were last reset.
(Inherited from CompositeCache.) |
| TotalGetsMillis |
Determine the total number of milliseconds spent on "get"
operations since the cache statistics were last reset.
(Inherited from CompositeCache.) |
| TotalPuts |
Determine the total number of "put" operations since the cache
statistics were last reset.
(Inherited from CompositeCache.) |
| TotalPutsMillis |
Determine the total number of milliseconds spent on "put"
operations since the cache statistics were last reset.
(Inherited from CompositeCache.) |
| TotalRegisterListener |
Determine the total number of
RegisterListener(Object) operations since the cache
statistics were last reset.
(Inherited from CompositeCache.) |
| Values |
Obtain an ICollection of the values contained in this
cache.
(Inherited from CompositeCache.) |
Methods| Name | Description | |
|---|---|---|
| Add |
Associates the specified value with the specified key in this
cache.
(Inherited from CompositeCache.) |
| 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.
|
| 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.
|
| Clear |
Clears both the front and back caches.
(Inherited from CompositeCache.) |
| Contains |
Check whether or not this cache contains a mapping for the
specified key.
(Inherited from CompositeCache.) |
| CopyTo |
Copies the elements of the BackCache to an
Array, starting at a particular Array index.
(Inherited from CompositeCache.) |
| Destroy |
Release and destroy this instance of INamedCache.
|
| Dispose |
Calls Release to release the resources associated with this cache.
(Inherited from CompositeCache.) |
 | EnsureInvalidationStrategy |
Ensure that a strategy has been choosen and that any appropriate
global listeners have been registered.
(Inherited from CompositeCache.) |
| Equals |
Compares the specified object with this dictionary for equality.
(Inherited from CompositeCache.) |
| 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.
(Inherited from CompositeCache.) |
| 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.
|
| GetEnumerator |
Returns an enumerator that iterates through a cache.
(Inherited from CompositeCache.) |
| GetHashCode |
Return the hash code value for this dictionary.
(Inherited from CompositeCache.) |
| GetKeys |
Return a collection of the keys contained in this cache for
entries that satisfy the criteria expressed by the filter.
|
| 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.
|
| Insert(Object, Object) |
Associates the specified value with the specified key in this
cache.
(Inherited from CompositeCache.) |
| Insert(Object, Object, Int64) |
Associates the specified value with the specified key in this
cache.
(Inherited from CompositeCache.) |
| InsertAll |
Copies all of the mappings from the specified dictionary to this
cache (optional operation).
(Inherited from CompositeCache.) |
| InstantiateBackCacheListener |
Factory pattern: instantiate back cache listener.
(Inherited from CompositeCache.) |
| InstantiateFrontCacheListener |
Factory pattern: instantiate front cache listener.
(Inherited from CompositeCache.) |
| InvalidateFront |
Invalidate the key from the front.
(Inherited from CompositeCache.) |
| 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.
|
| 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.) |
| OnMemberJoined |
Invoked when an IMember has joined the service.
|
| OnMemberLeaving |
Invoked when an IMember is leaving the service.
|
| OnMemberLeft |
Invoked when an IMember has left the service.
|
| RegisterBackServiceMemberEventHandler |
Register an event handler for member events on back caches's
service.
|
| RegisterDeactivationListener |
Instantiate and register a DeactivationListener with the back cache.
(Inherited from CompositeCache.) |
| RegisterFrontListener |
Register the global front cache listener.
(Inherited from CompositeCache.) |
| RegisterListener |
Register the global back cache listener.
(Inherited from CompositeCache.) |
| RegisterListener(Object) |
Register the back cache listener for the specified key.
(Inherited from CompositeCache.) |
| RegisterListeners |
Register the back map listeners for the specified set of keys.
(Inherited from CompositeCache.) |
| Release |
Release local resources associated with this instance of
INamedCache.
(Overrides CompositeCacheRelease.) |
| Release(Boolean) |
Release this cache, optionally destroying it.
|
| Remove |
Remove the mapping for this key from this cache if present.
(Inherited from CompositeCache.) |
| 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.
|
| RemoveIndex |
Remove an index from this IQueryCache.
|
| RemoveKeyHolder |
Remove the key holder from the ThreadLocal object.
(Inherited from CompositeCache.) |
| ResetFrontMap |
Reset the front map.
(Inherited from CompositeCache.) |
| ResetHitStatistics |
Reset the cache statistics.
(Inherited from CompositeCache.) |
| ResetInvalidationStrategy |
Reset the "current invalidation strategy" flag.
(Inherited from CompositeCache.) |
| SetKeyHolder |
Set up a thread local Set to hold all the keys that might be evicted
from the front cache.
(Inherited from CompositeCache.) |
| ToString |
For debugging purposes, format the contents of the
CompositeCache in a human readable format.
(Inherited from CompositeCache.) |
| Truncate |
Remove all mappings of this instance of INamedCache.
|
| TryLock |
Lock the keys in the given set without blocking.
(Inherited from CompositeCache.) |
| Unlock |
Unlock the specified item.
|
| UnregisterBackServiceMemberEventHandler |
Unregister back caches's service member event handler.
|
| UnregisterDeactivationListener |
Unregister back cache deactivation listener.
(Inherited from CompositeCache.) |
| UnregisterFrontListener |
Unregister the global front cache listener.
(Inherited from CompositeCache.) |
| UnregisterListener |
Unregister the global back cache listener.
(Inherited from CompositeCache.) |
| UnregisterListener(Object) |
Unregister the back cache listener for the specified key.
(Inherited from CompositeCache.) |
| UnregisterListeners |
Unregister the back cache listener for the specified keys.
(Inherited from CompositeCache.)Note: all the keys in the passed-in set must be locked and will be unlocked. |
| Validate |
Validate the front cache entry for the specified back cache
event.
(Inherited from CompositeCache.) |
| View |
Construct a view of this INamedCache.
|
Fields| Name | Description | |
|---|---|---|
 | m_strategyCurrent |
The current invalidation strategy, which at times could be
different from the target strategy.
(Inherited from CompositeCache.) |
| m_strategyTarget |
The invalidation strategy that this cache is to use.
(Inherited from CompositeCache.) |
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.) |
Remarks
A CompositeCache is a cache that has a "front" cache and a
"back" cache; the front cache is assumed to be low latency but
incomplete, and the back cache is assumed to be complete but high
latency.
See Also