com.alipay.sofa.jraft.rpc.impl.core

Class DefaultRaftClientService

java.lang.Object

com.alipay.sofa.jraft.rpc.impl.AbstractClientService

com.alipay.sofa.jraft.rpc.impl.core.DefaultRaftClientService

All Implemented Interfaces:

Lifecycle<RpcOptions>, ClientService, RaftClientService

public class DefaultRaftClientService
extends AbstractClientService
implements RaftClientService

Raft rpc service based bolt.

Author:

boyan (boyan@alibaba-inc.com), jiachun.fjc

Field Summary

Fields inherited from class com.alipay.sofa.jraft.rpc.impl.AbstractClientService

LOG, rpcClient, rpcExecutor, rpcOptions

Constructor Summary

Constructors

Constructor and Description
DefaultRaftClientService(ReplicatorGroup rgGroup)
DefaultRaftClientService(ReplicatorGroup rgGroup, FixedThreadsExecutorGroup customAppendEntriesExecutors)

Method Summary

Modifier and Type	Method and Description
Future<com.google.protobuf.Message>	appendEntries(Endpoint endpoint, RpcRequests.AppendEntriesRequest request, int timeoutMs, RpcResponseClosure<RpcRequests.AppendEntriesResponse> done) Sends a append-entries request and handle the response with done.
protected void	configRpcClient(RpcClient rpcClient)
Future<com.google.protobuf.Message>	getFile(Endpoint endpoint, RpcRequests.GetFileRequest request, int timeoutMs, RpcResponseClosure<RpcRequests.GetFileResponse> done) Get a piece of file data by GetFileRequest, and handle the response with done.
boolean	init(RpcOptions rpcOptions) Initialize the service.
Future<com.google.protobuf.Message>	installSnapshot(Endpoint endpoint, RpcRequests.InstallSnapshotRequest request, RpcResponseClosure<RpcRequests.InstallSnapshotResponse> done) Sends a install-snapshot request and handle the response with done.
Future<com.google.protobuf.Message>	preVote(Endpoint endpoint, RpcRequests.RequestVoteRequest request, RpcResponseClosure<RpcRequests.RequestVoteResponse> done) Sends a pre-vote request and handle the response with done.
Future<com.google.protobuf.Message>	readIndex(Endpoint endpoint, RpcRequests.ReadIndexRequest request, int timeoutMs, RpcResponseClosure<RpcRequests.ReadIndexResponse> done) Send a read-index request and handle the response with done.
Future<com.google.protobuf.Message>	requestVote(Endpoint endpoint, RpcRequests.RequestVoteRequest request, RpcResponseClosure<RpcRequests.RequestVoteResponse> done) Sends a request-vote request and handle the response with done.
Future<com.google.protobuf.Message>	timeoutNow(Endpoint endpoint, RpcRequests.TimeoutNowRequest request, int timeoutMs, RpcResponseClosure<RpcRequests.TimeoutNowResponse> done) Send a timeout-now request and handle the response with done.

Methods inherited from class com.alipay.sofa.jraft.rpc.impl.AbstractClientService

checkConnection, connect, disconnect, getRpcClient, initRpcClient, invokeWithDone, invokeWithDone, invokeWithDone, invokeWithDone, isConnected, shutdown

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.rpc.ClientService

checkConnection, connect, disconnect, invokeWithDone, isConnected

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

shutdown

Constructor Detail

DefaultRaftClientService

public DefaultRaftClientService(ReplicatorGroup rgGroup)

DefaultRaftClientService

public DefaultRaftClientService(ReplicatorGroup rgGroup,
                                FixedThreadsExecutorGroup customAppendEntriesExecutors)

Method Detail

configRpcClient

protected void configRpcClient(RpcClient rpcClient)

Overrides:

configRpcClient in class AbstractClientService

init

public boolean init(RpcOptions rpcOptions)

Description copied from interface: Lifecycle

Initialize the service.

Specified by:

init in interface Lifecycle<RpcOptions>

Overrides:

init in class AbstractClientService

Returns:

true when successes.

preVote

public Future<com.google.protobuf.Message> preVote(Endpoint endpoint,
                                                   RpcRequests.RequestVoteRequest request,
                                                   RpcResponseClosure<RpcRequests.RequestVoteResponse> done)

Description copied from interface: RaftClientService

Sends a pre-vote request and handle the response with done.

Specified by:

preVote in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

done - callback

Returns:

a future with result

requestVote

public Future<com.google.protobuf.Message> requestVote(Endpoint endpoint,
                                                       RpcRequests.RequestVoteRequest request,
                                                       RpcResponseClosure<RpcRequests.RequestVoteResponse> done)

Description copied from interface: RaftClientService

Sends a request-vote request and handle the response with done.

Specified by:

requestVote in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

done - callback

Returns:

a future with result

appendEntries

public Future<com.google.protobuf.Message> appendEntries(Endpoint endpoint,
                                                         RpcRequests.AppendEntriesRequest request,
                                                         int timeoutMs,
                                                         RpcResponseClosure<RpcRequests.AppendEntriesResponse> done)

Description copied from interface: RaftClientService

Sends a append-entries request and handle the response with done.

Specified by:

appendEntries in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

done - callback

Returns:

a future with result

getFile

public Future<com.google.protobuf.Message> getFile(Endpoint endpoint,
                                                   RpcRequests.GetFileRequest request,
                                                   int timeoutMs,
                                                   RpcResponseClosure<RpcRequests.GetFileResponse> done)

Description copied from interface: RaftClientService

Get a piece of file data by GetFileRequest, and handle the response with done.

Specified by:

getFile in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

timeoutMs - timeout millis

done - callback

Returns:

a future result

installSnapshot

public Future<com.google.protobuf.Message> installSnapshot(Endpoint endpoint,
                                                           RpcRequests.InstallSnapshotRequest request,
                                                           RpcResponseClosure<RpcRequests.InstallSnapshotResponse> done)

Description copied from interface: RaftClientService

Sends a install-snapshot request and handle the response with done.

Specified by:

installSnapshot in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

done - callback

Returns:

a future result

timeoutNow

public Future<com.google.protobuf.Message> timeoutNow(Endpoint endpoint,
                                                      RpcRequests.TimeoutNowRequest request,
                                                      int timeoutMs,
                                                      RpcResponseClosure<RpcRequests.TimeoutNowResponse> done)

Description copied from interface: RaftClientService

Send a timeout-now request and handle the response with done.

Specified by:

timeoutNow in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

timeoutMs - timeout millis

done - callback

Returns:

a future result

readIndex

public Future<com.google.protobuf.Message> readIndex(Endpoint endpoint,
                                                     RpcRequests.ReadIndexRequest request,
                                                     int timeoutMs,
                                                     RpcResponseClosure<RpcRequests.ReadIndexResponse> done)

Description copied from interface: RaftClientService

Send a read-index request and handle the response with done.

Specified by:

readIndex in interface RaftClientService

Parameters:

endpoint - destination address (ip, port)

request - request data

timeoutMs - timeout millis

done - callback

Returns:

a future result