org.infinispan.stream.impl

Class StreamResponseCommand<R>

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.stream.impl.StreamResponseCommand<R>

Type Parameters:

R - the response type

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

Direct Known Subclasses:

StreamSegmentResponseCommand

public class StreamResponseCommand<R>
extends BaseRpcCommand

Stream response command used to handle returning intermediate or final responses from the remote node

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID
protected boolean	complete
protected ClusterStreamManager	csm
protected Object	id
protected R	response

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

cacheName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamResponseCommand()
	StreamResponseCommand(String cacheName)
	StreamResponseCommand(String cacheName, Address origin, Object id, boolean complete, R response)

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.
void	inject(ClusterStreamManager csm)
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
Object	perform(InvocationContext ctx) Performs the primary function of the command.
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.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

getParameters, setParameters

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

csm

protected ClusterStreamManager csm

id

protected Object id

complete

protected boolean complete

response

protected R response

Constructor Detail

StreamResponseCommand

protected StreamResponseCommand()

StreamResponseCommand

public StreamResponseCommand(String cacheName)

StreamResponseCommand

public StreamResponseCommand(String cacheName,
                             Address origin,
                             Object id,
                             boolean complete,
                             R response)

Method Detail

inject

public void inject(ClusterStreamManager csm)

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Description copied from interface: ReplicableCommand

Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

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

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 BaseRpcCommand

Returns:

true if the command can block/wait, false otherwise