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 and Description
RpcManagerImpl()

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.
long	getAverageReplicationTime()
String	getCommittedViewAsString()
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.
String	getPendingViewAsString()
long	getReplicationCount()
long	getReplicationFailures()
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode) Creates a new RpcOptionsBuilder.
RpcOptionsBuilder	getRpcOptionsBuilder(ResponseMode responseMode, DeliverOrder deliverOrder) Creates a new RpcOptionsBuilder.
boolean	getStatisticsEnabled() Returns whether an interceptor's statistics are being captured.
String	getSuccessRatio()
double	getSuccessRatioFloatingPoint()
int	getTopologyId() Returns the current topology id.
Transport	getTransport()
void	injectDependencies(Transport t, Configuration cfg, ReplicationQueue replicationQueue, CommandsFactory cf, StateTransferManager stateTransferManager, TimeService timeService)
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)
void	invokeRemotelyInFuture(NotifyingNotifiableFuture<Map<Address,Response>> future, Collection<Address> recipients, ReplicableCommand rpc, RpcOptions options)
boolean	isStatisticsEnabled()
void	resetStatistics() Resets an interceptor's cache statistics
protected <T> T	rethrowAsCacheException(Throwable throwable)
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

injectDependencies

public void injectDependencies(Transport t,
                               Configuration cfg,
                               ReplicationQueue replicationQueue,
                               CommandsFactory cf,
                               StateTransferManager stateTransferManager,
                               TimeService timeService)

getCommittedViewAsString

public String getCommittedViewAsString()

getPendingViewAsString

public String getPendingViewAsString()

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.

rethrowAsCacheException

protected <T> T rethrowAsCacheException(Throwable throwable)

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

invokeRemotelyInFuture

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

Specified by:

invokeRemotelyInFuture in interface RpcManager

invokeRemotelyInFuture

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

Specified by:

invokeRemotelyInFuture in interface RpcManager

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

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()

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

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 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