Package org.infinispan.statetransfer

Class StateResponseCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.statetransfer.StateResponseCommand

All Implemented Interfaces:

org.infinispan.commands.remote.CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand

public class StateResponseCommand
extends org.infinispan.commands.remote.BaseRpcCommand
implements TopologyAffectedCommand

This command is used by a StateProvider to push cache entries to a StateConsumer.

Since:

5.2

Author:

anistor@redhat.com

Field Summary

Fields

Modifier and Type	Field	Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand

cacheName

Constructor Summary

Constructors

Constructor	Description
StateResponseCommand(ByteString cacheName)
StateResponseCommand(ByteString cacheName, Address origin, int topologyId, Collection<StateChunk> stateChunks, boolean applyState, boolean pushTransfer)

Method Summary

Modifier and Type	Method	Description
boolean	canBlock()	If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
byte	getCommandId()	Used by marshallers to convert this command into an id for streaming.
Collection<StateChunk>	getStateChunks()
int	getTopologyId()
void	init(StateConsumer stateConsumer, StateReceiver stateReceiver)
CompletableFuture<Object>	invokeAsync()	Invoke the command asynchronously.
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
void	readFrom(ObjectInput input)	Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setTopologyId(int topologyId)
String	toString()
void	writeTo(ObjectOutput output)	Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.remote.BaseRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.ReplicableCommand

invoke, isSuccessful, perform

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

StateResponseCommand

public StateResponseCommand(ByteString cacheName)

StateResponseCommand

public StateResponseCommand(ByteString cacheName,
                            Address origin,
                            int topologyId,
                            Collection<StateChunk> stateChunks,
                            boolean applyState,
                            boolean pushTransfer)

Method Detail

init

public void init(StateConsumer stateConsumer,
                 StateReceiver stateReceiver)

invokeAsync

public CompletableFuture<Object> invokeAsync()
                                      throws Throwable

Description copied from interface: ReplicableCommand

Invoke the command asynchronously.

This method replaces ReplicableCommand.perform(InvocationContext) for remote execution. The default implementation and ReplicableCommand.perform(InvocationContext) will be removed in future versions.

Specified by:

invokeAsync in interface ReplicableCommand

Throws:

Throwable

isReturnValueExpected

public boolean isReturnValueExpected()

Description copied from interface: ReplicableCommand

If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Returns:

true or false

canBlock

public boolean canBlock()

Description copied from interface: ReplicableCommand

If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool. Otherwise, the command is processed directly in the JGroups thread.

This feature allows to avoid keep a JGroups thread busy that can originate discard of messages and retransmissions. So, the commands that can block (waiting for some state, acquiring locks, etc.) should return true.

Specified by:

canBlock in interface ReplicableCommand

Overrides:

canBlock in class org.infinispan.commands.remote.BaseRpcCommand

Returns:

true if the command can block/wait, false otherwise

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

Used by marshallers to convert this command into an id for streaming.

Specified by:

getCommandId in interface ReplicableCommand

Returns:

the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

getStateChunks

public Collection<StateChunk> getStateChunks()

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

Specified by:

writeTo in interface ReplicableCommand

Parameters:

output - the stream.

Throws:

IOException - if an error occurred during the I/O.

readFrom

public void readFrom(ObjectInput input)
              throws IOException,
                     ClassNotFoundException

Description copied from interface: ReplicableCommand

Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).

Specified by:

readFrom in interface ReplicableCommand

Parameters:

input - the stream to read.

Throws:

IOException - if an error occurred during the I/O.

ClassNotFoundException - if it tries to load an undefined class.

toString

public String toString()

Overrides:

toString in class org.infinispan.commands.remote.BaseRpcCommand