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=2b527db174300d593126c112b6ce491b06da8235;hb=c9943f5bc72d4cde9356d3bd4cf73d36f4b2f754;hp=82d0839bee772bd8efba88a8d1392ab1d336ff1c;hpb=6bfcbfc5158130c4255b861cb02dfaa68c52aa63;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 82d0839bee..2b527db174 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,69 +8,76 @@ 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. */ + @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 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 + * @return */ - 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. @@ -80,26 +87,42 @@ 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); /** + * 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 getFrom(long index); + void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure callback); /** + * Returns a list of log entries starting from the given index to the end of the log. * - * @param index the index of the log entry + * @param index the index of the first log entry to get. + * @return the List of entries */ - List getFrom(long index, int max); + @Nonnull List getFrom(long index); /** + * Returns a list of log entries starting from the given index up to the given maximum of entries or + * the given maximum accumulated size, whichever comes first. * - * @return + * @param index the index of the first log entry to get + * @param maxEntries the maximum number of entries to get + * @param maxDataSize the maximum accumulated size of the log entries to get + * @return the List of entries meeting the criteria. + */ + @Nonnull List getFrom(long index, int maxEntries, long maxDataSize); + + /** + * + * @return the number of entries in the journal */ long size(); @@ -173,8 +196,16 @@ public interface ReplicatedLog { void snapshotRollback(); /** - * Size of the data in the log (in bytes) + * Returns the size of the data in the log (in bytes) + * + * @return the size of the data in the log (in bytes). */ int dataSize(); + /** + * Determines if a snapshot need to be captured based on the count/memory consumed. + * + * @param replicatedLogEntry the last log entry. + */ + void captureSnapshotIfReady(ReplicatedLogEntry replicatedLogEntry); }