org.infinispan.remoting.rpc

Interface RpcManager

All Known Implementing Classes:

RpcManagerImpl

public interface RpcManager

Provides a mechanism for communicating with other caches in the cluster, by formatting and passing requests down to the registered Transport.

Since:

4.0

Author:

Manik Surtani, Mircea.Markus@jboss.com

Method Summary

Modifier and Type	Method and Description
void	broadcastRpcCommand(ReplicableCommand rpc, boolean sync) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
void	broadcastRpcCommand(ReplicableCommand rpc, boolean sync, boolean usePriorityQueue) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
void	broadcastRpcCommandInFuture(ReplicableCommand rpc, boolean usePriorityQueue, NotifyingNotifiableFuture<Object> future) Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)
void	broadcastRpcCommandInFuture(ReplicableCommand rpc, NotifyingNotifiableFuture<Object> future) Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)
Address	getAddress() Returns the address associated with this RpcManager or null if not part of the cluster.
RpcOptions	getDefaultRpcOptions(boolean sync) See getDefaultRpcOptions(boolean, boolean).
RpcOptions	getDefaultRpcOptions(boolean sync, boolean fifoOrder) Builds a RpcOptions based on the parameters
List<Address>	getMembers() Returns members of a cluster scoped to the cache owning this RpcManager.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode) This method is equivalent to getRpcOptionsBuilder(responseMode, true)
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode, boolean fifoOrder)
int	getTopologyId() Returns the current topology id.
Transport	getTransport()
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpc, boolean sync) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpc, boolean sync, boolean usePriorityQueue) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, boolean usePriorityQueue) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, boolean usePriorityQueue, ResponseFilter responseFilter) Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options) Invokes an RPC call on other caches in the cluster.
void	invokeRemotelyInFuture(Collection<Address> recipients, ReplicableCommand rpc, boolean usePriorityQueue, NotifyingNotifiableFuture<Object> future) Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)
void	invokeRemotelyInFuture(Collection<Address> recipients, ReplicableCommand rpc, boolean usePriorityQueue, NotifyingNotifiableFuture<Object> future, long timeout) Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)
void	invokeRemotelyInFuture(Collection<Address> recipients, ReplicableCommand rpc, boolean usePriorityQueue, NotifyingNotifiableFuture<Object> future, long timeout, boolean ignoreLeavers) Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)
void	invokeRemotelyInFuture(Collection<Address> recipients, ReplicableCommand rpc, NotifyingNotifiableFuture<Object> future) Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)
void	invokeRemotelyInFuture(Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options, NotifyingNotifiableFuture<Object> future) The same as invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions) except that the task is passed to the transport executor and a Future is returned.

Method Detail

invokeRemotely

@Deprecated
Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                                 ReplicableCommand rpcCommand,
                                                 ResponseMode mode,
                                                 long timeout,
                                                 boolean usePriorityQueue,
                                                 ResponseFilter responseFilter)

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Invokes an RPC call on other caches in the cluster.

Parameters:

recipients - a list of Addresses to invoke the call on. If this is null, the call is broadcast to the entire cluster.

rpcCommand - the cache command to invoke

mode - the response mode to use

timeout - a timeout after which to throw a replication exception.

usePriorityQueue - if true, a priority queue is used to deliver messages. May not be supported by all implementations.

responseFilter - a response filter with which to filter out failed/unwanted/invalid responses.

Returns:

a map of responses from each member contacted.

invokeRemotely

@Deprecated
Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                                 ReplicableCommand rpcCommand,
                                                 ResponseMode mode,
                                                 long timeout,
                                                 boolean usePriorityQueue)

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Invokes an RPC call on other caches in the cluster.

Parameters:

recipients - a list of Addresses to invoke the call on. If this is null, the call is broadcast to the entire cluster.

rpcCommand - the cache command to invoke

mode - the response mode to use

timeout - a timeout after which to throw a replication exception.

usePriorityQueue - if true, a priority queue is used to deliver messages. May not be supported by all implementations.

Returns:

a map of responses from each member contacted.

invokeRemotely

@Deprecated
Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                                 ReplicableCommand rpcCommand,
                                                 ResponseMode mode,
                                                 long timeout)

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Invokes an RPC call on other caches in the cluster.

Parameters:

