CliService (jraft-core 1.3.8 1.3.8 API)

所有超级接口:

Lifecycle<CliOptions>

所有已知实现类:

CliServiceImpl
```
public interface CliService
extends Lifecycle<CliOptions>
```
Client command-line service

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-09 4:05:35 PM

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`Status`	`addLearners(String groupId, Configuration conf, List<PeerId> learners)` Add some new learners into the replicating group which consists of \|conf\|.
`Status`	`addPeer(String groupId, Configuration conf, PeerId peer)` Add a new peer into the replicating group which consists of \|conf\|.
`Status`	`changePeers(String groupId, Configuration conf, Configuration newPeers)` Gracefully change the peers of the replication group.
`List<PeerId>`	`getAliveLearners(String groupId, Configuration conf)` Ask all alive learners of the replication group.
`List<PeerId>`	`getAlivePeers(String groupId, Configuration conf)` Ask all alive peers of the replication group.
`Status`	`getLeader(String groupId, Configuration conf, PeerId leaderId)` Get the leader of the replication group.
`List<PeerId>`	`getLearners(String groupId, Configuration conf)` Ask all learners of the replication group.
`List<PeerId>`	`getPeers(String groupId, Configuration conf)` Ask all peers of the replication group.
`Status`	`learner2Follower(String groupId, Configuration conf, PeerId learner)` Converts the specified learner to follower of \|conf\|.
`Status`	`rebalance(Set<String> balanceGroupIds, Configuration conf, Map<String,PeerId> balancedLeaderIds)` Balance the number of leaders.
`Status`	`removeLearners(String groupId, Configuration conf, List<PeerId> learners)` Remove some learners from the replicating group which consists of \|conf\|.
`Status`	`removePeer(String groupId, Configuration conf, PeerId peer)` Remove a peer from the replicating group which consists of \|conf\|.
`Status`	`resetLearners(String groupId, Configuration conf, List<PeerId> learners)` Update learners set in the replicating group which consists of \|conf\|.
`Status`	`resetPeer(String groupId, PeerId peer, Configuration newPeers)` Reset the peer set of the target peer.
`Status`	`snapshot(String groupId, PeerId peer)` Ask the peer to dump a snapshot immediately.
`Status`	`transferLeader(String groupId, Configuration conf, PeerId peer)` Transfer the leader of the replication group to the target peer

从接口继承的方法 com.alipay.sofa.jraft.Lifecycle
init, shutdown

- 方法详细资料
  - addPeer
```
Status addPeer(String groupId,
               Configuration conf,
               PeerId peer)
```
    Add a new peer into the replicating group which consists of |conf|. return OK status when success.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    peer - peer to add
    
    返回:
    
    operation status
  - removePeer
```
Status removePeer(String groupId,
                  Configuration conf,
                  PeerId peer)
```
    Remove a peer from the replicating group which consists of |conf|. return OK status when success.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    peer - peer to remove
    
    返回:
    
    operation status
  - changePeers
```
Status changePeers(String groupId,
                   Configuration conf,
                   Configuration newPeers)
```
    Gracefully change the peers of the replication group.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    newPeers - new peers to change
    
    返回:
    
    operation status
  - resetPeer
```
Status resetPeer(String groupId,
                 PeerId peer,
                 Configuration newPeers)
```
    Reset the peer set of the target peer.
    
    参数:
    
    groupId - the raft group id
    
    peer - target peer
    
    newPeers - new peers to reset
    
    返回:
    
    operation status
  - addLearners
```
Status addLearners(String groupId,
                   Configuration conf,
                   List<PeerId> learners)
```
    Add some new learners into the replicating group which consists of |conf|. return OK status when success.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learners - learner peers to add
    
    返回:
    
    operation status
    
    从以下版本开始:
    
    1.3.0
  - removeLearners
```
Status removeLearners(String groupId,
                      Configuration conf,
                      List<PeerId> learners)
```
    Remove some learners from the replicating group which consists of |conf|. return OK status when success.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learners - learner peers to remove
    
    返回:
    
    operation status
    
    从以下版本开始:
    
    1.3.0
  - learner2Follower
```
Status learner2Follower(String groupId,
                        Configuration conf,
                        PeerId learner)
```
    Converts the specified learner to follower of |conf|. return OK status when success.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learner - learner peer
    
    返回:
    
    operation status
    
    从以下版本开始:
    
    1.3.8
  - resetLearners
```
Status resetLearners(String groupId,
                     Configuration conf,
                     List<PeerId> learners)
```
    Update learners set in the replicating group which consists of |conf|. return OK status when success.
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learners - learner peers to set
    
    返回:
    
    operation status
    
    从以下版本开始:
    
    1.3.0
  - transferLeader
```
Status transferLeader(String groupId,
                      Configuration conf,
                      PeerId peer)
```
    Transfer the leader of the replication group to the target peer
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    peer - target peer of new leader
    
    返回:
    
    operation status
  - snapshot
```
Status snapshot(String groupId,
                PeerId peer)
```
    Ask the peer to dump a snapshot immediately.
    
    参数:
    
    groupId - the raft group id
    
    peer - target peer
    
    返回:
    
    operation status
  - getLeader
```
Status getLeader(String groupId,
                 Configuration conf,
                 PeerId leaderId)
```
    Get the leader of the replication group.
    
    参数:
    
    groupId - the raft group id
    
    conf - configuration
    
    leaderId - id of leader
    
    返回:
    
    operation status
  - getPeers
```
List<PeerId> getPeers(String groupId,
                      Configuration conf)
```
    Ask all peers of the replication group.
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all peers of the replication group
  - getAlivePeers
```
List<PeerId> getAlivePeers(String groupId,
                           Configuration conf)
```
    Ask all alive peers of the replication group.
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all alive peers of the replication group
  - getLearners
```
List<PeerId> getLearners(String groupId,
                         Configuration conf)
```
    Ask all learners of the replication group.
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all learners of the replication group
    
    从以下版本开始:
    
    1.3.0
  - getAliveLearners
```
List<PeerId> getAliveLearners(String groupId,
                              Configuration conf)
```
    Ask all alive learners of the replication group.
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all alive learners of the replication group
  - rebalance
```
Status rebalance(Set<String> balanceGroupIds,
                 Configuration conf,
                 Map<String,PeerId> balancedLeaderIds)
```
    Balance the number of leaders.
    
    参数:
    
    balanceGroupIds - all raft group ids to balance
    
    conf - configuration of all nodes
    
    balancedLeaderIds - the result of all balanced leader ids
    
    返回:
    
    operation status

接口 CliService

方法概要

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

方法详细资料

addPeer

removePeer

changePeers

resetPeer

addLearners

removeLearners

learner2Follower

resetLearners

transferLeader

snapshot

getLeader

getPeers

getAlivePeers

getLearners

getAliveLearners

rebalance