Package org.infinispan.stream.impl

Class StreamIteratorRequestCommand<K>

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.stream.impl.StreamIteratorNextCommand

org.infinispan.stream.impl.StreamIteratorRequestCommand<K>

Type Parameters:

K - the key type

All Implemented Interfaces:

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

public class StreamIteratorRequestCommand<K>
extends StreamIteratorNextCommand

Stream request command that is sent to remote nodes handle execution of remote intermediate and terminal operations.

Field Summary

Fields

Modifier and Type	Field	Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.stream.impl.StreamIteratorNextCommand

batchSize, id, lsm, topologyId

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

cacheName

Constructor Summary

Constructors

Constructor	Description
StreamIteratorRequestCommand(ByteString cacheName)
StreamIteratorRequestCommand(ByteString cacheName, Address origin, Object id, boolean parallelStream, org.infinispan.commons.util.IntSet segments, Set<K> keys, Set<K> excludedKeys, boolean includeLoader, boolean entryStream, Iterable<org.infinispan.stream.impl.intops.IntermediateOperation> intOps, long batchSize)

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.
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 org.infinispan.stream.impl.StreamIteratorNextCommand

getId, getTopologyId, inject, setTopologyId

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

getCacheName, getOrigin, setOrigin, toString

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

StreamIteratorRequestCommand

public StreamIteratorRequestCommand(ByteString cacheName)

StreamIteratorRequestCommand

public StreamIteratorRequestCommand(ByteString cacheName,
                                    Address origin,
                                    Object id,
                                    boolean parallelStream,
                                    org.infinispan.commons.util.IntSet segments,
                                    Set<K> keys,
                                    Set<K> excludedKeys,
                                    boolean includeLoader,
                                    boolean entryStream,
                                    Iterable<org.infinispan.stream.impl.intops.IntermediateOperation> intOps,
                                    long batchSize)

Method Detail

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

Overrides:

invokeAsync in class StreamIteratorNextCommand

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 StreamIteratorNextCommand

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.

Specified by:

writeTo in interface ReplicableCommand

Overrides:

writeTo in class StreamIteratorNextCommand

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

Overrides:

readFrom in class StreamIteratorNextCommand

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 StreamIteratorNextCommand

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 StreamIteratorNextCommand

Returns:

true if the command can block/wait, false otherwise