org.apache.ratis.client.api

接口 SnapshotManagementApi

public interface SnapshotManagementApi

An API to support control snapshot such as create and list snapshot file.

方法概要

限定符和类型	方法和说明
default RaftClientReply	create(boolean force, long timeoutMs) The same as create(force?
default RaftClientReply	create(long timeoutMs) The same as create(0, timeoutMs).
RaftClientReply	create(long creationGap, long timeoutMs) Trigger to create a snapshot.

方法详细资料

create

default RaftClientReply create(long timeoutMs)
                        throws IOException

The same as create(0, timeoutMs).

抛出:

IOException

create

default RaftClientReply create(boolean force,
                               long timeoutMs)
                        throws IOException

The same as create(force? 1 : 0, timeoutMs).

抛出:

IOException

create

RaftClientReply create(long creationGap,
                       long timeoutMs)
                throws IOException

Trigger to create a snapshot.

参数:

creationGap - When (creationGap > 0) and (astAppliedIndex - lastSnapshotIndex < creationGap), return lastSnapshotIndex; otherwise, take a new snapshot and then return its index. When creationGap == 0, use the server configured value as the creationGap.

返回:

a reply. When RaftClientReply.isSuccess() is true, RaftClientReply.getLogIndex() is the snapshot index fulfilling the operation.

抛出:

IOException