ReplicatorGroupImpl (jraft-core 1.3.8 1.3.8 API)

java.lang.Object
- com.alipay.sofa.jraft.core.ReplicatorGroupImpl

所有已实现的接口:

ReplicatorGroup, Describer
```
public class ReplicatorGroupImpl
extends Object
implements ReplicatorGroup
```
Replicator group for a raft group.

作者:

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

嵌套类概要
- 从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer
  Describer.DefaultPrinter, Describer.Printer

构造器概要

构造器
构造器和说明

ReplicatorGroupImpl()

构造器
构造器和说明
`ReplicatorGroupImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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(PeerId peer, long maxMargin, long dueTime, CatchUpClosure done)` Wait the peer catchup.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.alipay.sofa.jraft.ReplicatorGroup
addReplicator, addReplicator

- 构造器详细资料
  - ReplicatorGroupImpl
```
public ReplicatorGroupImpl()
```
- 方法详细资料
  - init
```
public boolean init(NodeId nodeId,
                    ReplicatorGroupOptions opts)
```
    从接口复制的说明: ReplicatorGroup
    
    Init the replicator group.
    
    指定者:
    
    init 在接口中 ReplicatorGroup
    
    参数:
    
    nodeId - node id
    
    opts - options of replicator grop
    
    返回:
    
    true if init success
  - sendHeartbeat
```
public void sendHeartbeat(PeerId peer,
                          RpcResponseClosure<RpcRequests.AppendEntriesResponse> closure)
```
    从接口复制的说明: ReplicatorGroup
    
    Send heartbeat to a peer.
    
    指定者:
    
    sendHeartbeat 在接口中 ReplicatorGroup
    
    参数:
    
    peer - target peer
    
    closure - callback
  - getReplicator
```
public ThreadId getReplicator(PeerId peer)
```
    从接口复制的说明: ReplicatorGroup
    
    Get replicator id by peer, null if not found.
    
    指定者:
    
    getReplicator 在接口中 ReplicatorGroup
    
    参数:
    
    peer - peer of replicator
    
    返回:
    
    the replicator id
  - addReplicator
```
public boolean addReplicator(PeerId peer,
                             ReplicatorType replicatorType,
                             boolean sync)
```
    从接口复制的说明: 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.
    
    指定者:
    
    addReplicator 在接口中 ReplicatorGroup
    
    参数:
    
    peer - target peer
    
    replicatorType - replicator type
    
    sync - synchronous
    
    返回:
    
    true on success
  - clearFailureReplicators
```
public void clearFailureReplicators()
```
    从接口复制的说明: ReplicatorGroup
    
    Clear failure to start replicators
    
    指定者:
    
    clearFailureReplicators 在接口中 ReplicatorGroup
  - waitCaughtUp
```
public boolean waitCaughtUp(PeerId peer,
                            long maxMargin,
                            long dueTime,
                            CatchUpClosure done)
```
    从接口复制的说明: ReplicatorGroup
    
    Wait the peer catchup.
    
    指定者:
    
    waitCaughtUp 在接口中 ReplicatorGroup
  - getLastRpcSendTimestamp
```
public long getLastRpcSendTimestamp(PeerId peer)
```
    从接口复制的说明: ReplicatorGroup
    
    Get peer's last rpc send timestamp (monotonic time in milliseconds).
    
    指定者:
    
    getLastRpcSendTimestamp 在接口中 ReplicatorGroup
    
    参数:
    
    peer - the peer of replicator
  - stopAll
```
public boolean stopAll()
```
    从接口复制的说明: ReplicatorGroup
    
    Stop all replicators.
    
    指定者:
    
    stopAll 在接口中 ReplicatorGroup
  - checkReplicator
```
public void checkReplicator(PeerId peer,
                            boolean lockNode)
```
    从接口复制的说明: ReplicatorGroup
    
    Check replicator state, if it's not started, start it; if it is blocked, unblock it. It should be called by leader.
    
    指定者:
    
    checkReplicator 在接口中 ReplicatorGroup
    
    参数:
    
    peer - peer of replicator
    
    lockNode - if lock with node
  - stopReplicator
