javadocs

Author: ywelsch

server/src/main/java/org/elasticsearch/discovery/Discovery.java

@@ -49,7 +49,19 @@ public interface Discovery extends LifecycleComponent {
     void publish(ClusterChangedEvent clusterChangedEvent, AckListener ackListener);
 
     interface AckListener {
+        /**
+         * Should be called when the discovery layer has committed the clusters state (i.e. even if this publication fails,
+         * it is guaranteed to appear in future publications).
+         * @param commitTime the time it took to commit the cluster state
+         */
         void onCommit(TimeValue commitTime);
+
+        /**
+         * Should be called whenever the discovery layer receives confirmation from a node that it has successfully applied
+         * the cluster state. In case of failures, an exception should be provided as parameter.
+         * @param node the node
+         * @param e the optional exception
+         */
         void onNodeAck(DiscoveryNode node, @Nullable Exception e);
     }