org.infinispan.manager.impl

Class ReplicableManagerFunctionCommand

java.lang.Object

org.infinispan.manager.impl.ReplicableManagerFunctionCommand

All Implemented Interfaces:

ReplicableCommand

public class ReplicableManagerFunctionCommand
extends Object
implements ReplicableCommand

Replicable Command that runs the given Function passing the EmbeddedCacheManager as an argument

Since:

8.2

Author:

wburns

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Constructor Summary

Constructors

Constructor and Description
ReplicableManagerFunctionCommand()
ReplicableManagerFunctionCommand(Function<? super EmbeddedCacheManager,?> function)

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.
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
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	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.ReplicableCommand

invoke, isSuccessful, setOrigin

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

ReplicableManagerFunctionCommand

public ReplicableManagerFunctionCommand()

ReplicableManagerFunctionCommand

public ReplicableManagerFunctionCommand(Function<? super EmbeddedCacheManager,?> function)

Method Detail

invokeAsync

public CompletableFuture<Object> invokeAsync()
                                      throws Throwable

Description copied from interface: ReplicableCommand

Invoke the command asynchronously.

Specified by:

invokeAsync in interface ReplicableCommand

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

Returns:

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

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.

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.

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

Returns:

true if the command can block/wait, false otherwise