- All Known Implementing Classes:
AckedClusterStateUpdateTask
,TransportClusterUpdateSettingsAction.ClusterUpdateSettingsTask
public interface ClusterStateAckListener
Interface that a cluster state update task can implement to indicate that it wishes to be notified when the update has been acked by
(some subset of) the nodes in the cluster. Nodes ack a cluster state update after successfully applying the resulting state. Note that
updates which do not change the cluster state are automatically reported as acked by all nodes without checking to see whether there are
any nodes that have not already applied this state.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
mustAck
(DiscoveryNode discoveryNode) Called to determine which nodes the acknowledgement is expected from.void
Called after all the nodes have acknowledged the cluster state update request but at least one of them failed.void
Called once the acknowledgement timeout defined byAckedClusterStateUpdateTask.ackTimeout()
has expiredvoid
Called once all the nodes have acknowledged the cluster state update request.
-
Method Details
-
mustAck
Called to determine which nodes the acknowledgement is expected from. As this method will be called multiple times to determine the set of acking nodes, it is crucial for it to return consistent results: Given the same listener instance and the same node parameter, the method implementation should return the same result.- Parameters:
discoveryNode
- a node- Returns:
- true if the node is expected to send ack back, false otherwise
-
onAllNodesAcked
void onAllNodesAcked()Called once all the nodes have acknowledged the cluster state update request. Must be very lightweight execution, since it gets executed on the cluster service thread. -
onAckFailure
Called after all the nodes have acknowledged the cluster state update request but at least one of them failed. Must be very lightweight execution, since it gets executed on the cluster service thread.- Parameters:
e
- optional error that might have been thrown
-
onAckTimeout
void onAckTimeout()Called once the acknowledgement timeout defined byAckedClusterStateUpdateTask.ackTimeout()
has expired -
ackTimeout
TimeValue ackTimeout()- Returns:
- acknowledgement timeout, maximum time interval to wait for acknowledgements
-