Package org.infinispan.remoting.rpc

Class RpcManagerImpl

java.lang.Object

org.infinispan.remoting.rpc.RpcManagerImpl

All Implemented Interfaces:

JmxStatisticsExposer, RpcManager

public class RpcManagerImpl
extends Object
implements RpcManager, JmxStatisticsExposer

This component really is just a wrapper around a Transport implementation, and is used to set up the transport and provide lifecycle and dependency hooks into external transport implementations.

Since:

4.0

Author:

Manik Surtani, Galder Zamarreño, Mircea.Markus@jboss.com, Pedro Ruivo

Constructor Summary

Constructors

Constructor	Description
RpcManagerImpl()

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.
long	getAsyncXSiteAcksCount()
long	getAsyncXSiteCount()
long	getAverageAsyncXSiteReplicationTime()
long	getAverageReplicationTime()
long	getAverageXSiteReplicationTime()
String	getCommittedViewAsString()
RpcOptions	getDefaultRpcOptions(boolean sync)	Creates a new RpcOptionsBuilder.
RpcOptions	getDefaultRpcOptions(boolean sync, DeliverOrder deliverOrder)	Creates a new RpcOptionsBuilder.
long	getMaximumAsyncXSiteReplicationTime()
long	getMaximumXSiteReplicationTime()
List<Address>	getMembers()	Returns members of a cluster scoped to the cache owning this RpcManager.
long	getMinimumAsyncXSiteReplicationTime()
long	getMinimumXSiteReplicationTime()
String	getPendingViewAsString()
long	getReplicationCount()
long	getReplicationFailures()
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode)	Creates a new RpcOptionsBuilder.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode, DeliverOrder deliverOrder)	Creates a new RpcOptionsBuilder.
String	getSitesView()
boolean	getStatisticsEnabled()	Returns whether an interceptor's statistics are being captured.
String	getSuccessRatio()
double	getSuccessRatioFloatingPoint()
RpcOptions	getSyncRpcOptions()
long	getSyncXSiteCount()
int	getTopologyId()	Returns the current topology id.
RpcOptions	getTotalSyncRpcOptions()
Transport	getTransport()
<T> CompletionStage<T>	invokeCommand(Collection<Address> targets, 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, 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(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,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, 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, 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.
BackupResponse	invokeXSite(Collection<XSiteBackup> sites, XSiteReplicateCommand command)	Invokes the XSiteReplicateCommand to one or more remote sites.
boolean	isStatisticsEnabled()
void	resetStatistics()	Resets an interceptor's cache statistics
void	sendTo(Address destination, ReplicableCommand command, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the destination using the specified DeliverOrder.
void	sendToAll(ReplicableCommand command, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the entire cluster.
void	sendToMany(Collection<Address> destinations, ReplicableCommand command, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the set of destination using the specified DeliverOrder.
void	setStatisticsEnabled(boolean statisticsEnabled)	Deprecated. We already have an attribute, we shouldn't have an operation for the same thing.
void	setTransport(Transport t)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RpcManagerImpl

public RpcManagerImpl()

Method Detail

getCommittedViewAsString

public String getCommittedViewAsString()

getPendingViewAsString

public String getPendingViewAsString()

invokeCommand

public <T> CompletionStage<T> invokeCommand(Address target,
                                            ReplicableCommand command,
                                            ResponseCollector<T> collector,
                                            RpcOptions rpcOptions)

Description copied from interface: RpcManager

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.

Specified by:

invokeCommand in interface RpcManager

invokeCommand

public <T> CompletionStage<T> invokeCommand(Collection<Address> targets,
                                            ReplicableCommand command,
                                            ResponseCollector<T> collector,
                                            RpcOptions rpcOptions)

Description copied from interface: RpcManager

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.

Specified by:

invokeCommand in interface RpcManager

invokeCommandOnAll

public <T> CompletionStage<T> invokeCommandOnAll(ReplicableCommand command,
                                                 ResponseCollector<T> collector,
                                                 RpcOptions rpcOptions)

Description copied from interface: RpcManager

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.

Specified by:

invokeCommandOnAll in interface RpcManager

invokeCommandStaggered

public <T> CompletionStage<T> invokeCommandStaggered(Collection<Address> targets,
                                                     ReplicableCommand command,
                                                     ResponseCollector<T> collector,
                                                     RpcOptions rpcOptions)

Description copied from interface: RpcManager

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.

Specified by:

invokeCommandStaggered in interface RpcManager

invokeCommands

public <T> CompletionStage<T> invokeCommands(Collection<Address> targets,
                                             Function<Address,ReplicableCommand> commandGenerator,
                                             ResponseCollector<T> collector,
                                             RpcOptions rpcOptions)

Description copied from interface: RpcManager

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.

Specified by:

invokeCommands in interface RpcManager

blocking

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

Description copied from interface: RpcManager

Block on a request and return its result.

Specified by:

blocking in interface RpcManager

invokeRemotelyAsync

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

Description copied from interface: RpcManager

Invokes a command on remote nodes.

Specified by:

invokeRemotelyAsync in interface RpcManager

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

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

Description copied from interface: RpcManager

Invokes an RPC call on other caches in the cluster.

Specified by:

invokeRemotely in interface RpcManager

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

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

Specified by:

invokeRemotely in interface RpcManager

sendTo

public void sendTo(Address destination,
                   ReplicableCommand command,
                   DeliverOrder deliverOrder)

Description copied from interface: RpcManager

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

Specified by:

sendTo in interface RpcManager

Parameters:

destination - the destination's Address.

command - the ReplicableCommand to send.

deliverOrder - the DeliverOrder to use.

sendToMany

public void sendToMany(Collection<Address> destinations,
                       ReplicableCommand command,
                       DeliverOrder deliverOrder)

Description copied from interface: RpcManager

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

Specified by:

sendToMany in interface RpcManager

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

public void sendToAll(ReplicableCommand command,
                      DeliverOrder deliverOrder)

Description copied from interface: RpcManager

Asynchronously sends the ReplicableCommand to the entire cluster.

Specified by:

sendToAll in interface RpcManager

invokeXSite

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

Description copied from interface: RpcManager

Invokes the XSiteReplicateCommand to one or more remote sites.

Specified by:

invokeXSite in interface RpcManager

Parameters:

sites - The sites to where the command is sent.

command - The XSiteReplicateCommand to send.

Returns:

The BackupResponse with the responses.

Throws:

Exception

getTransport

public Transport getTransport()

Specified by:

getTransport in interface RpcManager

Returns:

a reference to the underlying transport.

resetStatistics

public void resetStatistics()

Description copied from interface: JmxStatisticsExposer

Resets an interceptor's cache statistics

Specified by:

resetStatistics in interface JmxStatisticsExposer

getReplicationCount

public long getReplicationCount()

getReplicationFailures

public long getReplicationFailures()

isStatisticsEnabled

public boolean isStatisticsEnabled()

getStatisticsEnabled

public boolean getStatisticsEnabled()

Description copied from interface: JmxStatisticsExposer

Returns whether an interceptor's statistics are being captured.

Specified by:

getStatisticsEnabled in interface JmxStatisticsExposer

Returns:

true if statistics are captured

setStatisticsEnabled

@Deprecated
public void setStatisticsEnabled(boolean statisticsEnabled)

Deprecated.

We already have an attribute, we shouldn't have an operation for the same thing.

Description copied from interface: JmxStatisticsExposer

Enables an interceptor's cache statistics If true, the interceptor will capture statistics and make them available through the mbean.

Specified by:

setStatisticsEnabled in interface JmxStatisticsExposer

Parameters:

statisticsEnabled - true if statistics should be captured

getSuccessRatio

public String getSuccessRatio()

getSuccessRatioFloatingPoint

public double getSuccessRatioFloatingPoint()

getAverageReplicationTime

public long getAverageReplicationTime()

getSitesView

public String getSitesView()

getAverageXSiteReplicationTime

public long getAverageXSiteReplicationTime()

getMinimumXSiteReplicationTime

public long getMinimumXSiteReplicationTime()

getMaximumXSiteReplicationTime

public long getMaximumXSiteReplicationTime()

getSyncXSiteCount

public long getSyncXSiteCount()

getAsyncXSiteCount

public long getAsyncXSiteCount()

getAverageAsyncXSiteReplicationTime

public long getAverageAsyncXSiteReplicationTime()

getMinimumAsyncXSiteReplicationTime

public long getMinimumAsyncXSiteReplicationTime()

getMaximumAsyncXSiteReplicationTime

public long getMaximumAsyncXSiteReplicationTime()

getAsyncXSiteAcksCount

public long getAsyncXSiteAcksCount()

setTransport

public void setTransport(Transport t)

getAddress

public Address getAddress()

Description copied from interface: RpcManager

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

Specified by:

getAddress in interface RpcManager

getTopologyId

public int getTopologyId()

Description copied from interface: RpcManager

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.

Specified by:

getTopologyId in interface RpcManager

getSyncRpcOptions

public RpcOptions getSyncRpcOptions()

Specified by:

getSyncRpcOptions in interface RpcManager

Returns:

The default options for synchronous remote invocations.

getTotalSyncRpcOptions

public RpcOptions getTotalSyncRpcOptions()

Specified by:

getTotalSyncRpcOptions in interface RpcManager

Returns:

The default options for total order remote invocations.

getRpcOptionsBuilder

public RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode)

Description copied from interface: RpcManager

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.

Specified by:

getRpcOptionsBuilder in interface RpcManager

Parameters:

responseMode - the ResponseMode.

Returns:

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

getRpcOptionsBuilder

public RpcOptionsBuilder getRpcOptionsBuilder(ResponseMode responseMode,
                                              DeliverOrder deliverOrder)

Description copied from interface: RpcManager

Creates a new RpcOptionsBuilder.

Specified by:

getRpcOptionsBuilder in interface RpcManager

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

public RpcOptions getDefaultRpcOptions(boolean sync)

Description copied from interface: RpcManager

Creates a new RpcOptionsBuilder.

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

Specified by:

getDefaultRpcOptions in interface RpcManager

Parameters:

sync - true for Synchronous RpcOptions

Returns:

the default Synchronous/Asynchronous RpcOptions

getDefaultRpcOptions

public RpcOptions getDefaultRpcOptions(boolean sync,
                                       DeliverOrder deliverOrder)

Description copied from interface: RpcManager

Creates a new RpcOptionsBuilder.

Specified by:

getDefaultRpcOptions in interface RpcManager

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.

getMembers

public List<Address> getMembers()

Description copied from interface: RpcManager

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

Specified by:

getMembers in interface RpcManager

Returns:

a list of cache scoped cluster members