recipients - a list of Addresses to invoke the call on. If this is null, the call is broadcast to the entire cluster.

rpcCommand - the cache command to invoke

mode - the response mode to use

timeout - a timeout after which to throw a replication exception.

Returns:

a map of responses from each member contacted.

broadcastRpcCommand

@Deprecated
void broadcastRpcCommand(ReplicableCommand rpc,
                                     boolean sync)
                              throws RpcException

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Broadcasts an RPC command to the entire cluster.

Parameters:

rpc - command to execute remotely

sync - if true, the transport will operate in sync mode. Otherwise, it will operate in async mode.

Throws:

RpcException - in the event of problems

broadcastRpcCommand

@Deprecated
void broadcastRpcCommand(ReplicableCommand rpc,
                                     boolean sync,
                                     boolean usePriorityQueue)
                              throws RpcException

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Broadcasts an RPC command to the entire cluster.

Parameters:

rpc - command to execute remotely

sync - if true, the transport will operate in sync mode. Otherwise, it will operate in async mode.

usePriorityQueue - if true, a priority queue is used

Throws:

RpcException - in the event of problems

broadcastRpcCommandInFuture

@Deprecated
void broadcastRpcCommandInFuture(ReplicableCommand rpc,
                                             NotifyingNotifiableFuture<Object> future)

Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)

The same as broadcastRpcCommand(org.infinispan.commands.ReplicableCommand, boolean) except that the task is passed to the transport executor and a Future is returned. The transport always deals with this synchronously.

Parameters:

rpc - command to execute remotely

future - the future which will be passed back to the user

broadcastRpcCommandInFuture

@Deprecated
void broadcastRpcCommandInFuture(ReplicableCommand rpc,
                                             boolean usePriorityQueue,
                                             NotifyingNotifiableFuture<Object> future)

Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)

The same as broadcastRpcCommand(org.infinispan.commands.ReplicableCommand, boolean, boolean) except that the task is passed to the transport executor and a Future is returned. The transport always deals with this synchronously.

Parameters:

rpc - command to execute remotely

usePriorityQueue - if true, a priority queue is used

future - the future which will be passed back to the user

invokeRemotely

@Deprecated
Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                                 ReplicableCommand rpc,
                                                 boolean sync)
                                          throws RpcException

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Broadcasts an RPC command to a specified set of recipients

Parameters:

recipients - recipients to invoke remote command on

rpc - command to execute remotely

sync - if true, the transport will operate in sync mode. Otherwise, it will operate in async mode.

Throws:

RpcException - in the event of problems

invokeRemotely

@Deprecated
Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                                 ReplicableCommand rpc,
                                                 boolean sync,
                                                 boolean usePriorityQueue)
                                          throws RpcException

Deprecated. this method may be removed in the future. Use invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions)

Broadcasts an RPC command to a specified set of recipients

Parameters:

recipients - recipients to invoke remote command on

rpc - command to execute remotely

sync - if true, the transport will operate in sync mode. Otherwise, it will operate in async mode.

usePriorityQueue - if true, a priority queue is used

Throws:

RpcException - in the event of problems

invokeRemotelyInFuture

@Deprecated
void invokeRemotelyInFuture(Collection<Address> recipients,
                                        ReplicableCommand rpc,
                                        NotifyingNotifiableFuture<Object> future)

Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)

The same as invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, boolean) except that the task is passed to the transport executor and a Future is returned. The transport always deals with this synchronously.

Parameters:

recipients - recipients to invoke remote call on

rpc - command to execute remotely

future - the future which will be passed back to the user

invokeRemotelyInFuture

@Deprecated
void invokeRemotelyInFuture(Collection<Address> recipients,
                                        ReplicableCommand rpc,
                                        boolean usePriorityQueue,
                                        NotifyingNotifiableFuture<Object> future)

Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)

The same as invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, boolean) except that the task is passed to the transport executor and a Future is returned. The transport always deals with this synchronously.

Parameters:

recipients - recipients to invoke remote call on

rpc - command to execute remotely

usePriorityQueue - if true, a priority queue is used

future - the future which will be passed back to the user

invokeRemotelyInFuture

@Deprecated
void invokeRemotelyInFuture(Collection<Address> recipients,
                                        ReplicableCommand rpc,
                                        boolean usePriorityQueue,
                                        NotifyingNotifiableFuture<Object> future,
                                        long timeout)

Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)

