Interface IConcurrentCache

ICache with additional concurrency features.

Inherited Members

ICache.GetAll(ICollection)

ICache.Insert(object, object)

ICache.Insert(object, object, long)

ICache.InsertAll(IDictionary)

ICache.Entries

ICache.GetEnumerator()

IDictionary.Add(object, object)

IDictionary.Clear()

IDictionary.Contains(object)

IDictionary.Remove(object)

IDictionary.IsFixedSize

IDictionary.IsReadOnly

IDictionary.this[object]

IDictionary.Keys

IDictionary.Values

ICollection.CopyTo(Array, int)

ICollection.Count

ICollection.IsSynchronized

ICollection.SyncRoot

Namespace: Tangosol.Net.Cache

Assembly: Coherence.dll

Syntax

public interface IConcurrentCache : ICache, IDictionary, ICollection, IEnumerable

Methods

Lock(object)

Attempt to lock the specified item and return immediately.

Declaration

bool Lock(object key)

Parameters

Type	Name	Description
object	key	Key being locked.

Returns

Type	Description
bool	true if the item was successfully locked; false otherwise.

Remarks

This method behaves exactly as if it simply performs the call Lock(key, 0).

Lock(object, long)

Attempt to lock the specified item within the specified period of time.

Declaration

bool Lock(object key, long waitTimeMillis)

Parameters

Type	Name	Description
object	key	Key being locked.
long	waitTimeMillis	The number of milliseconds to continue trying to obtain a lock; pass zero to return immediately; pass -1 to block the calling thread until the lock could be obtained.

Returns

Type	Description
bool	true if the item was successfully locked within the specified time; false otherwise.

Remarks

The item doesn't have to exist to be locked. While the item is locked there is known to be a lock holder which has an exclusive right to modify (calling put and remove methods) that item.

Lock holder is an abstract concept that depends on the IConcurrentCache implementation. For example, holder could be a cluster member or a thread (or both).

Locking strategy may vary for concrete implementations as well. Lock could have an expiration time (this lock is sometimes called a "lease") or be held indefinitely (until the lock holder terminates).

Some implementations may allow the entire cache to be locked. If the cache is locked in such a way, then only a lock holder is allowed to perform any of the "put" or "remove" operations.

Pass the special constant LOCK_ALL as the key parameter to indicate the cache lock.

Unlock(object)

Unlock the specified item.

Declaration

bool Unlock(object key)

Parameters

Type	Name	Description
object	key	Key being unlocked.

Returns

Type	Description
bool	true if the item was successfully unlocked; false otherwise.

Remarks

The item doesn't have to exist to be unlocked. If the item is currently locked, only the holder of the lock could successfully unlock it.