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 Description static byte
COMMAND_ID
-
Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand
cacheName
-
-
Constructor Summary
Constructors Constructor Description XSiteStatePushCommand()
XSiteStatePushCommand(ByteString cacheName)
XSiteStatePushCommand(ByteString cacheName, XSiteState[] chunk, long timeoutMillis)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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()
void
initialize(XSiteStateConsumer consumer)
CompletableFuture<Object>
invokeAsync()
Invoke the command asynchronously.boolean
isReturnValueExpected()
If true, a return value will be provided when performed remotely.Object
performInLocalSite(BackupReceiver receiver)
void
readFrom(ObjectInput input)
Reads this instance from the stream written byReplicableCommand.writeTo(ObjectOutput)
.String
toString()
void
writeTo(ObjectOutput output)
Writes this instance to theObjectOutput
.-
Methods inherited from class org.infinispan.xsite.XSiteReplicateCommand
getOriginSite, 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, isSuccessful, perform
-
-
-
-
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 Object performInLocalSite(BackupReceiver receiver) throws Throwable
- Specified by:
performInLocalSite
in classXSiteReplicateCommand
- Throws:
Throwable
-
initialize
public void initialize(XSiteStateConsumer consumer)
-
getChunk
public XSiteState[] getChunk()
-
getTimeout
public long getTimeout()
-
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 andReplicableCommand.perform(InvocationContext)
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.- 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 theObjectOutput
.- 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 byReplicableCommand.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 remoteResponseGenerator
may choose to simply return null to save on marshalling costs.- 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 interfaceReplicableCommand
- Overrides:
canBlock
in classBaseRpcCommand
- Returns:
true
if the command can block/wait,false
otherwise
-
toString
public String toString()
- Overrides:
toString
in classBaseRpcCommand
-
-