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

Class GridDistributedLockRequest<K,V>

java.lang.Object

org.gridgain.grid.util.direct.GridTcpCommunicationMessageAdapter

org.gridgain.grid.kernal.processors.cache.GridCacheMessage<K,V>

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

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

All Implemented Interfaces:

Serializable, Cloneable, GridCacheDeployable, GridCacheVersionable

Direct Known Subclasses:

GridDhtLockRequest, GridNearLockRequest

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

Lock request message.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedBaseMessage

ver

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheMessage

CACHE_MSG_INDEX_FIELD_NAME, MAX_CACHE_MSG_LOOKUP_INDEX

Fields inherited from class org.gridgain.grid.util.direct.GridTcpCommunicationMessageAdapter

BIT_SET_NOT_READ, BOOLEAN_ARR_NOT_READ, BYTE_ARR_LIST_NOT_READ, BYTE_ARR_NOT_READ, CACHE_VER_NOT_READ, CHAR_ARR_NOT_READ, CLOCK_DELTA_VER_NOT_READ, commState, DHT_PART_EXCHANGE_ID_NOT_READ, DOUBLE_ARR_NOT_READ, DR_INT_REQ_ENTRY_NOT_READ, ENUM_NOT_READ, FLOAT_ARR_NOT_READ, GRID_UUID_NOT_READ, INT_ARR_NOT_READ, LONG_ARR_NOT_READ, LONG_LIST_NOT_READ, MSG_NOT_READ, NULL, SHORT_ARR_NOT_READ, STR_NOT_READ, UUID_NOT_READ, VAL_BYTES_NOT_READ

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyBytes(K key, byte[] keyBytes, GridCacheTxEntry<K,V> writeEntry, boolean retVal, Collection<GridCacheMvccCandidate<K>> cands, GridCacheVersion drVer, GridCacheContext<K,V> ctx) Adds a key.
GridTcpCommunicationMessageAdapter	clone()
protected void	clone0(GridTcpCommunicationMessageAdapter _msg) Clones all fields of the provided message to this.
byte	directType()
GridCacheVersion	drVersionByIndex(int idx)
void	drVersionByIndex(int idx, GridCacheVersion drVer)
GridCacheVersion[]	drVersions()
void	finishUnmarshal(GridCacheContext<K,V> ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheContext) method.
GridUuid	futureId()
boolean	groupLock()
Object	groupLockKey()
boolean	inTx()
boolean	isInvalidate()
GridCacheTxIsolation	isolation()
List<byte[]>	keyBytes()
List<K>	keys()
GridCacheVersion	nearXidVersion()
UUID	nodeId()
boolean	partitionLock()
void	prepareMarshal(GridCacheContext<K,V> ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
boolean	readFrom(ByteBuffer buf)
boolean[]	returnFlags()
boolean	returnValue(int idx)
long	threadId()
long	timeout()
String	toString()
boolean	txRead()
int	txSize()
List<GridCacheTxEntry<K,V>>	writeEntries()
boolean	writeTo(ByteBuffer buf)

Methods inherited from class org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedBaseMessage

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

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheMessage

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

Methods inherited from class org.gridgain.grid.util.direct.GridTcpCommunicationMessageAdapter

arrayIterator, messageReader, messageWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.kernal.processors.cache.GridCacheDeployable

deployInfo, prepare

Field Detail

idx

protected int idx

Key-bytes index.

Constructor Detail

GridDistributedLockRequest

public GridDistributedLockRequest()

Empty constructor.

GridDistributedLockRequest

public GridDistributedLockRequest(UUID nodeId,
                          @Nullable
                          GridCacheVersion nearXidVer,
                          long threadId,
                          GridUuid futId,
                          GridCacheVersion lockVer,
                          boolean isInTx,
                          boolean isRead,
                          GridCacheTxIsolation isolation,
                          boolean isInvalidate,
                          long timeout,
                          int keyCnt,
                          int txSize,
                          @Nullable
                          Object 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 GridUuid 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 GridCacheTxIsolation isolation()

Returns:

Transaction isolation or null if not in transaction.

keyBytes

public List<byte[]> keyBytes()

Returns:

Key to lock.

writeEntries

public List<GridCacheTxEntry<K,V>> writeEntries()

Returns:

Write entries list.

txSize

public int txSize()

Returns:

Tx size.

addKeyBytes

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

Adds a key.

Parameters:

key - Key.

retVal - Flag indicating whether value should be returned.

keyBytes - Key bytes.

writeEntry - Write entry.

cands - Candidates.

drVer - DR version.

ctx - Context.

Throws:

GridException - 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 Object 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.

drVersionByIndex

public void drVersionByIndex(int idx,
                    GridCacheVersion drVer)

Parameters:

idx - Key index.

drVer - DR version.

drVersionByIndex

public GridCacheVersion drVersionByIndex(int idx)

Parameters:

idx - Key index.

Returns:

DR versions for given key.

drVersions

public GridCacheVersion[] drVersions()

Returns:

All DR versions.

prepareMarshal

public void prepareMarshal(GridCacheContext<K,V> ctx)
                    throws GridException

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 - Cache context.

Throws:

GridException - If failed.

finishUnmarshal

public void finishUnmarshal(GridCacheContext<K,V> ctx,
                   ClassLoader ldr)
                     throws GridException

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

Overrides:

finishUnmarshal in class GridDistributedBaseMessage<K,V>

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

GridException - If failed.

clone

public GridTcpCommunicationMessageAdapter clone()

Specified by:

clone in class GridTcpCommunicationMessageAdapter

clone0

protected void clone0(GridTcpCommunicationMessageAdapter _msg)

Clones all fields of the provided message to this.

Overrides:

clone0 in class GridDistributedBaseMessage<K,V>

Parameters:

_msg - Message to clone from.

writeTo

public boolean writeTo(ByteBuffer buf)

Overrides:

writeTo in class GridDistributedBaseMessage<K,V>

Parameters:

buf - Byte buffer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf)

Overrides:

readFrom in class GridDistributedBaseMessage<K,V>

Parameters:

buf - Byte buffer.

Returns:

Whether message was fully read.

directType

public byte directType()

Specified by:

directType in class GridTcpCommunicationMessageAdapter

Returns:

Message type.

toString

public String toString()

Overrides:

toString in class GridDistributedBaseMessage<K,V>