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=73ab6ea66cfcbd04e835edf18f7e2210c5795b65;hp=e6e160bc02bf1fd72305325aefc91a1ac2a9fac0;hb=b0f8283587b5cc8573d29f66219cbe7f70e21e1b;hpb=5c7fe226016d6997f411601502589e86ad9d8f87 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 e6e160bc02..73ab6ea66c 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,96 +8,127 @@ 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(); /** - * 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 + */ + boolean removeFromAndPersist(long index); + + /** + * 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 removeFromAndPersist(long index); + boolean append(ReplicatedLogEntry replicatedLogEntry); /** - * Append an entry to the log - * @param replicatedLogEntry + * Optimization method to increase the capacity of the journal log prior to appending entries. + * + * @param amount the amount to increase by */ - void append(ReplicatedLogEntry replicatedLogEntry); + 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); /** + * Appends an entry to the in-memory log and persists it as well. * - * @param index the index of the log entry + * @param replicatedLogEntry the entry to append + * @param callback the Procedure to be notified when persistence is complete. */ - List