package org.opendaylight.controller.cluster.raft.behaviors;
import akka.actor.ActorRef;
+import javax.annotation.Nullable;
import org.opendaylight.controller.cluster.raft.RaftState;
/**
* In each of these behaviors the Raft Actor handles the same Raft messages
* differently.
*/
-public interface RaftActorBehavior {
+public interface RaftActorBehavior extends AutoCloseable{
+
/**
* Handle a message. If the processing of the message warrants a state
- * change then a new state should be returned otherwise this method should
- * return the state for the current behavior.
+ * change then a new behavior should be returned otherwise this method should
+ * return the current behavior.
*
* @param sender The sender of the message
* @param message A message that needs to be processed
*
- * @return The new state or self (this)
+ * @return The new behavior or current behavior, or null if the message was not handled.
+ */
+ @Nullable RaftActorBehavior handleMessage(ActorRef sender, Object message);
+
+ /**
+ *
+ * @return The state associated with a given behavior
+ */
+ RaftState state();
+
+ /**
+ *
+ * @return The Id of the Leader if known else null
+ */
+ String getLeaderId();
+
+ /**
+ * setting the index of the log entry which is replicated to all nodes
+ * @param replicatedToAllIndex
*/
- RaftState handleMessage(ActorRef sender, Object message);
+ void setReplicatedToAllIndex(long replicatedToAllIndex);
+
+ /**
+ * @return the index of the log entry which is replicated to all nodes
+ */
+ long getReplicatedToAllIndex();
+
+ /**
+ * @return the leader's payload data version.
+ */
+ short getLeaderPayloadVersion();
+
+ /**
+ * switchBehavior makes sure that the current behavior is shutdown before it switches to the new
+ * behavior
+ *
+ * @param behavior The new behavior to switch to
+ * @return The new behavior
+ */
+ RaftActorBehavior switchBehavior(RaftActorBehavior behavior);
+
+ @Override
+ void close();
}