org.apache.ratis.client.api

接口 AsyncApi

所有已知子接口:

AsyncRpcApi

public interface AsyncApi

Asynchronous API to support operations such as sending message, read-message, stale-read-message and watch-request.

Note that this API supports all the operations in BlockingApi.

方法概要

限定符和类型	方法和说明
default CompletableFuture<RaftClientReply>	send(Message message) The same as send(message, ReplicationLevel.MAJORITY).
CompletableFuture<RaftClientReply>	send(Message message, org.apache.ratis.proto.RaftProtos.ReplicationLevel replication) Send the given message asynchronously to the raft service.
CompletableFuture<RaftClientReply>	sendReadAfterWrite(Message message) Send the given readonly message asynchronously to the raft service.
default CompletableFuture<RaftClientReply>	sendReadOnly(Message message) The same as sendReadOnly(message, null).
CompletableFuture<RaftClientReply>	sendReadOnly(Message message, RaftPeerId server) Send the given readonly message asynchronously to the raft service.
CompletableFuture<RaftClientReply>	sendReadOnlyNonLinearizable(Message message) Send the given readonly message asynchronously to the raft service using non-linearizable read.
default CompletableFuture<RaftClientReply>	sendReadOnlyUnordered(Message message) The same as sendReadOnlyUnordered(message, null).
CompletableFuture<RaftClientReply>	sendReadOnlyUnordered(Message message, RaftPeerId server) Send the given readonly message asynchronously to the raft service.
CompletableFuture<RaftClientReply>	sendStaleRead(Message message, long minIndex, RaftPeerId server) Send the given stale-read message asynchronously to the given server (not the raft service).
CompletableFuture<RaftClientReply>	watch(long index, org.apache.ratis.proto.RaftProtos.ReplicationLevel replication) Watch the given index asynchronously to satisfy the given replication level.

方法详细资料

send

CompletableFuture<RaftClientReply> send(Message message,
                                        org.apache.ratis.proto.RaftProtos.ReplicationLevel replication)

Send the given message asynchronously to the raft service. The message may change the state of the service. For readonly messages, use sendReadOnly(Message) instead.

参数:

message - The request message.

replication - The replication level to wait for.

返回:

a future of the reply.

send

default CompletableFuture<RaftClientReply> send(Message message)

The same as send(message, ReplicationLevel.MAJORITY).

sendReadOnly

default CompletableFuture<RaftClientReply> sendReadOnly(Message message)

The same as sendReadOnly(message, null).

sendReadOnly

CompletableFuture<RaftClientReply> sendReadOnly(Message message,
                                                RaftPeerId server)

Send the given readonly message asynchronously to the raft service. Note that the reply futures are completed in the same order of the messages being sent.

参数:

message - The request message.

server - The target server. When server == null, send the message to the leader.

返回:

a future of the reply.

sendReadAfterWrite

CompletableFuture<RaftClientReply> sendReadAfterWrite(Message message)

Send the given readonly message asynchronously to the raft service. The result will be read-after-write consistent, i.e. reflecting the latest successful write by the same client.

参数:

message - The request message.

返回:

the reply.

sendReadOnlyNonLinearizable

CompletableFuture<RaftClientReply> sendReadOnlyNonLinearizable(Message message)

Send the given readonly message asynchronously to the raft service using non-linearizable read. This method is useful when linearizable read is enabled but this client prefers not using it for performance reason. When linearizable read is disabled, this method is the same as sendReadOnly(Message).

参数:

message - The request message.

返回:

a future of the reply.

sendReadOnlyUnordered

default CompletableFuture<RaftClientReply> sendReadOnlyUnordered(Message message)

The same as sendReadOnlyUnordered(message, null).

sendReadOnlyUnordered

CompletableFuture<RaftClientReply> sendReadOnlyUnordered(Message message,
                                                         RaftPeerId server)

Send the given readonly message asynchronously to the raft service. Note that the reply futures can be completed in any order.

参数:

message - The request message.

server - The target server. When server == null, send the message to the leader.

返回:

a future of the reply.

sendStaleRead

CompletableFuture<RaftClientReply> sendStaleRead(Message message,
                                                 long minIndex,
                                                 RaftPeerId server)

Send the given stale-read message asynchronously to the given server (not the raft service). If the server commit index is larger than or equal to the given min-index, the request will be processed. Otherwise, the server returns a StaleReadException.

参数:

message - The request message.

minIndex - The minimum log index that the server log must have already committed.

server - The target server

返回:

a future of the reply.

watch

CompletableFuture<RaftClientReply> watch(long index,
                                         org.apache.ratis.proto.RaftProtos.ReplicationLevel replication)

Watch the given index asynchronously to satisfy the given replication level.

参数:

index - The log index to be watched.

replication - The replication level required.

返回:

a future of the reply. When RaftClientReply.isSuccess() == true, the reply index (i.e. RaftClientReply.getLogIndex()) is the log index satisfying the request, where reply index >= watch index.