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

Class GridNearSingleGetRequest

java.lang.Object

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

org.apache.ignite.internal.processors.cache.GridCacheIdMessage

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

All Implemented Interfaces:

Serializable, GridCacheDeployable, Message

public class GridNearSingleGetRequest
extends GridCacheIdMessage
implements GridCacheDeployable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	RECOVERY_FLAG_MASK

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

cacheId

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

addDepInfo, CACHE_MSG_INDEX_FIELD_NAME, forceAddDepInfo, MAX_CACHE_MSG_LOOKUP_INDEX

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

DIRECT_TYPE_SIZE

Constructor Summary

Constructors

Constructor	Description
GridNearSingleGetRequest()	Empty constructor required for Message.
GridNearSingleGetRequest(int cacheId, long futId, KeyCacheObject key, boolean readThrough, @NotNull AffinityTopologyVersion topVer, int taskNameHash, long createTtl, long accessTtl, boolean skipVals, boolean addReader, boolean needVer, boolean addDepInfo, boolean recovery, @Nullable String txLbl)

Method Summary

Modifier and Type	Method	Description
long	accessTtl()
boolean	addDeploymentInfo()	Deployment enabled flag indicates whether deployment info has to be added to this message.
boolean	addReader()
long	createTtl()
short	directType()	Gets message type.
byte	fieldsCount()	Gets fields count.
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.
long	futureId()
KeyCacheObject	key()
boolean	needEntryInfo()
boolean	needVersion()
int	partition()
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.
boolean	readThrough()
boolean	recovery()
boolean	skipValues()
int	taskNameHash()	Gets task name hash.
AffinityTopologyVersion	topologyVersion()	Gets topology version or -1 in case of topology version is not required for this message.
String	toString()
@Nullable String	txLabel()	Get transaction label (may be null).
boolean	writeTo(ByteBuffer buf, MessageWriter writer)	Writes this message to provided byte buffer.

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

cacheGroupMessage, cacheId, cacheId, handlerId

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

appendFlag, classError, deployInfo, error, finishUnmarshalCacheObjects, finishUnmarshalCacheObjects, ignoreClassErrors, lastAffinityChangedTopologyVersion, lastAffinityChangedTopologyVersion, lookupIndex, marshalCollection, marshalInfo, marshalInfos, marshalInvokeArguments, marshalTx, messageId, messageLogger, nextIndexId, onAckReceived, onClassError, partitionExchangeMessage, prepare, prepareMarshalCacheObject, prepareMarshalCacheObjects, prepareMarshalCacheObjects, prepareObject, prepareObject, transferExpiryPolicy, 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

Field Detail

RECOVERY_FLAG_MASK

public static final int RECOVERY_FLAG_MASK

See Also:

Constant Field Values

Constructor Detail

GridNearSingleGetRequest

public GridNearSingleGetRequest()

Empty constructor required for Message.

GridNearSingleGetRequest

public GridNearSingleGetRequest(int cacheId,
                                long futId,
                                KeyCacheObject key,
                                boolean readThrough,
                                @NotNull
                                @NotNull AffinityTopologyVersion topVer,
                                int taskNameHash,
                                long createTtl,
                                long accessTtl,
                                boolean skipVals,
                                boolean addReader,
                                boolean needVer,
                                boolean addDepInfo,
                                boolean recovery,
                                @Nullable
                                @Nullable String txLbl)

Parameters:

cacheId - Cache ID.

futId - Future ID.

key - Key.

readThrough - Read through flag.

skipVals - Skip values flag. When false, only boolean values will be returned indicating whether cache entry has a value.

topVer - Topology version.

taskNameHash - Task name hash.

createTtl - New TTL to set after entry is created, -1 to leave unchanged.

accessTtl - New TTL to set after entry is accessed, -1 to leave unchanged.

addReader - Add reader flag.

needVer - True if entry version is needed.

addDepInfo - Deployment info.

txLbl - Transaction label.

Method Detail

key

public KeyCacheObject key()

Returns:

Key.

futureId

public long futureId()

Returns:

Future ID.

taskNameHash

public int taskNameHash()

Gets task name hash.

Returns:

Task name hash.

topologyVersion

public AffinityTopologyVersion topologyVersion()

Description copied from class: GridCacheMessage

Gets topology version or -1 in case of topology version is not required for this message.

Overrides:

topologyVersion in class GridCacheMessage

Returns:

Topology version.

createTtl

public long createTtl()

Returns:

New TTL to set after entry is created, -1 to leave unchanged.

accessTtl

public long accessTtl()

Returns:

New TTL to set after entry is accessed, -1 to leave unchanged.

partition

public int partition()

Overrides:

partition in class GridCacheMessage

Returns:

Partition ID this message is targeted to or -1 if it cannot be determined.

txLabel

@Nullable
public @Nullable String txLabel()

Get transaction label (may be null).

Returns:

Transaction label;

readThrough

public boolean readThrough()

Returns:

Read through flag.

skipValues

public boolean skipValues()

Returns:

Read through flag.

addReader

public boolean addReader()

Returns:

Add reader flag.

needVersion

public boolean needVersion()

Returns:

True if entry version is needed.

needEntryInfo

public boolean needEntryInfo()

Returns:

True if full entry information is needed.

recovery

public boolean recovery()

Returns:

True if recovery flag is set.

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

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.

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 GridCacheIdMessage

Parameters:

buf - Byte buffer.

reader - Reader.

Returns:

Whether message was fully read.

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 GridCacheIdMessage

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

addDeploymentInfo

public boolean addDeploymentInfo()

Deployment enabled flag indicates whether deployment info has to be added to this message.

Specified by:

addDeploymentInfo in class GridCacheMessage

Returns:

true or if deployment info must be added to the the message, false otherwise.

directType

public short directType()

Gets message type.

Specified by:

directType in interface Message

Returns:

Message type.

fieldsCount

public byte fieldsCount()

Gets fields count.

Specified by:

fieldsCount in interface Message

Overrides:

fieldsCount in class GridCacheIdMessage

Returns:

Fields count.

toString

public String toString()

Overrides:

toString in class GridCacheIdMessage