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

Class GridDhtForceKeysRequest

java.lang.Object

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

org.apache.ignite.internal.processors.cache.distributed.dht.preloader.GridDhtForceKeysRequest

All Implemented Interfaces:

Serializable, GridCacheDeployable, Message

public class GridDhtForceKeysRequest
extends GridCacheMessage
implements GridCacheDeployable

Force keys request. This message is sent by node while preloading to force another node to put given keys into the next batch of transmitting entries.

See Also:

Serialized Form

Field Summary

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

Constructor and Description
GridDhtForceKeysRequest() Required by Externalizable.
GridDhtForceKeysRequest(Collection<KeyCacheObject> keys)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowForStartup()
byte	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.
IgniteUuid	futureId()
Collection<KeyCacheObject>	keys()
IgniteUuid	miniId()
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.
AffinityTopologyVersion	topologyVersion() Gets topology version or -1 in case of topology version is not required for this message.
String	toString()
boolean	writeTo(ByteBuffer buf, MessageWriter writer) Writes this message to provided byte buffer.

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

cacheId, cacheId, classError, deployInfo, finishUnmarshalCacheObjects, finishUnmarshalCacheObjects, ignoreClassErrors, lookupIndex, marshalCollection, marshalInfo, marshalInfos, marshalInvokeArguments, marshalTx, messageId, nextIndexId, onClassError, partitionExchangeMessage, prepare, prepareMarshalCacheObjects, prepareMarshalCacheObjects, 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

Constructor Detail

GridDhtForceKeysRequest

public GridDhtForceKeysRequest()

Required by Externalizable.

GridDhtForceKeysRequest

public GridDhtForceKeysRequest(Collection<KeyCacheObject> keys)

Parameters:

keys - Collection of keys.

Method Detail

allowForStartup

public boolean allowForStartup()

Overrides:

allowForStartup in class GridCacheMessage

Returns:

True if this message is preloader message.

futureId

public IgniteUuid futureId()

Returns:

Future ID.

miniId

public IgniteUuid miniId()

Returns:

Mini-future ID.

keys

public Collection<KeyCacheObject> keys()

Returns:

Keys.

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 for which keys are requested.

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.

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.

directType

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

Returns:

Fields count.

toString

public String toString()

Overrides:

toString in class GridCacheMessage