org.apache.ignite.internal.processors.cache.distributed

Class GridDistributedLockRequest<K,V>

java.lang.Object

org.apache.ignite.plugin.extensions.communication.MessageAdapter

org.apache.ignite.internal.processors.cache.GridCacheMessage<K,V>

org.apache.ignite.internal.processors.cache.distributed.GridDistributedBaseMessage<K,V>

org.apache.ignite.internal.processors.cache.distributed.GridDistributedLockRequest<K,V>

All Implemented Interfaces:

Serializable, GridCacheDeployable, GridCacheVersionable

Direct Known Subclasses:

GridDhtLockRequest, GridNearLockRequest

public class GridDistributedLockRequest<K,V>
extends GridDistributedBaseMessage<K,V>

Lock request message.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ignite.plugin.extensions.communication.MessageAdapter

MessageAdapter.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected int	idx Key-bytes index.

Fields inherited from class org.apache.ignite.internal.processors.cache.distributed.GridDistributedBaseMessage

ver

Fields inherited from class org.apache.ignite.internal.processors.cache.GridCacheMessage

CACHE_MSG_INDEX_FIELD_NAME, cacheId, MAX_CACHE_MSG_LOOKUP_INDEX

Fields inherited from class org.apache.ignite.plugin.extensions.communication.MessageAdapter

reader, readState

Constructor Summary

Constructors

