org.neo4j.causalclustering.core.consensus.membership

Class RaftMembershipManager

java.lang.Object

org.neo4j.kernel.lifecycle.LifecycleAdapter

org.neo4j.causalclustering.core.consensus.membership.RaftMembershipManager

All Implemented Interfaces:

RaftMembership, RaftLogCommand.Handler, org.neo4j.kernel.lifecycle.Lifecycle

public class RaftMembershipManager
extends org.neo4j.kernel.lifecycle.LifecycleAdapter
implements RaftMembership, RaftLogCommand.Handler

This class drives raft membership changes by glueing together various components: - target membership from hazelcast - raft membership state machine - raft log events

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.causalclustering.core.consensus.membership.RaftMembership

RaftMembership.Listener

Nested classes/interfaces inherited from interface org.neo4j.kernel.lifecycle.Lifecycle

org.neo4j.kernel.lifecycle.Lifecycle.Delegate

Constructor Summary

Constructors

Constructor and Description
RaftMembershipManager(SendToMyself sendToMyself, RaftGroup.Builder<MemberId> memberSetBuilder, ReadableRaftLog raftLog, org.neo4j.logging.LogProvider logProvider, int expectedClusterSize, long electionTimeout, Clock clock, long catchupTimeout, StateStorage<RaftMembershipState> membershipStorage)

Method Summary

Modifier and Type	Method and Description
void	append(long baseIndex, RaftLogEntry... entries)
MembershipEntry	getCommitted()
void	install(MembershipEntry committed)
void	onFollowerStateChange(FollowerStates<MemberId> followerStates)
void	onRole(Role role)
void	processLog(long commitIndex, Collection<RaftLogCommand> logCommands)
void	prune(long pruneIndex)
void	registerListener(RaftMembership.Listener listener) Register a membership listener.
Set<MemberId>	replicationMembers()
void	setRecoverFromIndexSupplier(LongSupplier recoverFromIndexSupplier)
void	setTargetMembershipSet(Set<MemberId> targetMembers)
void	start()
void	truncate(long fromIndex)
Set<MemberId>	votingMembers()

Methods inherited from class org.neo4j.kernel.lifecycle.LifecycleAdapter

init, shutdown, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftMembershipManager

public RaftMembershipManager(SendToMyself sendToMyself,
                             RaftGroup.Builder<MemberId> memberSetBuilder,
                             ReadableRaftLog raftLog,
                             org.neo4j.logging.LogProvider logProvider,
                             int expectedClusterSize,
                             long electionTimeout,
                             Clock clock,
                             long catchupTimeout,
                             StateStorage<RaftMembershipState> membershipStorage)

Method Detail

setRecoverFromIndexSupplier

public void setRecoverFromIndexSupplier(LongSupplier recoverFromIndexSupplier)

start

public void start()
           throws IOException

Specified by:

start in interface org.neo4j.kernel.lifecycle.Lifecycle

Overrides:

start in class org.neo4j.kernel.lifecycle.LifecycleAdapter

Throws:

IOException

setTargetMembershipSet

public void setTargetMembershipSet(Set<MemberId> targetMembers)

onFollowerStateChange

public void onFollowerStateChange(FollowerStates<MemberId> followerStates)

onRole

public void onRole(Role role)

votingMembers

public Set<MemberId> votingMembers()

Specified by:

votingMembers in interface RaftMembership

Returns:

members whose votes count towards consensus. The returned set should be considered immutable.

replicationMembers

public Set<MemberId> replicationMembers()

Specified by:

replicationMembers in interface RaftMembership

Returns:

members to which replication should be attempted. The returned set should be considered immutable.

registerListener

public void registerListener(RaftMembership.Listener listener)

Description copied from interface: RaftMembership

Register a membership listener.

Specified by:

registerListener in interface RaftMembership

Parameters:

listener - The listener.

processLog

public void processLog(long commitIndex,
                       Collection<RaftLogCommand> logCommands)
                throws IOException

Throws:

IOException

append

public void append(long baseIndex,
                   RaftLogEntry... entries)
            throws IOException

Specified by:

append in interface RaftLogCommand.Handler

Throws:

IOException

truncate

public void truncate(long fromIndex)
              throws IOException

Specified by:

truncate in interface RaftLogCommand.Handler

Throws:

IOException

prune

public void prune(long pruneIndex)

Specified by:

prune in interface RaftLogCommand.Handler

getCommitted

public MembershipEntry getCommitted()

install

public void install(MembershipEntry committed)
             throws IOException

Throws:

IOException