Package 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	Description
<T> T	blocking(CompletionStage<T> request)	Block on a request and return its result.
Address	getAddress()	Returns the address associated with this RpcManager or null if not part of the cluster.
RpcOptions	getDefaultRpcOptions(boolean sync)	Deprecated. Since 9.2, please use getSyncRpcOptions() instead.
RpcOptions	getDefaultRpcOptions(boolean sync, DeliverOrder deliverOrder)	Deprecated. Since 9.2, please use getSyncRpcOptions() or getTotalSyncRpcOptions() instead.
List<Address>	getMembers()	Returns members of a cluster scoped to the cache owning this RpcManager.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode)	Deprecated. Since 9.2, please use getSyncRpcOptions() instead.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode, DeliverOrder deliverOrder)	Deprecated. Since 9.2, please use getSyncRpcOptions() instead.
RpcOptions	getSyncRpcOptions()
int	getTopologyId()	Returns the current topology id.
RpcOptions	getTotalSyncRpcOptions()
Transport	getTransport()
<T> CompletionStage<T>	invokeCommand(Collection<Address> targets, org.infinispan.commands.ReplicableCommand command, ResponseCollector<T> collector, RpcOptions rpcOptions)	Invoke a command on a collection of node and pass the responses to a ResponseCollector.
<T> CompletionStage<T>	invokeCommand(Address target, org.infinispan.commands.ReplicableCommand command, ResponseCollector<T> collector, RpcOptions rpcOptions)	Invoke a command on a single node and pass the response to a ResponseCollector.
<T> CompletionStage<T>	invokeCommandOnAll(org.infinispan.commands.ReplicableCommand command, ResponseCollector<T> collector, RpcOptions rpcOptions)	Invoke a command on all the nodes in the cluster and pass the responses to a ResponseCollector.
<T> CompletionStage<T>	invokeCommands(Collection<Address> targets, Function<Address,org.infinispan.commands.ReplicableCommand> commandGenerator, ResponseCollector<T> collector, RpcOptions rpcOptions)	Invoke different commands on a collection of nodes and pass the responses to a ResponseCollector.
<T> CompletionStage<T>	invokeCommandStaggered(Collection<Address> targets, org.infinispan.commands.ReplicableCommand command, ResponseCollector<T> collector, RpcOptions rpcOptions)	Invoke a command on a collection of nodes and pass the responses to a ResponseCollector.
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, org.infinispan.commands.ReplicableCommand rpc, RpcOptions options)	Deprecated. Since 9.2, please use invokeCommand(Collection, ReplicableCommand, ResponseCollector, RpcOptions) instead.
Map<Address,Response>	invokeRemotely(Map<Address,org.infinispan.commands.ReplicableCommand> rpcs, RpcOptions options)	Deprecated. Since 9.2, please use invokeCommands(Collection, Function, ResponseCollector, RpcOptions) instead.
CompletableFuture<Map<Address,Response>>	invokeRemotelyAsync(Collection<Address> recipients, org.infinispan.commands.ReplicableCommand rpc, RpcOptions options)	Invokes a command on remote nodes.
BackupResponse	invokeXSite(Collection<XSiteBackup> sites, XSiteReplicateCommand command)	Invokes the XSiteReplicateCommand to one or more remote sites.
void	sendTo(Address destination, org.infinispan.commands.ReplicableCommand command, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the destination using the specified DeliverOrder.
void	sendToAll(org.infinispan.commands.ReplicableCommand command, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the entire cluster.
void	sendToMany(Collection<Address> destinations, org.infinispan.commands.ReplicableCommand command, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the set of destination using the specified DeliverOrder.

Method Detail

invokeCommand

<T> CompletionStage<T> invokeCommand(Address target,
                                     org.infinispan.commands.ReplicableCommand command,
                                     ResponseCollector<T> collector,
                                     RpcOptions rpcOptions)

Invoke a command on a single node and pass the response to a ResponseCollector. If the target is the local node and the delivery order is not DeliverOrder.TOTAL, the command is never executed, and ResponseCollector.finish() is called directly.

Since:

9.2

invokeCommand

<T> CompletionStage<T> invokeCommand(Collection<Address> targets,
                                     org.infinispan.commands.ReplicableCommand command,
                                     ResponseCollector<T> collector,
                                     RpcOptions rpcOptions)

Invoke a command on a collection of node and pass the responses to a ResponseCollector. If one of the targets is the local nodes and the delivery order is not DeliverOrder.TOTAL, the command is only executed on the remote nodes.

Since:

9.2

invokeCommandOnAll

<T> CompletionStage<T> invokeCommandOnAll(org.infinispan.commands.ReplicableCommand command,
                                          ResponseCollector<T> collector,
                                          RpcOptions rpcOptions)

Invoke a command on all the nodes in the cluster and pass the responses to a ResponseCollector. The command is only executed on the local node if the delivery order is DeliverOrder.TOTAL. The command is not sent across RELAY2 bridges to remote sites.

Since:

9.2

invokeCommandStaggered

<T> CompletionStage<T> invokeCommandStaggered(Collection<Address> targets,
                                              org.infinispan.commands.ReplicableCommand command,
                                              ResponseCollector<T> collector,
                                              RpcOptions rpcOptions)

Invoke a command on a collection of nodes and pass the responses to a ResponseCollector. The command is only sent immediately to the first target, and there is an implementation-dependent delay before sending the command to each target. There is no delay if the target responds or leaves the cluster. The remaining targets are skipped if ResponseCollector.addResponse(Address, Response) returns a non-null value. If one of the targets is the local node and the delivery order is not DeliverOrder.TOTAL, the command is only executed on the remote nodes.

Since:

9.2

invokeCommands

<T> CompletionStage<T> invokeCommands(Collection<Address> targets,
                                      Function<Address,org.infinispan.commands.ReplicableCommand> commandGenerator,
                                      ResponseCollector<T> collector,
                                      RpcOptions rpcOptions)

Invoke different commands on a collection of nodes and pass the responses to a ResponseCollector. If one of the targets is the local node and the delivery order is not DeliverOrder.TOTAL, the command is only executed on the remote nodes.

Since:

9.2

blocking

<T> T blocking(CompletionStage<T> request)

Block on a request and return its result.

Since:

9.2

invokeRemotelyAsync

CompletableFuture<Map<Address,Response>> invokeRemotelyAsync(Collection<Address> recipients,
                                                                   org.infinispan.commands.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

@Deprecated
Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                           org.infinispan.commands.ReplicableCommand rpc,
                                           RpcOptions options)

Deprecated.

Since 9.2, please use invokeCommand(Collection, ReplicableCommand, ResponseCollector, RpcOptions) instead.

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

@Deprecated
Map<Address,Response> invokeRemotely(Map<Address,org.infinispan.commands.ReplicableCommand> rpcs,
                                           RpcOptions options)

Deprecated.

Since 9.2, please use invokeCommands(Collection, Function, ResponseCollector, RpcOptions) instead.

sendTo

void sendTo(Address destination,
            org.infinispan.commands.ReplicableCommand command,
            DeliverOrder deliverOrder)

Asynchronously sends the ReplicableCommand to the destination using the specified DeliverOrder.

Parameters:

destination - the destination's Address.

command - the ReplicableCommand to send.

deliverOrder - the DeliverOrder to use.

sendToMany

void sendToMany(Collection<Address> destinations,
                org.infinispan.commands.ReplicableCommand command,
                DeliverOrder deliverOrder)

Asynchronously sends the ReplicableCommand to the set of destination using the specified DeliverOrder.

Parameters:

destinations - the collection of destination's Address. If null, it sends to all the members in the cluster.

command - the ReplicableCommand to send.

deliverOrder - the DeliverOrder to use.

sendToAll

void sendToAll(org.infinispan.commands.ReplicableCommand command,
               DeliverOrder deliverOrder)

Asynchronously sends the ReplicableCommand to the entire cluster.

Since:

9.2

invokeXSite

BackupResponse invokeXSite(Collection<XSiteBackup> sites,
                           XSiteReplicateCommand command)
                    throws Exception

Invokes the XSiteReplicateCommand to one or more remote sites.

Parameters:

sites - The sites to where the command is sent.

command - The XSiteReplicateCommand to send.

Returns:

The BackupResponse with the responses.

Throws:

Exception

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.

getSyncRpcOptions

RpcOptions getSyncRpcOptions()

Returns:

The default options for synchronous remote invocations.

getTotalSyncRpcOptions

RpcOptions getTotalSyncRpcOptions()

Returns:

The default options for total order remote invocations.

getRpcOptionsBuilder

@Deprecated
RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode)

Deprecated.

Since 9.2, please use getSyncRpcOptions() instead.

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

@Deprecated
RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode,
                                       DeliverOrder deliverOrder)

Deprecated.

Since 9.2, please use getSyncRpcOptions() instead.

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

@Deprecated
RpcOptions getDefaultRpcOptions(boolean sync)

Deprecated.

Since 9.2, please use getSyncRpcOptions() instead.

Creates a new RpcOptionsBuilder.

The RpcOptionsBuilder is configured with DeliverOrder.NONE if the {@param sync} is true otherwise, with DeliverOrder.PER_SENDER.

Parameters:

sync - true for Synchronous RpcOptions

Returns:

the default Synchronous/Asynchronous RpcOptions

getDefaultRpcOptions

@Deprecated
RpcOptions getDefaultRpcOptions(boolean sync,
                                DeliverOrder deliverOrder)

Deprecated.

Since 9.2, please use getSyncRpcOptions() or getTotalSyncRpcOptions() instead.

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.