org.neo4j.causalclustering.core.consensus

Class RaftMachine

java.lang.Object

org.neo4j.causalclustering.core.consensus.RaftMachine

All Implemented Interfaces:

CoreMetaData, LeaderLocator

public class RaftMachine
extends Object
implements LeaderLocator, CoreMetaData

Implements the Raft Consensus Algorithm. The algorithm is driven by incoming messages provided to handle(org.neo4j.causalclustering.core.consensus.RaftMessages.RaftMessage).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftMachine.BootstrapException
static class	RaftMachine.Timeouts

Constructor Summary

Constructors

Constructor and Description

RaftMachine(MemberId myself, StateStorage<TermState> termStorage, StateStorage<VoteState> voteStorage, RaftLog entryLog, long electionTimeout, long heartbeatInterval, RenewableTimeoutService renewableTimeoutService, Outbound<MemberId,RaftMessages.RaftMessage> outbound, org.neo4j.logging.LogProvider logProvider, RaftMembershipManager membershipManager, RaftLogShippingManager logShipping, InFlightMap<RaftLogEntry> inFlightMap, org.neo4j.kernel.monitoring.Monitors monitors)

Method Summary

Modifier and Type	Method and Description
RaftCoreState	coreState()
Role	currentRole()
MemberId	getLeader()
ConsensusOutcome	handle(RaftMessages.RaftMessage incomingMessage)
MemberId	identity()
void	installCoreState(RaftCoreState coreState)
boolean	isLeader()
RaftLogShippingManager	logShippingManager()
void	panic()
void	registerListener(org.neo4j.kernel.impl.util.Listener<MemberId> listener)
Set<MemberId>	replicationMembers()
void	setTargetMembershipSet(Set<MemberId> targetMembers)
ExposedRaftState	state() Every call to state() gives you an immutable copy of the current state.
long	term()
String	toString()
void	triggerElection()
void	unregisterListener(org.neo4j.kernel.impl.util.Listener listener)
Set<MemberId>	votingMembers()

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftMachine

public RaftMachine(MemberId myself,
                   StateStorage<TermState> termStorage,
                   StateStorage<VoteState> voteStorage,
                   RaftLog entryLog,
                   long electionTimeout,
                   long heartbeatInterval,
                   RenewableTimeoutService renewableTimeoutService,
                   Outbound<MemberId,RaftMessages.RaftMessage> outbound,
                   org.neo4j.logging.LogProvider logProvider,
                   RaftMembershipManager membershipManager,
                   RaftLogShippingManager logShipping,
                   InFlightMap<RaftLogEntry> inFlightMap,
                   org.neo4j.kernel.monitoring.Monitors monitors)

Method Detail

triggerElection

public void triggerElection()
                     throws IOException

Throws:

IOException

panic

public void panic()

coreState

public RaftCoreState coreState()

installCoreState

public void installCoreState(RaftCoreState coreState)
                      throws IOException

Throws:

IOException

setTargetMembershipSet

public void setTargetMembershipSet(Set<MemberId> targetMembers)

getLeader

public MemberId getLeader()
                   throws NoLeaderFoundException

Specified by:

getLeader in interface LeaderLocator

Throws:

NoLeaderFoundException

registerListener

public void registerListener(org.neo4j.kernel.impl.util.Listener<MemberId> listener)

Specified by:

registerListener in interface LeaderLocator

unregisterListener

public void unregisterListener(org.neo4j.kernel.impl.util.Listener listener)

Specified by:

unregisterListener in interface LeaderLocator

state

public ExposedRaftState state()

Every call to state() gives you an immutable copy of the current state.

Returns:

A fresh view of the state.

handle

public ConsensusOutcome handle(RaftMessages.RaftMessage incomingMessage)
                        throws IOException

Throws:

IOException

isLeader

public boolean isLeader()

Specified by:

isLeader in interface CoreMetaData

currentRole

public Role currentRole()

identity

public MemberId identity()

logShippingManager

public RaftLogShippingManager logShippingManager()

toString

public String toString()

Overrides:

toString in class Object

term

public long term()

votingMembers

public Set<MemberId> votingMembers()

replicationMembers

public Set<MemberId> replicationMembers()