org.infinispan.remoting.transport

Interface Transport

All Superinterfaces:

Lifecycle

All Known Implementing Classes:

AbstractDelegatingTransport, AbstractTransport, JGroupsTransport

public interface Transport
extends Lifecycle

An interface that provides a communication link with remote caches. Also allows remote caches to invoke commands on this cache instance.

Since:

4.0

Author:

Manik Surtani, Galder Zamarreño

Method Summary

Modifier and Type	Method and Description
BackupResponse	backupRemotely(Collection<XSiteBackup> backups, XSiteReplicateCommand rpcCommand)
void	checkTotalOrderSupported() check if the transport has configured with total order deliver properties (has the sequencer in JGroups protocol stack.
Address	getAddress() Retrieves the current cache instance's network address
Address	getCoordinator()
Log	getLog()
List<Address>	getMembers() Returns a list of members in the current cluster view.
List<Address>	getPhysicalAddresses() Retrieves the current cache instance's physical network addresses.
int	getViewId()
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, ResponseFilter responseFilter, DeliverOrder deliverOrder, boolean anycast) Invokes an RPC call on other caches in the cluster.
Map<Address,Response>	invokeRemotely(Map<Address,ReplicableCommand> rpcCommands, ResponseMode mode, long timeout, boolean usePriorityQueue, ResponseFilter responseFilter, boolean totalOrder, boolean anycast) Deprecated. Use invokeRemotely(Map, ResponseMode, long, ResponseFilter, DeliverOrder, boolean) instead
Map<Address,Response>	invokeRemotely(Map<Address,ReplicableCommand> rpcCommands, ResponseMode mode, long timeout, ResponseFilter responseFilter, DeliverOrder deliverOrder, boolean anycast)
CompletableFuture<Map<Address,Response>>	invokeRemotelyAsync(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, ResponseFilter responseFilter, DeliverOrder deliverOrder, boolean anycast)
boolean	isCoordinator()
boolean	isMulticastCapable() Tests whether the transport supports true multicast
void	start() Invoked on component start
void	stop() Invoked on component stop
void	waitForView(int viewId)

Method Detail

invokeRemotely

Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                     ReplicableCommand rpcCommand,
                                     ResponseMode mode,
                                     long timeout,
                                     ResponseFilter responseFilter,
                                     DeliverOrder deliverOrder,
                                     boolean anycast)
                              throws Exception

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

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

deliverOrder - the DeliverOrder.

anycast - used when is true, it means that it must use TOA instead of TOB.

Returns:

a map of responses from each member contacted.

Throws:

Exception - in the event of problems.

invokeRemotelyAsync

CompletableFuture<Map<Address,Response>> invokeRemotelyAsync(Collection<Address> recipients,
                                                             ReplicableCommand rpcCommand,
                                                             ResponseMode mode,
                                                             long timeout,
                                                             ResponseFilter responseFilter,
                                                             DeliverOrder deliverOrder,
                                                             boolean anycast)
                                                      throws Exception

Throws:

Exception

invokeRemotely

@Deprecated
Map<Address,Response> invokeRemotely(Map<Address,ReplicableCommand> rpcCommands,
                                                 ResponseMode mode,
                                                 long timeout,
                                                 boolean usePriorityQueue,
                                                 ResponseFilter responseFilter,
                                                 boolean totalOrder,
                                                 boolean anycast)
                                          throws Exception

Deprecated. Use invokeRemotely(Map, ResponseMode, long, ResponseFilter, DeliverOrder, boolean) instead

Throws:

Exception

invokeRemotely

Map<Address,Response> invokeRemotely(Map<Address,ReplicableCommand> rpcCommands,
                                     ResponseMode mode,
                                     long timeout,
                                     ResponseFilter responseFilter,
                                     DeliverOrder deliverOrder,
                                     boolean anycast)
                              throws Exception

Throws:

Exception

backupRemotely

BackupResponse backupRemotely(Collection<XSiteBackup> backups,
                              XSiteReplicateCommand rpcCommand)
                       throws Exception

Throws:

Exception

isCoordinator

boolean isCoordinator()

Returns:

true if the current Channel is the coordinator of the cluster.

getCoordinator

Address getCoordinator()

Returns:

the Address of the current coordinator.

getAddress

Address getAddress()

Retrieves the current cache instance's network address

Returns:

an Address

getPhysicalAddresses

List<Address> getPhysicalAddresses()

Retrieves the current cache instance's physical network addresses. Some implementations might differentiate between logical and physical addresses in which case, this method allows clients to query the physical ones associated with the logical address. Implementations where logical and physical address are the same will simply return a single entry List that contains the same Address as getAddress().

Returns:

an List of Address

getMembers

List<Address> getMembers()

Returns a list of members in the current cluster view.

Returns:

a list of members. Typically, this would be defensively copied.

isMulticastCapable

boolean isMulticastCapable()

Tests whether the transport supports true multicast

Returns:

true if the transport supports true multicast

start

void start()

Description copied from interface: Lifecycle

Invoked on component start

Specified by:

start in interface Lifecycle

stop

void stop()

Description copied from interface: Lifecycle

Invoked on component stop

Specified by:

stop in interface Lifecycle

getViewId

int getViewId()

Throws:

CacheException - if the transport has been stopped.

waitForView

void waitForView(int viewId)
          throws InterruptedException

Throws:

InterruptedException

getLog

Log getLog()

checkTotalOrderSupported

void checkTotalOrderSupported()

check if the transport has configured with total order deliver properties (has the sequencer in JGroups protocol stack.