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

Class GridDistributedBaseMessage

java.lang.Object

org.apache.ignite.internal.processors.cache.GridCacheMessage

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

All Implemented Interfaces:

Serializable, GridCacheDeployable, GridCacheVersionable, Message

Direct Known Subclasses:

GridCacheOptimisticCheckPreparedTxRequest, GridCacheOptimisticCheckPreparedTxResponse, GridDistributedLockRequest, GridDistributedLockResponse, GridDistributedTxFinishRequest, GridDistributedTxPrepareRequest, GridDistributedTxPrepareResponse, GridDistributedUnlockRequest

public abstract class GridDistributedBaseMessage
extends GridCacheMessage
implements GridCacheDeployable, GridCacheVersionable

Base for all messages in replicated cache.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected GridCacheVersion	ver Lock or transaction version.

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

CACHE_MSG_INDEX_FIELD_NAME, cacheId, MAX_CACHE_MSG_LOOKUP_INDEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridDistributedBaseMessage() Empty constructor required by Externalizable
protected	GridDistributedBaseMessage(GridCacheVersion ver, int cnt)
protected	GridDistributedBaseMessage(int cnt)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<GridCacheMvccCandidate>	candidatesByIndex(int idx)
void	candidatesByIndex(int idx, Collection<GridCacheMvccCandidate> candsByIdx)
Map<KeyCacheObject,Collection<GridCacheMvccCandidate>>	candidatesByKey()
Collection<GridCacheMvccCandidate>	candidatesByKey(KeyCacheObject key)
void	candidatesByKey(KeyCacheObject key, Collection<GridCacheMvccCandidate> candsByKey)
Collection<GridCacheVersion>	committedVersions()
void	completedVersions(Collection<GridCacheVersion> committedVers, Collection<GridCacheVersion> rolledbackVers)
void	finishUnmarshal(GridCacheSharedContext ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheSharedContext) method.
int	keysCount()
void	prepareMarshal(GridCacheSharedContext ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
boolean	readFrom(ByteBuffer buf, MessageReader reader) Reads this message from provided byte buffer.
Collection<GridCacheVersion>	rolledbackVersions()
String	toString()
GridCacheVersion	version()
void	version(GridCacheVersion ver)
boolean	writeTo(ByteBuffer buf, MessageWriter writer) Writes this message to provided byte buffer.

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

allowForStartup, cacheId, cacheId, classError, deployInfo, finishUnmarshalCacheObjects, finishUnmarshalCacheObjects, ignoreClassErrors, lookupIndex, marshalBooleanLinkedMap, marshalCollection, marshalInfo, marshalInfos, marshalInvokeArguments, marshalTx, messageId, nextIndexId, onClassError, prepare, prepareMarshalCacheObjects, prepareMarshalCacheObjects, prepareObject, topologyVersion, transferExpiryPolicy, unmarshalBooleanLinkedMap, unmarshalCollection, unmarshalInfo, unmarshalInfos, unmarshalInvokeArguments, unmarshalTx

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

Methods inherited from interface org.apache.ignite.plugin.extensions.communication.Message

directType, fieldsCount

Field Detail

ver

@GridToStringInclude
protected GridCacheVersion ver

Lock or transaction version.

Constructor Detail

GridDistributedBaseMessage

protected GridDistributedBaseMessage()

Empty constructor required by Externalizable

GridDistributedBaseMessage

protected GridDistributedBaseMessage(int cnt)

Parameters:

cnt - Count of keys references in list of candidates.

GridDistributedBaseMessage

protected GridDistributedBaseMessage(GridCacheVersion ver,
                          int cnt)

Parameters:

ver - Either lock or transaction version.

cnt - Key count.

Method Detail

prepareMarshal

public void prepareMarshal(GridCacheSharedContext ctx)
                    throws IgniteCheckedException

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

Overrides:

prepareMarshal in class GridCacheMessage

Parameters:

ctx -

Throws:

IgniteCheckedException - If failed.

finishUnmarshal

public void finishUnmarshal(GridCacheSharedContext 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 GridCacheMessage

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

version

public GridCacheVersion version()

Specified by:

version in interface GridCacheVersionable

Returns:

Version.

version

public void version(GridCacheVersion ver)

Parameters:

ver - Version.

completedVersions

public void completedVersions(Collection<GridCacheVersion> committedVers,
                     Collection<GridCacheVersion> rolledbackVers)

Parameters:

committedVers - Committed versions.

rolledbackVers - Rolled back versions.

committedVersions

public Collection<GridCacheVersion> committedVersions()

Returns:

Committed versions.

rolledbackVersions

public Collection<GridCacheVersion> rolledbackVersions()

Returns:

Rolled back versions.

candidatesByIndex

public void candidatesByIndex(int idx,
                     Collection<GridCacheMvccCandidate> candsByIdx)

Parameters:

idx - Key index.

candsByIdx - List of candidates for that key.

candidatesByIndex

public Collection<GridCacheMvccCandidate> candidatesByIndex(int idx)

Parameters:

idx - Key index.

Returns:

Candidates for given key.

candidatesByKey

public void candidatesByKey(KeyCacheObject key,
                   Collection<GridCacheMvccCandidate> candsByKey)

Parameters:

key - Candidates key.

candsByKey - Collection of local candidates.

candidatesByKey

@Nullable
public Collection<GridCacheMvccCandidate> candidatesByKey(KeyCacheObject key)

Parameters:

key - Candidates key.

Returns:

Collection of lock candidates at given index.

candidatesByKey

public Map<KeyCacheObject,Collection<GridCacheMvccCandidate>> candidatesByKey()

Returns:

Map of candidates.

keysCount

public int keysCount()

Returns:

Count of keys referenced in candidates array (needed only locally for optimization).

writeTo

public boolean writeTo(ByteBuffer buf,
              MessageWriter writer)

Writes this message to provided byte buffer.

Specified by:

writeTo in interface Message

Overrides:

writeTo in class GridCacheMessage

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf,
               MessageReader reader)

Reads this message from provided byte buffer.

Specified by:

readFrom in interface Message

Overrides:

readFrom in class GridCacheMessage

Parameters:

buf - Byte buffer.

reader - Reader.

Returns:

Whether message was fully read.

toString

public String toString()

Overrides:

toString in class GridCacheMessage