X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2FReplicatedLog.java;h=71576f6d21b71fd02704e50d74e431f16a641f50;hb=872a40f7ac1f2e14a5848329c0827f1265931f6e;hp=85893333c2892eadf43e9aacc374f574c1b4a03a;hpb=139937c2e646894af6a9b2b8a8a1047c6ef82485;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 85893333c2..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,71 +8,77 @@ package org.opendaylight.controller.cluster.raft; -import com.google.protobuf.ByteString; - +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(); /** - * 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 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 log entry
+ * @param index the index of the first log entry to remove
+ * @return true if entries were removed, false otherwise
*/
- void removeFromAndPersist(long index);
+ boolean removeFromAndPersist(long index);
/**
- * Append an entry to the log
- * @param replicatedLogEntry
+ * Appends an entry to the log.
+ *
+ * @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 append(ReplicatedLogEntry replicatedLogEntry);
+ boolean append(ReplicatedLogEntry replicatedLogEntry);
/**
* Optimization method to increase the capacity of the journal log prior to appending entries.
@@ -82,31 +88,46 @@ 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
+ * @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.
*/
- void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
+ boolean appendAndPersist(@Nonnull ReplicatedLogEntry replicatedLogEntry,
+ @Nullable Procedure