org.apache.ratis.statemachine

Interface StateMachine.DataApi

All Known Implementing Classes:

BaseStateMachine

Enclosing interface:

StateMachine

public static interface StateMachine.DataApi

Field Summary

Fields

Modifier and Type	Field and Description
static StateMachine.DataApi	DEFAULT A noop implementation of StateMachine.DataApi.

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Void>	flush(long logIndex) Flush the state machine data till the given log index.
default CompletableFuture<?>	link(StateMachine.DataStream stream, org.apache.ratis.proto.RaftProtos.LogEntryProto entry) Link asynchronously the given stream with the given log entry.
default CompletableFuture<org.apache.ratis.thirdparty.com.google.protobuf.ByteString>	read(org.apache.ratis.proto.RaftProtos.LogEntryProto entry) Read asynchronously the state machine data from this state machine.
default CompletableFuture<StateMachine.DataStream>	stream(RaftClientRequest request) Create asynchronously a StateMachine.DataStream to stream state machine data.
default CompletableFuture<Void>	truncate(long logIndex) Truncates asynchronously the state machine data to the given log index.
default CompletableFuture<?>	write(org.apache.ratis.proto.RaftProtos.LogEntryProto entry) Write asynchronously the state machine data in the given log entry to this state machine.

Field Detail

DEFAULT

static final StateMachine.DataApi DEFAULT

A noop implementation of StateMachine.DataApi.

Method Detail

read

default CompletableFuture<org.apache.ratis.thirdparty.com.google.protobuf.ByteString> read(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

Read asynchronously the state machine data from this state machine.

Returns:

a future for the read task.

write

default CompletableFuture<?> write(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

Write asynchronously the state machine data in the given log entry to this state machine.

Returns:

a future for the write task

stream

default CompletableFuture<StateMachine.DataStream> stream(RaftClientRequest request)

Create asynchronously a StateMachine.DataStream to stream state machine data. The state machine may use the first message (i.e. request.getMessage()) as the header to create the stream.

Returns:

a future of the stream.

link

default CompletableFuture<?> link(StateMachine.DataStream stream,
                                  org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

Link asynchronously the given stream with the given log entry.

Returns:

a future for the link task.

flush

default CompletableFuture<Void> flush(long logIndex)

Flush the state machine data till the given log index.

Parameters:

logIndex - The log index to flush.

Returns:

a future for the flush task.

truncate

default CompletableFuture<Void> truncate(long logIndex)

Truncates asynchronously the state machine data to the given log index. It is a noop if the corresponding log entry does not have state machine data.

Parameters:

logIndex - The last log index after truncation.

Returns:

a future for truncate task.