org.infinispan.xsite.statetransfer

Class XSiteStatePushCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.xsite.XSiteReplicateCommand

org.infinispan.xsite.statetransfer.XSiteStatePushCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class XSiteStatePushCommand
extends XSiteReplicateCommand

Wraps the state to be sent to another site

Since:

7.0

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.xsite.XSiteReplicateCommand

originSite

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

cacheName, origin

Constructor Summary

Constructors

Constructor and Description
XSiteStatePushCommand()
XSiteStatePushCommand(ByteString cacheName)
XSiteStatePushCommand(ByteString cacheName, XSiteState[] chunk, long timeoutMillis)

Method Summary

Modifier and Type	Method and Description
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
XSiteState[]	getChunk()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
long	getTimeout()
CompletionStage<?>	invokeAsync(ComponentRegistry componentRegistry) Invoke the command asynchronously.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
CompletionStage<Void>	performInLocalSite(BackupReceiver receiver, boolean preserveOrder)
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.xsite.XSiteReplicateCommand

setOriginSite

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, invokeAsync, isSuccessful

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

XSiteStatePushCommand

public XSiteStatePushCommand(ByteString cacheName,
                             XSiteState[] chunk,
                             long timeoutMillis)

XSiteStatePushCommand

public XSiteStatePushCommand(ByteString cacheName)

XSiteStatePushCommand

public XSiteStatePushCommand()

Method Detail

performInLocalSite

public CompletionStage<Void> performInLocalSite(BackupReceiver receiver,
                                                boolean preserveOrder)

Specified by:

performInLocalSite in class XSiteReplicateCommand

getChunk

public XSiteState[] getChunk()

getTimeout

public long getTimeout()

invokeAsync

public CompletionStage<?> invokeAsync(ComponentRegistry componentRegistry)
                               throws Throwable

Description copied from interface: CacheRpcCommand

Invoke the command asynchronously.

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

Throws:

Throwable

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

Overrides:

getCommandId in class XSiteReplicateCommand

Returns:

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

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

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).

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.

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

Overrides:

isReturnValueExpected in class XSiteReplicateCommand

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.

Returns:

true if the command can block/wait, false otherwise

toString

public String toString()

Overrides:

toString in class BaseRpcCommand