org.gridgain.grid.kernal.processors.cache.distributed.near

Class GridNearLockFuture<K,V>

java.lang.Object

java.util.concurrent.locks.AbstractOwnableSynchronizer

java.util.concurrent.locks.AbstractQueuedSynchronizer

org.gridgain.grid.util.future.GridFutureAdapter<R>

org.gridgain.grid.util.future.GridCompoundFuture<T,T>

org.gridgain.grid.util.future.GridCompoundIdentityFuture<Boolean>

org.gridgain.grid.kernal.processors.cache.distributed.near.GridNearLockFuture<K,V>

All Implemented Interfaces:

Externalizable, Serializable, GridFuture<Boolean>, GridCacheFuture<Boolean>, GridCacheMvccFuture<K,V,Boolean>

public final class GridNearLockFuture<K,V>
extends GridCompoundIdentityFuture<Boolean>
implements GridCacheMvccFuture<K,V,Boolean>

Cache lock future.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.locks.AbstractQueuedSynchronizer

AbstractQueuedSynchronizer.ConditionObject

Field Summary

Fields inherited from class org.gridgain.grid.util.future.GridFutureAdapter

ctx

Constructor Summary

Constructors

Constructor and Description
GridNearLockFuture() Empty constructor required by Externalizable.
GridNearLockFuture(GridCacheContext<K,V> cctx, Collection<? extends K> keys, org.gridgain.grid.kernal.processors.cache.distributed.near.GridNearTxLocal<K,V> tx, boolean read, boolean retval, long timeout, GridPredicate<GridCacheEntry<K,V>>[] filter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Default no-op implementation that always returns false.
void	complete(boolean success)
List<GridDistributedCacheEntry<K,V>>	entriesCopy()
GridUuid	futureId()
int	hashCode()
void	markNotTrackable() Marks this future as non-trackable.
Collection<? extends GridNode>	nodes()
boolean	onDone(Boolean success, Throwable err) Callback to notify that future is finished.
boolean	onNodeLeft(UUID nodeId) Callback for when node left.
boolean	onOwnerChanged(GridCacheEntryEx<K,V> entry, GridCacheMvccCandidate<K> owner) Callback for whenever entry lock ownership changes.
String	toString()
boolean	trackable()
GridCacheVersion	version()

Methods inherited from class org.gridgain.grid.util.future.GridCompoundFuture

add, addAll, addAll, futures, hasPending, ignoreChildFailures, initialized, markInitialized, pending, reducer, reducer

Methods inherited from class org.gridgain.grid.util.future.GridFutureAdapter

chain, checkValid, concurrentNotify, concurrentNotify, duration, endTime, error, get, get, get, get0, isCancelled, isDone, isFailed, isValid, listenAsync, onCancelled, onDone, onDone, onDone, readExternal, result, startTime, stopListenAsync, syncNotify, syncNotify, tryAcquireShared, tryReleaseShared, writeExternal

Methods inherited from class java.util.concurrent.locks.AbstractQueuedSynchronizer

acquire, acquireInterruptibly, acquireShared, acquireSharedInterruptibly, compareAndSetState, getExclusiveQueuedThreads, getFirstQueuedThread, getQueuedThreads, getQueueLength, getSharedQueuedThreads, getState, getWaitingThreads, getWaitQueueLength, hasContended, hasQueuedPredecessors, hasQueuedThreads, hasWaiters, isHeldExclusively, isQueued, owns, release, releaseShared, setState, tryAcquire, tryAcquireNanos, tryAcquireSharedNanos, tryRelease

Methods inherited from class java.util.concurrent.locks.AbstractOwnableSynchronizer

getExclusiveOwnerThread, setExclusiveOwnerThread

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gridgain.grid.GridFuture

chain, concurrentNotify, concurrentNotify, duration, get, get, get, isCancelled, isDone, listenAsync, startTime, stopListenAsync, syncNotify, syncNotify

Constructor Detail

GridNearLockFuture

public GridNearLockFuture()

Empty constructor required by Externalizable.

GridNearLockFuture

public GridNearLockFuture(GridCacheContext<K,V> cctx,
                  Collection<? extends K> keys,
                  @Nullable
                  org.gridgain.grid.kernal.processors.cache.distributed.near.GridNearTxLocal<K,V> tx,
                  boolean read,
                  boolean retval,
                  long timeout,
                  GridPredicate<GridCacheEntry<K,V>>[] filter)

Parameters:

cctx - Registry.

keys - Keys to lock.

tx - Transaction.

read - Read flag.

retval - Flag to return value or not.

timeout - Lock acquisition timeout.

filter - Filter.

Method Detail

nodes

public Collection<? extends GridNode> nodes()

Specified by:

nodes in interface GridCacheFuture<Boolean>

Returns:

Participating nodes.

version

public GridCacheVersion version()

Specified by:

version in interface GridCacheFuture<Boolean>

Returns:

Future version.

entriesCopy

public List<GridDistributedCacheEntry<K,V>> entriesCopy()

Returns:

Entries.

futureId

public GridUuid futureId()

Specified by:

futureId in interface GridCacheFuture<Boolean>

Returns:

Future ID.

trackable

public boolean trackable()

Specified by:

trackable in interface GridCacheFuture<Boolean>

Returns:

True if future should be tracked.

markNotTrackable

public void markNotTrackable()

Marks this future as non-trackable.

Specified by:

markNotTrackable in interface GridCacheFuture<Boolean>

complete

public void complete(boolean success)

Parameters:

success - Success flag.

onNodeLeft

public boolean onNodeLeft(UUID nodeId)

Description copied from interface: GridCacheFuture

Callback for when node left.

Specified by:

onNodeLeft in interface GridCacheFuture<Boolean>

Parameters:

nodeId - Left node ID

Returns:

True if node was in the list.

onOwnerChanged

public boolean onOwnerChanged(GridCacheEntryEx<K,V> entry,
                     GridCacheMvccCandidate<K> owner)

Callback for whenever entry lock ownership changes.

Specified by:

onOwnerChanged in interface GridCacheMvccFuture<K,V,Boolean>

Parameters:

entry - Entry whose lock ownership changed.

owner - Owner.

Returns:

True if future cares about this entry.

cancel

public boolean cancel()

Default no-op implementation that always returns false. Futures that do support cancellation should override this method and call GridFutureAdapter.onCancelled() callback explicitly if cancellation indeed did happen.

Specified by:

cancel in interface GridFuture<Boolean>

Overrides:

cancel in class GridCompoundFuture<Boolean,Boolean>

Returns:

True if future was canceled (i.e. was not finished prior to this call).

onDone

public boolean onDone(Boolean success,
             Throwable err)

Callback to notify that future is finished. Note that if non-null exception is passed in the result value will be ignored.

Overrides:

onDone in class GridFutureAdapter<Boolean>

Parameters:

success - Optional result.

err - Optional error.

Returns:

True if result was set by this call.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class GridCompoundIdentityFuture<Boolean>