Constructor and Description
GridDistributedLockRequest() Empty constructor.
GridDistributedLockRequest(int cacheId, UUID nodeId, GridCacheVersion nearXidVer, long threadId, IgniteUuid futId, GridCacheVersion lockVer, boolean isInTx, boolean isRead, TransactionIsolation isolation, boolean isInvalidate, long timeout, int keyCnt, int txSize, IgniteTxKey grpLockKey, boolean partLock)

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyBytes(K key, byte[] keyBytes, boolean retVal, Collection<GridCacheMvccCandidate<K>> cands, GridCacheContext<K,V> ctx) Adds a key.
byte	directType() Gets message type.
void	finishUnmarshal(GridCacheSharedContext<K,V> ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheSharedContext) method.
IgniteUuid	futureId()
boolean	groupLock()
IgniteTxKey	groupLockKey()
boolean	inTx()
boolean	isInvalidate()
TransactionIsolation	isolation()
List<byte[]>	keyBytes()
List<K>	keys()
GridCacheVersion	nearXidVersion()
UUID	nodeId()
boolean	partitionLock()
void	prepareMarshal(GridCacheSharedContext<K,V> ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
boolean	readFrom(ByteBuffer buf) Reads this message from provided byte buffer.
boolean[]	returnFlags()
boolean	returnValue(int idx)
long	threadId()
long	timeout()
String	toString()
boolean	txRead()
int	txSize()
boolean	writeTo(ByteBuffer buf, MessageWriter writer) Writes this message to provided byte buffer.

Methods inherited from class org.apache.ignite.internal.processors.cache.distributed.GridDistributedBaseMessage

candidatesByIndex, candidatesByIndex, candidatesByKey, candidatesByKey, candidatesByKey, committedVersions, completedVersions, keysCount, rolledbackVersions, version, version

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

allowForStartup, cacheId, cacheId, classError, deployInfo, ignoreClassErrors, lookupIndex, marshalBooleanLinkedMap, marshalCollection, marshalFilter, marshalInfo, marshalInfos, marshalInvokeArguments, marshalTx, marshalValuesCollection, messageId, nextIndexId, onClassError, prepare, prepareFilter, prepareObject, prepareObjects, topologyVersion, transactional, transferExpiryPolicy, unmarshalBooleanLinkedMap, unmarshalCollection, unmarshalFilter, unmarshalInfo, unmarshalInfos, unmarshalInvokeArguments, unmarshalTx, unmarshalValueBytesCollection

Methods inherited from class org.apache.ignite.plugin.extensions.communication.MessageAdapter

setReader, skipRecovery

Methods inherited from class java.lang.Object

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

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

deployInfo, prepare

Field Detail

idx

protected int idx

Key-bytes index.

Constructor Detail

GridDistributedLockRequest

public GridDistributedLockRequest()

Empty constructor.

GridDistributedLockRequest

public GridDistributedLockRequest(int cacheId,
                          UUID nodeId,
                          @Nullable
                          GridCacheVersion nearXidVer,
                          long threadId,
                          IgniteUuid futId,
                          GridCacheVersion lockVer,
                          boolean isInTx,
                          boolean isRead,
                          TransactionIsolation isolation,
                          boolean isInvalidate,
                          long timeout,
                          int keyCnt,
                          int txSize,
                          @Nullable
                          IgniteTxKey grpLockKey,
                          boolean partLock)

Parameters:

nodeId - Node ID.

nearXidVer - Near transaction ID.

threadId - Thread ID.

futId - Future ID.

lockVer - Cache version.

isInTx - True if implicit transaction lock.

isRead - Indicates whether implicit lock is for read or write operation.

isolation - Transaction isolation.

isInvalidate - Invalidation flag.

timeout - Lock timeout.

keyCnt - Number of keys.

txSize - Expected transaction size.

grpLockKey - Group lock key if this is a group-lock transaction.

partLock - True if this is a group-lock transaction request and whole partition is locked.

Method Detail

nodeId

public UUID nodeId()

Returns:

Node ID.

nearXidVersion

public GridCacheVersion nearXidVersion()

Returns:

Near transaction ID.

threadId

public long threadId()

Returns:

Owner node thread ID.

futureId

public IgniteUuid futureId()

Returns:

Future ID.

inTx

public boolean inTx()

Returns:

True if implicit transaction lock.

isInvalidate

public boolean isInvalidate()

Returns:

Invalidate flag.

txRead

public boolean txRead()

Returns:

True if lock is implicit and for a read operation.

returnValue

public boolean returnValue(int idx)

Parameters:

idx - Key index.

Returns:

Flag indicating whether a value should be returned.

returnFlags

public boolean[] returnFlags()

Returns:

Return flags.

isolation

public TransactionIsolation isolation()

Returns:

Transaction isolation or null if not in transaction.

keyBytes

public List<byte[]> keyBytes()

Returns:

Key to lock.

txSize

public int txSize()

Returns:

Tx size.

addKeyBytes

public void addKeyBytes(K key,
               @Nullable
               byte[] keyBytes,
               boolean retVal,
               @Nullable
               Collection<GridCacheMvccCandidate<K>> cands,
               GridCacheContext<K,V> ctx)
                 throws IgniteCheckedException

Adds a key.

Parameters:

key - Key.

retVal - Flag indicating whether value should be returned.

keyBytes - Key bytes.

cands - Candidates.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

keys

public List<K> keys()

Returns:

Unmarshalled keys.

groupLock

public boolean groupLock()

Returns:

True if lock request for group-lock transaction.

groupLockKey

@Nullable
public IgniteTxKey groupLockKey()

Returns:

Group lock key.

partitionLock

public boolean partitionLock()

Returns:

True if partition is locked in group-lock transaction.

timeout

public long timeout()

Returns:

Max lock wait time.

prepareMarshal

public void prepareMarshal(GridCacheSharedContext<K,V> ctx)
                    throws IgniteCheckedException

This method is called before the whole message is serialized and is responsible for pre-marshalling state.

Overrides:

prepareMarshal in class GridDistributedBaseMessage<K,V>

Parameters:

ctx -

Throws:

IgniteCheckedException - If failed.

finishUnmarshal

public void finishUnmarshal(GridCacheSharedContext<K,V> ctx,
                   ClassLoader ldr)
                     throws IgniteCheckedException

This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheSharedContext) method.

Overrides:

finishUnmarshal in class GridDistributedBaseMessage<K,V>

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

writeTo

public boolean writeTo(ByteBuffer buf,
              MessageWriter writer)

Writes this message to provided byte buffer.

Overrides:

writeTo in class GridDistributedBaseMessage<K,V>

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf)

Reads this message from provided byte buffer.

Overrides:

readFrom in class GridDistributedBaseMessage<K,V>

Parameters:

buf - Byte buffer.

Returns:

Whether message was fully read.

directType

public byte directType()

Gets message type.

Specified by:

directType in class MessageAdapter

Returns:

Message type.

toString

public String toString()

Overrides:

toString in class GridDistributedBaseMessage<K,V>