The same as #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, boolean, org.infinispan.util.concurrent.NotifyingNotifiableFuture) except that you can specify a timeout.

Parameters:

recipients - recipients to invoke remote call on

rpc - command to execute remotely

usePriorityQueue - if true, a priority queue is used

future - the future which will be passed back to the user

timeout - after which to give up (in millis)

invokeRemotelyInFuture

@Deprecated
void invokeRemotelyInFuture(Collection<Address> recipients,
                                        ReplicableCommand rpc,
                                        boolean usePriorityQueue,
                                        NotifyingNotifiableFuture<Object> future,
                                        long timeout,
                                        boolean ignoreLeavers)

Deprecated. this method may be removed in the future. Use #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.util.concurrent.NotifyingNotifiableFuture)

The same as #invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, boolean, org.infinispan.util.concurrent.NotifyingNotifiableFuture, long) except that you can specify a response mode.

Parameters:

recipients - recipients to invoke remote call on

rpc - command to execute remotely

usePriorityQueue - if true, a priority queue is used

future - the future which will be passed back to the user

timeout - after which to give up (in millis)

ignoreLeavers - if true, recipients that leave or have already left the cluster are ignored if false, a SuspectException is thrown when a leave is detected

invokeRemotely

Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                     ReplicableCommand rpc,
                                     RpcOptions options)

Invokes an RPC call on other caches in the cluster.

Parameters:

recipients - a list of Addresses to invoke the call on. If this is null, the call is broadcast to the entire cluster.

rpc - command to execute remotely.

options - it configures the invocation. The same instance can be re-used since RpcManager does not change it. Any change in RpcOptions during a remote invocation can lead to unpredictable behavior.

Returns:

a map of responses from each member contacted.

invokeRemotelyInFuture

void invokeRemotelyInFuture(Collection<Address> recipients,
                            ReplicableCommand rpc,
                            RpcOptions options,
                            NotifyingNotifiableFuture<Object> future)

The same as invokeRemotely(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions) except that the task is passed to the transport executor and a Future is returned. The transport always deals with this synchronously.

Parameters:

recipients - recipients to invoke remote call on. If this is null, the call is broadcast to the entire cluster.

rpc - command to execute remotely.

options - it configures the invocation. The same instance can be re-used since RpcManager does not change it. Any change in RpcOptions during a remote invocation can lead to unpredictable behavior.

future - the future which will be passed back to the user.

getTransport

Transport getTransport()

Returns:

a reference to the underlying transport.

getMembers

List<Address> getMembers()

Returns members of a cluster scoped to the cache owning this RpcManager. Note that this List is always a subset of Transport.getMembers()

Returns:

a list of cache scoped cluster members

getAddress

Address getAddress()

Returns the address associated with this RpcManager or null if not part of the cluster.

getTopologyId

int getTopologyId()

Returns the current topology id. As opposed to the viewId which is updated whenever the cluster changes, the topologyId is updated when a new cache instance is started or removed - this doesn't necessarily coincide with a node being added/removed to the cluster.

getRpcOptionsBuilder

RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode)

This method is equivalent to getRpcOptionsBuilder(responseMode, true)

Parameters:

responseMode -

Returns:

a new RpcOptionsBuilder with the default options, the response mode set by and FIFO deliver order.

getRpcOptionsBuilder

RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode,
                                       boolean fifoOrder)

Parameters:

responseMode -

fifoOrder -

Returns:

a new RpcOptionsBuilder with the default options, the response mode set by and the deliver order as fifo if the is true.

getDefaultRpcOptions

RpcOptions getDefaultRpcOptions(boolean sync)

See getDefaultRpcOptions(boolean, boolean). It is equivalent to getDefaultRpcOptions(sync, true)

Parameters:

sync - true for Synchronous RpcOptions

Returns:

the default Synchronous/Asynchronous RpcOptions

getDefaultRpcOptions

RpcOptions getDefaultRpcOptions(boolean sync,
                                boolean fifoOrder)

Builds a RpcOptions based on the parameters

Parameters:

sync - true for Synchronous RpcOptions

fifoOrder -

Returns:

the default Synchronous/Asynchronous RpcOptions with the deliver order set by