```
public boolean stopReplicator(PeerId peer)
```
    从接口复制的说明: ReplicatorGroup
    
    Stop replicator for the peer.
    
    指定者:
    
    stopReplicator 在接口中 ReplicatorGroup
    
    参数:
    
    peer - the peer of replicator
    
    返回:
    
    true on success
  - resetTerm
```
public boolean resetTerm(long newTerm)
```
    从接口复制的说明: 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
    
    指定者:
    
    resetTerm 在接口中 ReplicatorGroup
    
    参数:
    
    newTerm - new term num
    
    返回:
    
    true on success
  - resetHeartbeatInterval
```
public boolean resetHeartbeatInterval(int newIntervalMs)
```
    从接口复制的说明: 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.
    
    指定者:
    
    resetHeartbeatInterval 在接口中 ReplicatorGroup
    
    参数:
    
    newIntervalMs - new heartbeat interval millis
    
    返回:
    
    true on success
  - resetElectionTimeoutInterval
```
public boolean resetElectionTimeoutInterval(int newIntervalMs)
```
    从接口复制的说明: ReplicatorGroup
    
    Reset the interval of electionTimeout for replicator.
    
    指定者:
    
    resetElectionTimeoutInterval 在接口中 ReplicatorGroup
    
    参数:
    
    newIntervalMs - new election timeout millis
    
    返回:
    
    true on success
  - contains
```
public boolean contains(PeerId peer)
```
    从接口复制的说明: ReplicatorGroup
    
    Returns true if the there's a replicator attached to the given |peer|
    
    指定者:
    
    contains 在接口中 ReplicatorGroup
    
    参数:
    
    peer - target peer
    
    返回:
    
    true on contains
  - transferLeadershipTo
```
public boolean transferLeadershipTo(PeerId peer,
                                    long logIndex)
```
    从接口复制的说明: ReplicatorGroup
    
    Transfer leadership to the given |peer|
    
    指定者:
    
    transferLeadershipTo 在接口中 ReplicatorGroup
    
    参数:
    
    peer - target peer
    
    logIndex - log index
    
    返回:
    
    true on success
  - stopTransferLeadership
```
public boolean stopTransferLeadership(PeerId peer)
```
    从接口复制的说明: ReplicatorGroup
    
    Stop transferring leadership to the given |peer|
    
    指定者:
    
    stopTransferLeadership 在接口中 ReplicatorGroup
    
    参数:
    
    peer - target peer
    
    返回:
    
    true on success
  - stopAllAndFindTheNextCandidate
```
public ThreadId stopAllAndFindTheNextCandidate(ConfigurationEntry conf)
```
    从接口复制的说明: 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.
    
    指定者:
    
    stopAllAndFindTheNextCandidate 在接口中 ReplicatorGroup
    
    参数:
    
    conf - configuration of all replicators
    
    返回:
    
    candidate replicator id on success
  - findTheNextCandidate
```
public PeerId findTheNextCandidate(ConfigurationEntry conf)
```
    从接口复制的说明: 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.
    
    指定者:
    
    findTheNextCandidate 在接口中 ReplicatorGroup
    
    参数:
    
    conf - configuration of all replicators
    
    返回:
    
    the follower peerId on success
  - listReplicators
```
public List<ThreadId> listReplicators()
```
    从接口复制的说明: ReplicatorGroup
    
    Returns all replicators.
    
    指定者:
    
    listReplicators 在接口中 ReplicatorGroup
  - describe
```
public void describe(Describer.Printer out)
```
    指定者:
    
    describe 在接口中 Describer

类 ReplicatorGroupImpl

嵌套类概要

从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 com.alipay.sofa.jraft.ReplicatorGroup

构造器详细资料

ReplicatorGroupImpl

方法详细资料

init

sendHeartbeat

getReplicator

addReplicator

clearFailureReplicators

waitCaughtUp

getLastRpcSendTimestamp

stopAll

checkReplicator

stopReplicator

resetTerm

resetHeartbeatInterval

resetElectionTimeoutInterval

contains

transferLeadershipTo

stopTransferLeadership

stopAllAndFindTheNextCandidate

findTheNextCandidate

listReplicators

describe