Code Review
/
controller.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Bug 5740: Remove Serializable where not necessary
[controller.git]
/
opendaylight
/
md-sal
/
sal-akka-raft
/
src
/
main
/
java
/
org
/
opendaylight
/
controller
/
cluster
/
raft
/
SnapshotState.java
diff --git
a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotState.java
b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotState.java
index a6bcddfc137a104684d40fd3d301b5513c60ebb7..0a702741d8894ceb46386fba63d28ca39e1e51af 100644
(file)
--- a/
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotState.java
+++ b/
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotState.java
@@
-8,31
+8,40
@@
package org.opendaylight.controller.cluster.raft;
package org.opendaylight.controller.cluster.raft;
+import java.io.OutputStream;
+import java.util.Optional;
import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
+import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
+/**
+ * Interface for a snapshot phase state.
+ *
+ * @author Moiz Raja
+ * @author Thomas Pantelis
+ */
public interface SnapshotState {
/**
public interface SnapshotState {
/**
- * @return true when a snapshot is being captured
+ * Returns whether or not a capture is in progress.
+ *
+ * @return true when a snapshot is being captured, false otherwise
*/
boolean isCapturing();
/**
*/
boolean isCapturing();
/**
- * Initiate
capture snapshot
+ * Initiate
s a capture snapshot.
*
* @param lastLogEntry the last entry in the replicated log
* @param replicatedToAllIndex the current replicatedToAllIndex
*
* @param lastLogEntry the last entry in the replicated log
* @param replicatedToAllIndex the current replicatedToAllIndex
- *
* @return true if capture was started
*/
boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex);
/**
* @return true if capture was started
*/
boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex);
/**
- * Initiate capture snapshot for the purposing of installing that snapshot
- *
- * @param lastLogEntry
- * @param replicatedToAllIndex
- * @param targetFollower
+ * Initiates a capture snapshot for the purposing of installing the snapshot on a follower.
*
*
+ * @param lastLogEntry the last entry in the replicated log
+ * @param replicatedToAllIndex the current replicatedToAllIndex
+ * @param targetFollower the id of the follower on which to install
* @return true if capture was started
*/
boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower);
* @return true if capture was started
*/
boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower);
@@
-45,31
+54,32
@@
public interface SnapshotState {
void apply(ApplySnapshot snapshot);
/**
void apply(ApplySnapshot snapshot);
/**
- * Persist
the snapshot
+ * Persist
s a snapshot.
*
*
- * @param snapshotBytes
- * @param currentBehavior
- * @param totalMemory
+ * @param snapshotState the snapshot State
+ * @param installSnapshotStream Optional OutputStream that is present if the snapshot is to also be installed
+ * on a follower.
+ * @param totalMemory the total memory threshold
*/
*/
- void persist(
byte[] snapshotBytes
, long totalMemory);
+ void persist(
Snapshot.State snapshotState, Optional<OutputStream> installSnapshotStream
, long totalMemory);
/**
/**
- * Commit the snapshot by trimming the log
+ * Commit the snapshot by trimming the log
.
*
*
- * @param sequenceNumber
- * @param timeStamp
+ * @param sequenceNumber
the sequence number of the persisted snapshot
+ * @param timeStamp
the time stamp of the persisted snapshot
*/
void commit(long sequenceNumber, long timeStamp);
/**
*/
void commit(long sequenceNumber, long timeStamp);
/**
- * Roll
back the snapshot
+ * Roll
s back the snapshot on failure.
*/
void rollback();
/**
*/
void rollback();
/**
- * Trim
the log
+ * Trim
s the in-memory log.
*
*
- * @param desiredTrimIndex
+ * @param desiredTrimIndex
the desired index to trim from
* @return the actual trim index
*/
long trimLog(long desiredTrimIndex);
* @return the actual trim index
*/
long trimLog(long desiredTrimIndex);