X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2FReplicatedLog.java;h=ffa4cb117231f3f603e2cd8a51db3853fd9b2fe8;hb=15f11d24306fe2796411e8078a84fc82213bacf6;hp=3e4d727c7162a45fc32c942561d2599b61a45075;hpb=c58a4036d120482ce18f247bb1b283193cab60d1;p=controller.git 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 3e4d727c71..ffa4cb1172 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 @@ -10,66 +10,61 @@ 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 */ 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 + * @return the ReplicatedLogEntry if found, otherwise null if the adjusted index less than 0 or * greater than the size of the in-memory journal. */ - ReplicatedLogEntry get(long index); - + @Nullable ReplicatedLogEntry get(long index); /** - * Get the last replicated log entry - * - * @return + * Return the last replicated log entry in the log or null of not found. */ - ReplicatedLogEntry last(); + @Nullable ReplicatedLogEntry last(); /** - * - * @return + * Return the index of the last entry in the log or -1 if the log is empty. */ long lastIndex(); /** - * - * @return + * Return the term of the last entry in the log or -1 if the log is empty. */ long lastTerm(); /** - * To be called when we need to remove entries from the in-memory log. - * This method will remove all entries >= index. This method should be used - * during recovery to appropriately trim the log based on persisted - * information + * 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); /** - * To be called when we need to remove entries from the in-memory log and we - * need that information persisted to disk. This method will remove all - * entries >= index. + * Removes entries from the in-memory log a nd 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 log entry
+ * @param index the index of the first log entry to remove
*/
void removeFromAndPersist(long index);
/**
- * Append an entry to the log
- * @param replicatedLogEntry
+ * Appends an entry to the log.
+ *
+ * @param replicatedLogEntry the entry to append
*/
void append(ReplicatedLogEntry replicatedLogEntry);
@@ -81,28 +76,36 @@ public interface ReplicatedLog {
void increaseJournalLogCapacity(int amount);
/**
+ * Appends an entry to the in-memory log and persists it as well.
*
- * @param replicatedLogEntry
+ * @param replicatedLogEntry the entry to append
*/
void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure