* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft;
-import akka.japi.Procedure;
import java.util.List;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import java.util.function.Consumer;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
/**
* Represents the ReplicatedLog that needs to be kept in sync by the RaftActor.
* @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);
+ @Nullable ReplicatedLogEntry get(long index);
/**
* Return the last replicated log entry in the log or null of not found.
*
* @return the last replicated log entry in the log or null of not found.
*/
- @Nullable
- ReplicatedLogEntry last();
+ @Nullable ReplicatedLogEntry last();
/**
* Return the index of the last entry in the log or -1 if the log is empty.
* Appends an entry to the in-memory log and persists it as well.
*
* @param replicatedLogEntry the entry to append
+ * @param callback the callback 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. In either case the
+ * callback is guaranteed to execute in the context of the actor associated with this log.
+ * @return true if the entry was successfully appended, false otherwise.
*/
- void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
-
- /**
- * 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.
- */
- void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback);
+ boolean appendAndPersist(@NonNull ReplicatedLogEntry replicatedLogEntry,
+ @Nullable Consumer<ReplicatedLogEntry> callback, boolean doAsync);
/**
* Returns a list of log entries starting from the given index to the end of the log.
* @param index the index of the first log entry to get.
* @return the List of entries
*/
- @Nonnull List<ReplicatedLogEntry> getFrom(long index);
+ @NonNull List<ReplicatedLogEntry> getFrom(long index);
/**
* Returns a list of log entries starting from the given index up to the given maximum of entries or
* @param maxDataSize the maximum accumulated size of the log entries to get
* @return the List of entries meeting the criteria.
*/
- @Nonnull List<ReplicatedLogEntry> getFrom(long index, int maxEntries, long maxDataSize);
+ @NonNull List<ReplicatedLogEntry> getFrom(long index, int maxEntries, long maxDataSize);
/**
* Returns the number of entries in the journal.
void snapshotPreCommit(long snapshotCapturedIndex, long snapshotCapturedTerm);
/**
- * Sets the Replicated log to state after snapshot success.
+ * Sets the Replicated log to state after snapshot success. This method is equivalent to
+ * {@code snapshotCommit(true)}.
*/
- void snapshotCommit();
+ default void snapshotCommit() {
+ snapshotCommit(true);
+ }
+
+ /**
+ * Sets the Replicated log to state after snapshot success. Most users will want to use {@link #snapshotCommit()}
+ * instead.
+ *
+ * @param updateDataSize true if {@link #dataSize()} should also be updated
+ */
+ void snapshotCommit(boolean updateDataSize);
/**
* Restores the replicated log to a state in the event of a save snapshot failure.
int dataSize();
/**
- * Determines if a snapshot need to be captured based on the count/memory consumed.
+ * Determines if a snapshot needs to be captured based on the count/memory consumed and initiates the capture.
*
* @param replicatedLogEntry the last log entry.
*/
void captureSnapshotIfReady(ReplicatedLogEntry replicatedLogEntry);
+
+ /**
+ * Determines if a snapshot should be captured based on the count/memory consumed.
+ *
+ * @param logIndex the log index to use to determine if the log count has exceeded the threshold
+ * @return true if a snapshot should be captured, false otherwise
+ */
+ boolean shouldCaptureSnapshot(long logIndex);
}