Package org.infinispan.commands

Class CancelCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.CancelCommand

All Implemented Interfaces:

org.infinispan.commands.remote.CacheRpcCommand, ReplicableCommand

public class CancelCommand
extends org.infinispan.commands.remote.BaseRpcCommand

Command to cancel commands executing in remote VM

Since:

5.2

Author:

Vladimir Blagojevic

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
CancelCommand(ByteString ownerCacheName)
CancelCommand(ByteString ownerCacheName, UUID commandToCancel)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
byte	getCommandId()	Used by marshallers to convert this command into an id for streaming.
int	hashCode()
void	init(CancellationService service)
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).
String	toString()
void	writeTo(ObjectOutput output)	Writes this instance to the ObjectOutput.

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

canBlock, getCacheName, getOrigin, setOrigin

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

CancelCommand

public CancelCommand(ByteString ownerCacheName)

CancelCommand

public CancelCommand(ByteString ownerCacheName,
                     UUID commandToCancel)

Method Detail

init

public void init(CancellationService service)

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.

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

Returns:

true or false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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