com.alipay.sofa.jraft.rpc

接口 CliClientService

所有超级接口:

ClientService, Lifecycle<RpcOptions>

所有已知实现类:

CliClientServiceImpl

public interface CliClientService
extends ClientService

Cli RPC client service.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-09 11:15:13 AM

方法概要

限定符和类型	方法和说明
Future<com.google.protobuf.Message>	addLearners(Endpoint endpoint, CliRequests.AddLearnersRequest request, RpcResponseClosure<CliRequests.LearnersOpResponse> done) Add learners
Future<com.google.protobuf.Message>	addPeer(Endpoint endpoint, CliRequests.AddPeerRequest request, RpcResponseClosure<CliRequests.AddPeerResponse> done) Adds a peer.
Future<com.google.protobuf.Message>	changePeers(Endpoint endpoint, CliRequests.ChangePeersRequest request, RpcResponseClosure<CliRequests.ChangePeersResponse> done) Change peers.
Future<com.google.protobuf.Message>	getLeader(Endpoint endpoint, CliRequests.GetLeaderRequest request, RpcResponseClosure<CliRequests.GetLeaderResponse> done) Get the group leader.
Future<com.google.protobuf.Message>	getPeers(Endpoint endpoint, CliRequests.GetPeersRequest request, RpcResponseClosure<CliRequests.GetPeersResponse> done) Get all peers of the replication group.
Future<com.google.protobuf.Message>	removeLearners(Endpoint endpoint, CliRequests.RemoveLearnersRequest request, RpcResponseClosure<CliRequests.LearnersOpResponse> done) Remove learners
Future<com.google.protobuf.Message>	removePeer(Endpoint endpoint, CliRequests.RemovePeerRequest request, RpcResponseClosure<CliRequests.RemovePeerResponse> done) Removes a peer.
Future<com.google.protobuf.Message>	resetLearners(Endpoint endpoint, CliRequests.ResetLearnersRequest request, RpcResponseClosure<CliRequests.LearnersOpResponse> done) Reset learners
Future<com.google.protobuf.Message>	resetPeer(Endpoint endpoint, CliRequests.ResetPeerRequest request, RpcResponseClosure<RpcRequests.ErrorResponse> done) Reset a peer.
Future<com.google.protobuf.Message>	snapshot(Endpoint endpoint, CliRequests.SnapshotRequest request, RpcResponseClosure<RpcRequests.ErrorResponse> done) Do a snapshot.
Future<com.google.protobuf.Message>	transferLeader(Endpoint endpoint, CliRequests.TransferLeaderRequest request, RpcResponseClosure<RpcRequests.ErrorResponse> done) Transfer leadership to other peer.

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

checkConnection, connect, disconnect, invokeWithDone, isConnected

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

init, shutdown

方法详细资料

addPeer

Future<com.google.protobuf.Message> addPeer(Endpoint endpoint,
                                            CliRequests.AddPeerRequest request,
                                            RpcResponseClosure<CliRequests.AddPeerResponse> done)

Adds a peer.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

removePeer

Future<com.google.protobuf.Message> removePeer(Endpoint endpoint,
                                               CliRequests.RemovePeerRequest request,
                                               RpcResponseClosure<CliRequests.RemovePeerResponse> done)

Removes a peer.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

resetPeer

Future<com.google.protobuf.Message> resetPeer(Endpoint endpoint,
                                              CliRequests.ResetPeerRequest request,
                                              RpcResponseClosure<RpcRequests.ErrorResponse> done)

Reset a peer.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

snapshot

Future<com.google.protobuf.Message> snapshot(Endpoint endpoint,
                                             CliRequests.SnapshotRequest request,
                                             RpcResponseClosure<RpcRequests.ErrorResponse> done)

Do a snapshot.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

changePeers

Future<com.google.protobuf.Message> changePeers(Endpoint endpoint,
                                                CliRequests.ChangePeersRequest request,
                                                RpcResponseClosure<CliRequests.ChangePeersResponse> done)

Change peers.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

addLearners

Future<com.google.protobuf.Message> addLearners(Endpoint endpoint,
                                                CliRequests.AddLearnersRequest request,
                                                RpcResponseClosure<CliRequests.LearnersOpResponse> done)

Add learners

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

从以下版本开始:

1.3.0

removeLearners

Future<com.google.protobuf.Message> removeLearners(Endpoint endpoint,
                                                   CliRequests.RemoveLearnersRequest request,
                                                   RpcResponseClosure<CliRequests.LearnersOpResponse> done)

Remove learners

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

从以下版本开始:

1.3.0

resetLearners

Future<com.google.protobuf.Message> resetLearners(Endpoint endpoint,
                                                  CliRequests.ResetLearnersRequest request,
                                                  RpcResponseClosure<CliRequests.LearnersOpResponse> done)

Reset learners

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

从以下版本开始:

1.3.0

getLeader

Future<com.google.protobuf.Message> getLeader(Endpoint endpoint,
                                              CliRequests.GetLeaderRequest request,
                                              RpcResponseClosure<CliRequests.GetLeaderResponse> done)

Get the group leader.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

transferLeader

Future<com.google.protobuf.Message> transferLeader(Endpoint endpoint,
                                                   CliRequests.TransferLeaderRequest request,
                                                   RpcResponseClosure<RpcRequests.ErrorResponse> done)

Transfer leadership to other peer.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result

getPeers

Future<com.google.protobuf.Message> getPeers(Endpoint endpoint,
                                             CliRequests.GetPeersRequest request,
                                             RpcResponseClosure<CliRequests.GetPeersResponse> done)

Get all peers of the replication group.

参数:

endpoint - server address

request - request data

done - callback

返回:

a future with result