org.neo4j.causalclustering.core.consensus.outcome

Class Outcome

java.lang.Object

org.neo4j.causalclustering.core.consensus.outcome.Outcome

All Implemented Interfaces:

ConsensusOutcome, Message

public class Outcome
extends Object
implements Message, ConsensusOutcome

Holds the outcome of a RAFT role's handling of a message. The role handling logic is stateless and responds to RAFT messages in the context of a supplied state. The outcome is later consumed to update the state and do operations embedded as commands within the outcome. A state update could be to change role, change term, etc. A command could be to append to the RAFT log, tell the log shipper that there was a mismatch, etc.

Field Summary

Fields inherited from interface org.neo4j.causalclustering.messaging.Message

CURRENT_VERSION

Constructor Summary

Constructors

Constructor and Description
Outcome(Role nextRole, long term, MemberId leader, long leaderCommit, MemberId votedFor, Set<MemberId> votesForMe, long lastLogIndexBeforeWeBecameLeader, FollowerStates<MemberId> followerStates, boolean renewElectionTimeout, Collection<RaftLogCommand> logCommands, Collection<RaftMessages.Directed> outgoingMessages, Collection<ShipCommand> shipCommands, long commitIndex)
Outcome(Role currentRole, ReadableRaftState ctx)

Method Summary

Modifier and Type	Method and Description
void	addLogCommand(RaftLogCommand logCommand)
void	addOutgoingMessage(RaftMessages.Directed message)
void	addShipCommand(ShipCommand shipCommand)
void	addVoteForMe(MemberId voteFrom)
void	electedLeader()
boolean	electionTimeoutRenewed()
long	getCommitIndex()
FollowerStates<MemberId>	getFollowerStates()
long	getLastLogIndexBeforeWeBecameLeader()
MemberId	getLeader()
long	getLeaderCommit()
Collection<RaftLogCommand>	getLogCommands()
Collection<RaftMessages.Directed>	getOutgoingMessages()
Role	getRole()
Collection<ShipCommand>	getShipCommands()
long	getTerm()
MemberId	getVotedFor()
Set<MemberId>	getVotesForMe()
boolean	isElectedLeader()
boolean	isSteppingDown()
void	markNeedForFreshSnapshot()
boolean	needsFreshSnapshot()
void	renewElectionTimeout()
void	replaceFollowerStates(FollowerStates<MemberId> followerStates)
void	setCommitIndex(long commitIndex)
void	setLastLogIndexBeforeWeBecameLeader(long lastLogIndexBeforeWeBecameLeader)
void	setLeader(MemberId leader)
void	setLeaderCommit(long leaderCommit)
void	setNextRole(Role nextRole)
void	setNextTerm(long nextTerm)
void	setVotedFor(MemberId votedFor)
void	steppingDown()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Outcome

public Outcome(Role currentRole,
               ReadableRaftState ctx)

Outcome

public Outcome(Role nextRole,
               long term,
               MemberId leader,
               long leaderCommit,
               MemberId votedFor,
               Set<MemberId> votesForMe,
               long lastLogIndexBeforeWeBecameLeader,
               FollowerStates<MemberId> followerStates,
               boolean renewElectionTimeout,
               Collection<RaftLogCommand> logCommands,
               Collection<RaftMessages.Directed> outgoingMessages,
               Collection<ShipCommand> shipCommands,
               long commitIndex)

Method Detail

setNextRole

public void setNextRole(Role nextRole)

setNextTerm

public void setNextTerm(long nextTerm)

setLeader

public void setLeader(MemberId leader)

setLeaderCommit

public void setLeaderCommit(long leaderCommit)

addLogCommand

public void addLogCommand(RaftLogCommand logCommand)

addOutgoingMessage

public void addOutgoingMessage(RaftMessages.Directed message)

setVotedFor

public void setVotedFor(MemberId votedFor)

renewElectionTimeout

public void renewElectionTimeout()

markNeedForFreshSnapshot

public void markNeedForFreshSnapshot()

addVoteForMe

public void addVoteForMe(MemberId voteFrom)

setLastLogIndexBeforeWeBecameLeader

public void setLastLogIndexBeforeWeBecameLeader(long lastLogIndexBeforeWeBecameLeader)

replaceFollowerStates

public void replaceFollowerStates(FollowerStates<MemberId> followerStates)

addShipCommand

public void addShipCommand(ShipCommand shipCommand)

electedLeader

public void electedLeader()

steppingDown

public void steppingDown()

toString

public String toString()

Overrides:

toString in class Object

getRole

public Role getRole()

getTerm

public long getTerm()

getLeader

public MemberId getLeader()

getLeaderCommit

public long getLeaderCommit()

getLogCommands

public Collection<RaftLogCommand> getLogCommands()

getOutgoingMessages

public Collection<RaftMessages.Directed> getOutgoingMessages()

getVotedFor

public MemberId getVotedFor()

electionTimeoutRenewed

public boolean electionTimeoutRenewed()

needsFreshSnapshot

public boolean needsFreshSnapshot()

Specified by:

needsFreshSnapshot in interface ConsensusOutcome

getVotesForMe

public Set<MemberId> getVotesForMe()

getLastLogIndexBeforeWeBecameLeader

public long getLastLogIndexBeforeWeBecameLeader()

getFollowerStates

public FollowerStates<MemberId> getFollowerStates()

getShipCommands

public Collection<ShipCommand> getShipCommands()

isElectedLeader

public boolean isElectedLeader()

isSteppingDown

public boolean isSteppingDown()

getCommitIndex

public long getCommitIndex()

Specified by:

getCommitIndex in interface ConsensusOutcome

setCommitIndex

public void setCommitIndex(long commitIndex)