X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2FReplicatedLog.java;h=71576f6d21b71fd02704e50d74e431f16a641f50;hp=3de0de5131ae6c9195128b73a873cf8ca25bb9bf;hb=1b0f84c4957e464bad6f7cb7350a8171c3d1621b;hpb=5924885ac74b5fa0c729004a5b66b30654a55496 diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java index 3de0de5131..71576f6d21 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java @@ -8,75 +8,126 @@ package org.opendaylight.controller.cluster.raft; +import akka.japi.Procedure; import java.util.List; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; /** - * Represents the ReplicatedLog that needs to be kept in sync by the RaftActor + * Represents the ReplicatedLog that needs to be kept in sync by the RaftActor. */ public interface ReplicatedLog { + long NO_MAX_SIZE = -1; + /** - * Get a replicated log entry at the specified index + * Return the replicated log entry at the specified index. * * @param index the index of the log entry - * @return the ReplicatedLogEntry at index. null if index less than 0 or - * greater than the size of the in-memory journal. + * @return the ReplicatedLogEntry if found, otherwise null if the adjusted index less than 0 or + * greater than the size of the in-memory journal */ + @Nullable ReplicatedLogEntry get(long index); - /** - * Get the last replicated log entry + * Return the last replicated log entry in the log or null of not found. * - * @return + * @return the last replicated log entry in the log or null of not found. */ + @Nullable ReplicatedLogEntry last(); /** + * Return the index of the last entry in the log or -1 if the log is empty. * - * @return + * @return the index of the last entry in the log or -1 if the log is empty. */ long lastIndex(); /** + * Return the term of the last entry in the log or -1 if the log is empty. * - * @return + * @return the term of the last entry in the log or -1 if the log is empty. */ long lastTerm(); /** - * Remove all the entries from the logs >= index + * Removes entries from the in-memory log starting at the given index. * - * @param index the index of the log entry + * @param index the index of the first log entry to remove + * @return the adjusted index of the first log entry removed or -1 if the log entry is not found. */ - void removeFrom(long index); + long removeFrom(long index); /** - * Append an entry to the log - * @param replicatedLogEntry + * Removes entries from the in-memory log and the persisted log starting at the given index. + * + *
+ * The persisted information would then be used during recovery to properly
+ * reconstruct the state of the in-memory replicated log
+ *
+ * @param index the index of the first log entry to remove
+ * @return true if entries were removed, false otherwise
*/
- void append(ReplicatedLogEntry replicatedLogEntry);
+ boolean removeFromAndPersist(long index);
/**
+ * Appends an entry to the log.
*
- * @param replicatedLogEntry
+ * @param replicatedLogEntry the entry to append
+ * @return true if the entry was successfully appended, false otherwise. An entry can fail to append if
+ * the index is already included in the log.
*/
- void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
+ boolean append(ReplicatedLogEntry replicatedLogEntry);
/**
+ * Optimization method to increase the capacity of the journal log prior to appending entries.
*
- * @param index the index of the log entry
+ * @param amount the amount to increase by
+ */
+ void increaseJournalLogCapacity(int amount);
+
+ /**
+ * Appends an entry to the in-memory log and persists it as well.
+ *
+ * @param replicatedLogEntry the entry to append
+ * @param callback the Procedure to be notified when persistence is complete (optional).
+ * @param doAsync if true, the persistent actor can receive subsequent messages to process in between the persist
+ * call and the execution of the associated callback. If false, subsequent messages are stashed and get
+ * delivered after persistence is complete and the associated callback is executed.
+ * @return true if the entry was successfully appended, false otherwise.
*/
- List