Package org.apache.ignite.internal.processors.cache.distributed.dht.colocated

Class GridDhtColocatedLockFuture

java.lang.Object

org.apache.ignite.internal.util.future.GridFutureAdapter<R>

org.apache.ignite.internal.util.future.GridCompoundFuture<T,T>

org.apache.ignite.internal.util.future.GridCompoundIdentityFuture<T>

org.apache.ignite.internal.processors.cache.GridCacheCompoundIdentityFuture<Boolean>

org.apache.ignite.internal.processors.cache.distributed.dht.colocated.GridDhtColocatedLockFuture

All Implemented Interfaces:

Serializable, IgniteDiagnosticAware, IgniteInternalFuture<Boolean>, GridCacheFuture<Boolean>, GridCacheVersionedFuture<Boolean>, IgniteInClosure<IgniteInternalFuture<Boolean>>

public final class GridDhtColocatedLockFuture
extends GridCacheCompoundIdentityFuture<Boolean>
implements GridCacheVersionedFuture<Boolean>, IgniteDiagnosticAware

Colocated cache lock future.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GridDhtColocatedLockFuture(GridCacheContext<?,?> cctx, Collection<KeyCacheObject> keys, @Nullable GridNearTxLocal tx, boolean read, boolean retval, long timeout, long createTtl, long accessTtl, boolean skipStore, boolean keepBinary, boolean recovery)

Method Summary

Modifier and Type	Method	Description
void	addDiagnosticRequest(IgniteDiagnosticPrepareContext ctx)
boolean	cancel()	Cancellation has special meaning for lock futures.
IgniteUuid	futureId()
int	hashCode()
void	markNotTrackable()	Marks this future as non-trackable.
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 entry, GridCacheMvccCandidate owner)
Set<IgniteTxKey>	requestedKeys()
String	toString()
boolean	trackable()
GridCacheVersion	version()

Methods inherited from class org.apache.ignite.internal.processors.cache.GridCacheCompoundIdentityFuture

duration, onDone, startTime

Methods inherited from class org.apache.ignite.internal.util.future.GridCompoundFuture

add, apply, clear, compoundsLockedExclusively, compoundsReadLock, compoundsReadUnlock, future, futures, futuresCountNoLock, hasFutures, hasPending, ignoreFailure, initialized, logDebug, logError, markInitialized, processFailure

Methods inherited from class org.apache.ignite.internal.util.future.GridFutureAdapter

chain, chain, chain, chain, chainCompose, chainCompose, error, get, get, get, getUninterruptibly, ignoreInterrupts, isCancelled, isDone, isFailed, listen, listen, logger, onCancelled, onDone, onDone, onDone, reset, result

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.internal.processors.cache.GridCacheFuture

duration, startTime

Methods inherited from interface org.apache.ignite.internal.IgniteInternalFuture

chain, chain, chain, chain, chainCompose, chainCompose, error, get, get, get, getUninterruptibly, isCancelled, isDone, listen, listen, result

Constructor Detail

GridDhtColocatedLockFuture

public GridDhtColocatedLockFuture(GridCacheContext<?,?> cctx,
                                  Collection<KeyCacheObject> keys,
                                  @Nullable
                                  @Nullable GridNearTxLocal tx,
                                  boolean read,
                                  boolean retval,
                                  long timeout,
                                  long createTtl,
                                  long accessTtl,
                                  boolean skipStore,
                                  boolean keepBinary,
                                  boolean recovery)

Parameters:

cctx - Registry.

keys - Keys to lock.

tx - Transaction.

read - Read flag.

retval - Flag to return value or not.

timeout - Lock acquisition timeout.

createTtl - TTL for create operation.

accessTtl - TTL for read operation.

skipStore - Skip store flag.

Method Detail

version

public GridCacheVersion version()

Specified by:

version in interface GridCacheVersionedFuture<Boolean>

Returns:

Future version.

onOwnerChanged

public boolean onOwnerChanged(GridCacheEntryEx entry,
                              GridCacheMvccCandidate owner)

Specified by:

onOwnerChanged in interface GridCacheVersionedFuture<Boolean>

Parameters:

entry - Entry which received new owner.

owner - Owner.

Returns:

True if future cares about this entry.

futureId

public IgniteUuid 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>

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.

requestedKeys

public Set<IgniteTxKey> requestedKeys()

Returns:

Keys for which locks requested from remote nodes but response isn't received.

cancel

public boolean cancel()

Cancellation has special meaning for lock futures. It's called then lock must be released on rollback.

Specified by:

cancel in interface IgniteInternalFuture<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

addDiagnosticRequest

public void addDiagnosticRequest(IgniteDiagnosticPrepareContext ctx)

Specified by:

addDiagnosticRequest in interface IgniteDiagnosticAware

Parameters:

ctx - Context.

toString

public String toString()

Overrides:

toString in class GridCompoundIdentityFuture<Boolean>