org.infinispan.remoting.rpc

Interface RpcManager

All Known Implementing Classes:

ExtendedStatisticRpcManager, 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
Address	getAddress() Returns the address associated with this RpcManager or null if not part of the cluster.
RpcOptions	getDefaultRpcOptions(boolean sync) Creates a new RpcOptionsBuilder.
RpcOptions	getDefaultRpcOptions(boolean sync, DeliverOrder deliverOrder) Creates a new RpcOptionsBuilder.
List<Address>	getMembers() Returns members of a cluster scoped to the cache owning this RpcManager.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode) Creates a new RpcOptionsBuilder.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode, DeliverOrder deliverOrder) Creates a new RpcOptionsBuilder.
int	getTopologyId() Returns the current topology id.
Transport	getTransport()
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options) Invokes an RPC call on other caches in the cluster.
Map<Address,Response>	invokeRemotely(Map<Address,ReplicableCommand> rpcs, RpcOptions options)
CompletableFuture<Map<Address,Response>>	invokeRemotelyAsync(Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options) Invokes a command on remote nodes.
void	invokeRemotelyInFuture(Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options, NotifyingNotifiableFuture<Object> future) Deprecated. Use invokeRemotelyAsync(Collection, ReplicableCommand, RpcOptions) instead. 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.
void	invokeRemotelyInFuture(NotifyingNotifiableFuture<Map<Address,Response>> future, Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options) Deprecated. Use invokeRemotelyAsync(Collection, ReplicableCommand, RpcOptions) instead. Same as invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.commons.util.concurrent.NotifyingNotifiableFuture) but with a different NotifyingNotifiableFuture type.

Method Detail

invokeRemotelyAsync

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

Invokes a command on remote nodes.

Parameters:

recipients - A list of nodes, or null to invoke the command on all the members of the cluster

rpc - The command to invoke

options - The invocation options

Returns:

A future that, when completed, returns the responses from the remote nodes.

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.

invokeRemotely

Map<Address,Response> invokeRemotely(Map<Address,ReplicableCommand> rpcs,
                                     RpcOptions options)

invokeRemotelyInFuture

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

Deprecated. Use invokeRemotelyAsync(Collection, ReplicableCommand, RpcOptions) instead. 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.

invokeRemotelyInFuture

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

Deprecated. Use invokeRemotelyAsync(Collection, ReplicableCommand, RpcOptions) instead. Same as invokeRemotelyInFuture(java.util.Collection, org.infinispan.commands.ReplicableCommand, RpcOptions, org.infinispan.commons.util.concurrent.NotifyingNotifiableFuture) but with a different NotifyingNotifiableFuture type.

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)

Creates a new RpcOptionsBuilder.

The RpcOptionsBuilder is configured with the ResponseMode and with DeliverOrder.NONE if the ResponseMode is synchronous otherwise, with DeliverOrder.PER_SENDER if asynchronous.

Parameters:

responseMode - the ResponseMode.

Returns:

a new RpcOptionsBuilder with the default options. The response and deliver mode are set as described.

getRpcOptionsBuilder

RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode,
                                       DeliverOrder deliverOrder)

Creates a new RpcOptionsBuilder.

Parameters:

responseMode - the ResponseMode.

deliverOrder - the DeliverOrder.

Returns:

a new RpcOptionsBuilder with the default options and the response mode and deliver mode set by the parameters.

getDefaultRpcOptions

RpcOptions getDefaultRpcOptions(boolean sync)

Creates a new RpcOptionsBuilder.

The RpcOptionsBuilder is configured with DeliverOrder.NONE if the is true otherwise, with DeliverOrder.PER_SENDER.

Parameters:

sync - true for Synchronous RpcOptions

Returns:

the default Synchronous/Asynchronous RpcOptions

getDefaultRpcOptions

RpcOptions getDefaultRpcOptions(boolean sync,
                                DeliverOrder deliverOrder)

Creates a new RpcOptionsBuilder.

Parameters:

sync - true for Synchronous RpcOptions

deliverOrder - the DeliverOrder to use.

Returns:

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