com.alipay.sofa.jraft.core

Class ReplicatorGroupImpl

java.lang.Object

com.alipay.sofa.jraft.core.ReplicatorGroupImpl

All Implemented Interfaces:

ReplicatorGroup, Describer

public class ReplicatorGroupImpl
extends Object
implements ReplicatorGroup

Replicator group for a raft group.

Author:

boyan (boyan@alibaba-inc.com) 2018-Apr-04 1:54:51 PM

Nested Class Summary

Nested classes/interfaces inherited from interface com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

Constructor Summary

Constructors

Constructor and Description
ReplicatorGroupImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addReplicator(PeerId peer, ReplicatorType replicatorType, boolean sync) Try to add a replicator attached with |peer| will be a notification when the replicator catches up according to the arguments.
void	checkReplicator(PeerId peer, boolean lockNode) Check replicator state, if it's not started, start it; if it is blocked, unblock it.
void	clearFailureReplicators() Clear failure to start replicators
boolean	contains(PeerId peer) Returns true if the there's a replicator attached to the given |peer|
void	describe(Describer.Printer out)
PeerId	findTheNextCandidate(ConfigurationEntry conf) Find the follower with the most log entries in this group, which is likely becomes the leader according to the election algorithm of raft.
long	getLastRpcSendTimestamp(PeerId peer) Get peer's last rpc send timestamp (monotonic time in milliseconds).
ThreadId	getReplicator(PeerId peer) Get replicator id by peer, null if not found.
boolean	init(NodeId nodeId, ReplicatorGroupOptions opts) Init the replicator group.
List<ThreadId>	listReplicators() Returns all replicators.
boolean	resetElectionTimeoutInterval(int newIntervalMs) Reset the interval of electionTimeout for replicator.
boolean	resetHeartbeatInterval(int newIntervalMs) Reset the interval of heartbeat, This method is supposed to be called when the very candidate becomes the leader, so we suppose that there are no running replicators.
boolean	resetTerm(long newTerm) Reset the term of all to-add replicators.
void	sendHeartbeat(PeerId peer, RpcResponseClosure<RpcRequests.AppendEntriesResponse> closure) Send heartbeat to a peer.
boolean	stopAll() Stop all replicators.
ThreadId	stopAllAndFindTheNextCandidate(ConfigurationEntry conf) Stop all the replicators except for the one that we think can be the candidate of the next leader, which has the largest `last_log_id' among peers in |current_conf|.
boolean	stopReplicator(PeerId peer) Stop replicator for the peer.
boolean	stopTransferLeadership(PeerId peer) Stop transferring leadership to the given |peer|
boolean	transferLeadershipTo(PeerId peer, long logIndex) Transfer leadership to the given |peer|
boolean	waitCaughtUp(String groupId, PeerId peer, long maxMargin, long dueTime, CatchUpClosure done) Wait the peer catchup.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alipay.sofa.jraft.ReplicatorGroup

addReplicator, addReplicator

Constructor Detail

ReplicatorGroupImpl

public ReplicatorGroupImpl()

Method Detail

init

public boolean init(NodeId nodeId,
                    ReplicatorGroupOptions opts)

Description copied from interface: ReplicatorGroup

Init the replicator group.

Specified by:

init in interface ReplicatorGroup

Parameters:

nodeId - node id

opts - options of replicator group

Returns:

true if init success

sendHeartbeat

public void sendHeartbeat(PeerId peer,
                          RpcResponseClosure<RpcRequests.AppendEntriesResponse> closure)

Description copied from interface: ReplicatorGroup

Send heartbeat to a peer.

Specified by:

sendHeartbeat in interface ReplicatorGroup

Parameters:

peer - target peer

closure - callback

getReplicator

public ThreadId getReplicator(PeerId peer)

Description copied from interface: ReplicatorGroup

Get replicator id by peer, null if not found.

Specified by:

getReplicator in interface ReplicatorGroup

Parameters:

peer - peer of replicator

Returns:

the replicator id

addReplicator

public boolean addReplicator(PeerId peer,
                             ReplicatorType replicatorType,
                             boolean sync)

Description copied from interface: ReplicatorGroup

Try to add a replicator attached with |peer| will be a notification when the replicator catches up according to the arguments. NOTE: when calling this function, the replicators starts to work immediately, and might call Node#stepDown which might have race with the caller, you should deal with this situation.

Specified by:

addReplicator in interface ReplicatorGroup

Parameters:

peer - target peer

replicatorType - replicator type

sync - synchronous

Returns:

true on success

clearFailureReplicators

public void clearFailureReplicators()

Description copied from interface: ReplicatorGroup

Clear failure to start replicators

Specified by:

clearFailureReplicators in interface ReplicatorGroup

waitCaughtUp

public boolean waitCaughtUp(String groupId,
                            PeerId peer,
                            long maxMargin,
                            long dueTime,
                            CatchUpClosure done)

Description copied from interface: ReplicatorGroup

Wait the peer catchup.

Specified by:

waitCaughtUp in interface ReplicatorGroup

getLastRpcSendTimestamp

public long getLastRpcSendTimestamp(PeerId peer)

Description copied from interface: ReplicatorGroup

Get peer's last rpc send timestamp (monotonic time in milliseconds).

Specified by:

getLastRpcSendTimestamp in interface ReplicatorGroup

Parameters:

peer - the peer of replicator

stopAll

public boolean stopAll()

Description copied from interface: ReplicatorGroup

Stop all replicators.

Specified by:

stopAll in interface ReplicatorGroup

checkReplicator

public void checkReplicator(PeerId peer,
                            boolean lockNode)

Description copied from interface: ReplicatorGroup

Check replicator state, if it's not started, start it; if it is blocked, unblock it. It should be called by leader.

Specified by:

checkReplicator in interface ReplicatorGroup

Parameters:

peer - peer of replicator

lockNode - if lock with node

stopReplicator

public boolean stopReplicator(PeerId peer)

Description copied from interface: ReplicatorGroup

Stop replicator for the peer.

Specified by:

stopReplicator in interface ReplicatorGroup

Parameters:

peer - the peer of replicator

Returns:

true on success

resetTerm

public boolean resetTerm(long newTerm)

Description copied from interface: ReplicatorGroup

Reset the term of all to-add replicators. This method is supposed to be called when the very candidate becomes the leader, so we suppose that there are no running replicators. Return true on success, false otherwise

Specified by:

resetTerm in interface ReplicatorGroup

Parameters:

newTerm - new term num

Returns:

true on success

resetHeartbeatInterval

public boolean resetHeartbeatInterval(int newIntervalMs)

Description copied from interface: ReplicatorGroup

Reset the interval of heartbeat, This method is supposed to be called when the very candidate becomes the leader, so we suppose that there are no running replicators. return true when success, false otherwise.

Specified by:

resetHeartbeatInterval in interface ReplicatorGroup

Parameters:

newIntervalMs - new heartbeat interval millis

Returns:

true on success

resetElectionTimeoutInterval

public boolean resetElectionTimeoutInterval(int newIntervalMs)

Description copied from interface: ReplicatorGroup

Reset the interval of electionTimeout for replicator.

Specified by:

resetElectionTimeoutInterval in interface ReplicatorGroup

Parameters:

newIntervalMs - new election timeout millis

Returns:

true on success

contains

public boolean contains(PeerId peer)

Description copied from interface: ReplicatorGroup

Returns true if the there's a replicator attached to the given |peer|

Specified by:

contains in interface ReplicatorGroup

Parameters:

peer - target peer

Returns:

true on contains

transferLeadershipTo

public boolean transferLeadershipTo(PeerId peer,
                                    long logIndex)

Description copied from interface: ReplicatorGroup

Transfer leadership to the given |peer|

Specified by:

transferLeadershipTo in interface ReplicatorGroup

Parameters:

peer - target peer

logIndex - log index

Returns:

true on success

stopTransferLeadership

public boolean stopTransferLeadership(PeerId peer)

Description copied from interface: ReplicatorGroup

Stop transferring leadership to the given |peer|

Specified by:

stopTransferLeadership in interface ReplicatorGroup

Parameters:

peer - target peer

Returns:

true on success

stopAllAndFindTheNextCandidate

public ThreadId stopAllAndFindTheNextCandidate(ConfigurationEntry conf)

Description copied from interface: ReplicatorGroup

Stop all the replicators except for the one that we think can be the candidate of the next leader, which has the largest `last_log_id' among peers in |current_conf|. |candidate| would be returned if we found one and the caller is responsible for stopping it, or an invalid value if we found none. Returns candidate replicator id on success and null otherwise.

Specified by:

stopAllAndFindTheNextCandidate in interface ReplicatorGroup

Parameters:

conf - configuration of all replicators

Returns:

candidate replicator id on success

findTheNextCandidate

public PeerId findTheNextCandidate(ConfigurationEntry conf)

Description copied from interface: ReplicatorGroup

Find the follower with the most log entries in this group, which is likely becomes the leader according to the election algorithm of raft. Returns the follower peerId on success and null otherwise.

Specified by:

findTheNextCandidate in interface ReplicatorGroup

Parameters:

conf - configuration of all replicators

Returns:

the follower peerId on success

listReplicators

public List<ThreadId> listReplicators()

Description copied from interface: ReplicatorGroup

Returns all replicators.

Specified by:

listReplicators in interface ReplicatorGroup

describe

public void describe(Describer.Printer out)

Specified by:

describe in interface Describer