Class HeartBeatCommand

java.lang.Object

org.infinispan.topology.HeartBeatCommand

All Implemented Interfaces:

GlobalRpcCommand, ReplicableCommand, TracedCommand, VersionAware

@ProtoTypeId(1085)
public class HeartBeatCommand
extends Object
implements GlobalRpcCommand

A hear-beat command used to ping members in ClusterTopologyManagerImpl.confirmMembersAvailable().

Since:

9.2

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
static final HeartBeatCommand	INSTANCE

Constructor Summary

Constructors

Constructor	Description
HeartBeatCommand()

Method Summary

Modifier and Type	Method	Description
CompletionStage<?>	invokeAsync(GlobalComponentRegistry globalComponentRegistry)	Invoke the command asynchronously.
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
NodeVersion	supportedSince()	Returns a NodeVersion representing the Infinispan version in which this command was added.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getCommandId, isSuccessful, logThrowable, readFrom, setOrigin, writeTo

Methods inherited from interface org.infinispan.commands.TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Field Details

INSTANCE

public static final HeartBeatCommand INSTANCE

Constructor Details

HeartBeatCommand

public HeartBeatCommand()

Method Details

invokeAsync

public CompletionStage<?> invokeAsync(GlobalComponentRegistry globalComponentRegistry)
                               throws Throwable

Description copied from interface: GlobalRpcCommand

Invoke the command asynchronously.

Specified by:

invokeAsync in interface GlobalRpcCommand

Throws:

Throwable

isReturnValueExpected

public boolean isReturnValueExpected()

Description copied from interface: ReplicableCommand

If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Returns:

true or false

supportedSince

public NodeVersion supportedSince()

Description copied from interface: ReplicableCommand

Returns a NodeVersion representing the Infinispan version in which this command was added. This value is used to ensure that when the cluster contains different Infinispan versions, only commands compatible with the oldest version are transmitted.

Abstract classes should not implement this method as the version should be specific to an individual implementation. Similarly, implementations which extend another ReplicableCommand should always override this method.

Specified by:

supportedSince in interface ReplicableCommand

Specified by:

supportedSince in interface VersionAware

Returns:

a NodeVersion corresponding to the Infinispan version this command was added.