org.apache.ratis.client.api

接口 BlockingApi

public interface BlockingApi

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

Note that this API supports a subset of the operations in AsyncApi.

方法概要

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

方法详细资料

send

RaftClientReply send(Message message)
              throws IOException

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

参数:

message - The request message.

返回:

the reply.

抛出:

IOException

sendReadOnly

default RaftClientReply sendReadOnly(Message message)
                              throws IOException

The same as sendReadOnly(message, null).

抛出:

IOException

sendReadOnly

RaftClientReply sendReadOnly(Message message,
                             RaftPeerId server)
                      throws IOException

Send the given readonly message to the raft service.

参数:

message - The request message.

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

返回:

the reply.

抛出:

IOException

sendReadOnlyNonLinearizable

RaftClientReply sendReadOnlyNonLinearizable(Message message)
                                     throws IOException

Send the given readonly message 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.

返回:

the reply.

抛出:

IOException

sendReadAfterWrite

RaftClientReply sendReadAfterWrite(Message message)
                            throws IOException

Send the given readonly message 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.

抛出:

IOException

sendStaleRead

RaftClientReply sendStaleRead(Message message,
                              long minIndex,
                              RaftPeerId server)
                       throws IOException

Send the given stale-read message 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 throws a StaleReadException.

参数:

message - The request message.

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

server - The target server

返回:

the reply.

抛出:

IOException

watch

RaftClientReply watch(long index,
                      org.apache.ratis.proto.RaftProtos.ReplicationLevel replication)
               throws IOException

Watch the given index to satisfy the given replication level.

参数:

index - The log index to be watched.

replication - The replication level required.

返回:

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.

抛出:

IOException