public interface ClientRequestTracker {
/**
public interface ClientRequestTracker {
/**
- * The client actor who is waiting for a response
+ * @return the client actor that should be sent a response when consensus is achieved
*/
ActorRef getClientActor();
/**
*
*/
ActorRef getClientActor();
/**
*
+ * @return the identifier of the object that is to be replicated. For example a transaction identifier in the case
+ * of a transaction
*/
String getIdentifier();
/**
*/
String getIdentifier();
/**
- * The index of the log entry which needs to be replicated
+ * @return the index of the log entry that is to be replicated
/**
* Increment the value of the nextIndex
/**
* Increment the value of the nextIndex
+ *
+ * @return the new value of nextIndex
*/
long incrNextIndex();
/**
* Decrement the value of the nextIndex
*/
long incrNextIndex();
/**
* Decrement the value of the nextIndex
+ *
+ * @return the new value of nextIndex
/**
* Increment the value of the matchIndex
/**
* Increment the value of the matchIndex
+ *
+ * @return the new value of matchIndex
*/
long incrMatchIndex();
*/
long incrMatchIndex();
boolean setMatchIndex(long matchIndex);
/**
boolean setMatchIndex(long matchIndex);
/**
- * The identifier of the follower
- * This could simply be the url of the remote actor
+ *
+ * @return the identifier of the follower. This could simply be the url of the remote actor.
- * for each server, index of the next log entry
- * to send to that server (initialized to leader
- * last log index + 1)
+ * @return index of the next log entry to send to that server (initialized to leader last log index + 1)
*/
long getNextIndex();
/**
*/
long getNextIndex();
/**
- * for each server, index of highest log entry
- * known to be replicated on server
- * (initialized to 0, increases monotonically)
+ * @return index of highest log entry known to be replicated on server (initialized to 0, increases monotonically)
*/
long getMatchIndex();
/**
* Checks if the follower is active by comparing the last updated with the duration
*/
long getMatchIndex();
/**
* Checks if the follower is active by comparing the last updated with the duration
+ *
+ * @return true if follower is active, false otherwise
*/
boolean isFollowerActive();
*/
boolean isFollowerActive();
/**
* This will return the active time of follower, since it was last reset
/**
* This will return the active time of follower, since it was last reset
- * @return time in milliseconds
+ *
+ * @return time in milliseconds since the last activity from the follower
*/
long timeSinceLastActivity();
/**
* This method checks if it is ok to replicate
*
*/
long timeSinceLastActivity();
/**
* This method checks if it is ok to replicate
*
- * @return true if it is ok to replicate
+ * @return true if it is ok to replicate, false otherwise
*/
boolean okToReplicate();
/**
*/
boolean okToReplicate();
/**
- * Returns the payload data version of the follower.
+ * @return the payload data version of the follower.
*/
short getPayloadVersion();
*/
short getPayloadVersion();
public interface RaftActorContext {
/**
* Create a new local actor
public interface RaftActorContext {
/**
* Create a new local actor
- * @param props
- * @return
+ * @param props
+ * @return a reference to the newly created actor
*/
ActorRef actorOf(Props props);
/**
* Create a actor selection
* @param path
*/
ActorRef actorOf(Props props);
/**
* Create a actor selection
* @param path
+ * @return an actor selection for the given actor path
*/
ActorSelection actorSelection(String path);
*/
ActorSelection actorSelection(String path);
* Get the identifier for the RaftActor. This identifier represents the
* name of the actor whose common state is being shared. For example the
* id could be 'inventory'
* Get the identifier for the RaftActor. This identifier represents the
* name of the actor whose common state is being shared. For example the
* id could be 'inventory'
* @return the identifier
*/
String getId();
/**
* @return the identifier
*/
String getId();
/**
- * A reference to the RaftActor itself. This could be used to send messages
+ * @return A reference to the RaftActor itself. This could be used to send messages
*/
ActorRef getActor();
/**
*/
ActorRef getActor();
/**
- * Get the ElectionTerm information
- * @return
+ * @return the ElectionTerm information
*/
ElectionTerm getTermInformation();
/**
*/
ElectionTerm getTermInformation();
/**
- * index of highest log entry known to be
- * committed (initialized to 0, increases
- * monotonically)
- * @return
+ * @return index of highest log entry known to be committed (initialized to 0, increases monotonically)
*/
long getCommitIndex();
/**
*/
long getCommitIndex();
/**
+ * @param commitIndex new commit index
*/
void setCommitIndex(long commitIndex);
/**
*/
void setCommitIndex(long commitIndex);
/**
- * index of highest log entry applied to state
- * machine (initialized to 0, increases
- * monotonically)
- * @return
+ * @return index of highest log entry applied to state machine (initialized to 0, increases monotonically)
*/
long getLastApplied();
/**
*/
long getLastApplied();
/**
+ * @param lastApplied the index of the last log entry that was applied to the state
*/
void setLastApplied(long lastApplied);
/**
*
*/
void setLastApplied(long lastApplied);
/**
*
+ * @param replicatedLog the replicated log of the current RaftActor
*/
void setReplicatedLog(ReplicatedLog replicatedLog);
*/
void setReplicatedLog(ReplicatedLog replicatedLog);
ActorSystem getActorSystem();
/**
ActorSystem getActorSystem();
/**
- * Get the logger to be used for logging messages
- *
- * @return
+ * @return the logger to be used for logging messages to a log file
*/
Logger getLogger();
/**
*/
Logger getLogger();
/**
- * Get a mapping of peerId's to their addresses
- *
- * @return
+ * @return a mapping of peerId's to their addresses
*
*/
Map<String, String> getPeerAddresses();
*
*/
Map<String, String> getPeerAddresses();
* @param name
* @param address
*/
* @param name
* @param address
*/
*/
ConfigParams getConfigParams();
*/
ConfigParams getConfigParams();
+ /**
+ *
+ * @return the SnapshotManager for this RaftActor
+ */
SnapshotManager getSnapshotManager();
SnapshotManager getSnapshotManager();
+ /**
+ *
+ * @return the DataPersistenceProvider for this RaftActor
+ */
DataPersistenceProvider getPersistenceProvider();
DataPersistenceProvider getPersistenceProvider();
+ /**
+ *
+ * @return true if the RaftActor has followers else false
+ */
+ /**
+ *
+ * @return the total memory used by the ReplicatedLog
+ */
+ /**
+ *
+ * @param retriever a supplier of the total memory metric
+ */
@VisibleForTesting
void setTotalMemoryRetriever(Supplier<Long> retriever);
@VisibleForTesting
void setTotalMemoryRetriever(Supplier<Long> retriever);
+ /**
+ *
+ * @return the payload version to be used when replicating data
+ */
short getPayloadVersion();
}
short getPayloadVersion();
}
* The persisted information would then be used during recovery to properly
* reconstruct the state of the in-memory replicated log
*
* The persisted information would then be used during recovery to properly
* reconstruct the state of the in-memory replicated log
*
- * @param the index of the first log entry to remove
+ * @param index the index of the first log entry to remove
*/
void removeFromAndPersist(long index);
*/
void removeFromAndPersist(long index);
+ * @return the number of entries in the journal
*/
public interface ReplicatedLogEntry {
/**
*/
public interface ReplicatedLogEntry {
/**
- * The data stored in that entry
+ * @return The payload/data to be replicated
*/
Payload getData();
/**
*/
Payload getData();
/**
- * The term stored in that entry
+ * @return The term of the entry
- * The index of the entry
+ * @return The index of the entry
- * The size of the entry in bytes.
- * An approximate number may be good enough.
- *
- * @return
+ * @return The size of the entry in bytes. An approximate number may be good enough.
public interface SnapshotState {
/**
public interface SnapshotState {
/**
- * Should return true when a snapshot is being captured
- * @return
+ * @return true when a snapshot is being captured
*/
boolean isCapturing();
*/
boolean isCapturing();
*
* @param sender The actor that sent this message
* @param appendEntries The AppendEntries message
*
* @param sender The actor that sent this message
* @param appendEntries The AppendEntries message
+ * @return a new behavior if it was changed or the current behavior
*/
protected abstract RaftActorBehavior handleAppendEntries(ActorRef sender,
AppendEntries appendEntries);
*/
protected abstract RaftActorBehavior handleAppendEntries(ActorRef sender,
AppendEntries appendEntries);
*
* @param sender
* @param appendEntries
*
* @param sender
* @param appendEntries
+ * @return a new behavior if it was changed or the current behavior
*/
protected RaftActorBehavior appendEntries(ActorRef sender,
AppendEntries appendEntries) {
*/
protected RaftActorBehavior appendEntries(ActorRef sender,
AppendEntries appendEntries) {
*
* @param sender The actor that sent this message
* @param appendEntriesReply The AppendEntriesReply message
*
* @param sender The actor that sent this message
* @param appendEntriesReply The AppendEntriesReply message
+ * @return a new behavior if it was changed or the current behavior
*/
protected abstract RaftActorBehavior handleAppendEntriesReply(ActorRef sender,
AppendEntriesReply appendEntriesReply);
*/
protected abstract RaftActorBehavior handleAppendEntriesReply(ActorRef sender,
AppendEntriesReply appendEntriesReply);
*
* @param sender
* @param requestVote
*
* @param sender
* @param requestVote
+ * @return a new behavior if it was changed or the current behavior
*/
protected RaftActorBehavior requestVote(ActorRef sender, RequestVote requestVote) {
*/
protected RaftActorBehavior requestVote(ActorRef sender, RequestVote requestVote) {
*
* @param sender The actor that sent this message
* @param requestVoteReply The RequestVoteReply message
*
* @param sender The actor that sent this message
* @param requestVoteReply The RequestVoteReply message
+ * @return a new behavior if it was changed or the current behavior
*/
protected abstract RaftActorBehavior handleRequestVoteReply(ActorRef sender,
RequestVoteReply requestVoteReply);
/**
*/
protected abstract RaftActorBehavior handleRequestVoteReply(ActorRef sender,
RequestVoteReply requestVoteReply);
/**
- * Creates a random election duration
+ * @return a random election duration
*/
protected FiniteDuration electionDuration() {
long variance = new Random().nextInt(context.getConfigParams().getElectionTimeVariance());
*/
protected FiniteDuration electionDuration() {
long variance = new Random().nextInt(context.getConfigParams().getElectionTimeVariance());
/**
* schedule a new election
*
/**
* schedule a new election
*
+ * @param interval the duration after which we should trigger a new election
*/
protected void scheduleElection(FiniteDuration interval) {
stopElection();
*/
protected void scheduleElection(FiniteDuration interval) {
stopElection();
- * Get the current term
- * @return
+ * @return the current term
*/
protected long currentTerm() {
return context.getTermInformation().getCurrentTerm();
}
/**
*/
protected long currentTerm() {
return context.getTermInformation().getCurrentTerm();
}
/**
- * Get the candidate for whom we voted in the current term
- * @return
+ * @return the candidate for whom we voted in the current term
*/
protected String votedFor() {
return context.getTermInformation().getVotedFor();
}
/**
*/
protected String votedFor() {
return context.getTermInformation().getVotedFor();
}
/**
- * Get the actor associated with this behavior
- * @return
+ * @return the actor associated with this behavior
*/
protected ActorRef actor() {
return context.getActor();
}
/**
*/
protected ActorRef actor() {
return context.getActor();
}
/**
- * Get the term from the last entry in the log
+ * @return the term from the last entry in the log
*/
protected long lastTerm() {
return context.getReplicatedLog().lastTerm();
}
/**
*/
protected long lastTerm() {
return context.getReplicatedLog().lastTerm();
}
/**
- * Get the index from the last entry in the log
- *
- * @return
+ * @return the index from the last entry in the log
*/
protected long lastIndex() {
return context.getReplicatedLog().lastIndex();
}
/**
*/
protected long lastIndex() {
return context.getReplicatedLog().lastIndex();
}
/**
- * Find the client request tracker for a specific logIndex
- *
+ * @return the client request tracker for the specified logIndex
*/
protected ClientRequestTracker findClientRequestTracker(long logIndex) {
return null;
}
/**
*/
protected ClientRequestTracker findClientRequestTracker(long logIndex) {
return null;
}
/**
- * Find the client request tracker for a specific logIndex
- *
+ * @return the client request tracker for the specified logIndex
*/
protected ClientRequestTracker removeClientRequestTracker(long logIndex) {
return null;
*/
protected ClientRequestTracker removeClientRequestTracker(long logIndex) {
return null;
- * Find the log index from the previous to last entry in the log
+ * @return log index from the previous to last entry in the log
*/
protected long prevLogIndex(long index){
ReplicatedLogEntry prevEntry =
*/
protected long prevLogIndex(long index){
ReplicatedLogEntry prevEntry =
- * Find the log term from the previous to last entry in the log
- * @return
+ * @return log term from the previous to last entry in the log
*/
protected long prevLogTerm(long index){
ReplicatedLogEntry prevEntry =
*/
protected long prevLogTerm(long index){
ReplicatedLogEntry prevEntry =
RaftActorBehavior handleMessage(ActorRef sender, Object message);
/**
RaftActorBehavior handleMessage(ActorRef sender, Object message);
/**
- * The state associated with a given behavior
+ * @return The state associated with a given behavior
*/
RaftState state();
/**
*
*/
RaftState state();
/**
*
+ * @return The Id of the Leader if known else null
void setReplicatedToAllIndex(long replicatedToAllIndex);
/**
void setReplicatedToAllIndex(long replicatedToAllIndex);
/**
- * getting the index of the log entry which is replicated to all nodes
- * @return
+ * @return the index of the log entry which is replicated to all nodes
*/
long getReplicatedToAllIndex();
/**
*/
long getReplicatedToAllIndex();
/**
- * Returns the leader's payload data version.
+ * @return the leader's payload data version.
*/
short getLeaderPayloadVersion();
}
*/
short getLeaderPayloadVersion();
}
Code Review / controller.git / commitdiff