com.alipay.sofa.jraft.storage.snapshot

类 SnapshotWriter

java.lang.Object

com.alipay.sofa.jraft.Status

com.alipay.sofa.jraft.storage.snapshot.Snapshot

com.alipay.sofa.jraft.storage.snapshot.SnapshotWriter

所有已实现的接口:

Lifecycle<Void>, Copiable<Status>, Closeable, AutoCloseable

直接已知子类:

LocalSnapshotWriter

public abstract class SnapshotWriter
extends Snapshot
implements Closeable, Lifecycle<Void>

Snapshot writer.

作者:

boyan (boyan@alibaba-inc.com) 2018-Mar-12 4:52:10 PM

字段概要

从类继承的字段 com.alipay.sofa.jraft.storage.snapshot.Snapshot

JRAFT_SNAPSHOT_META_FILE, JRAFT_SNAPSHOT_PREFIX, REMOTE_SNAPSHOT_URI_SCHEME

构造器概要

构造器

构造器和说明
SnapshotWriter()

方法概要

限定符和类型	方法和说明
boolean	addFile(String fileName) Adds a snapshot file without metadata.
abstract boolean	addFile(String fileName, com.google.protobuf.Message fileMeta) Adds a snapshot file with metadata.
abstract void	close(boolean keepDataOnError) Close the writer.
abstract boolean	removeFile(String fileName) Remove a snapshot file.
abstract boolean	saveMeta(RaftOutter.SnapshotMeta meta) Save a snapshot metadata.

从类继承的方法 com.alipay.sofa.jraft.storage.snapshot.Snapshot

getFileMeta, getPath, listFiles

从类继承的方法 com.alipay.sofa.jraft.Status

copy, equals, getCode, getErrorMsg, getRaftError, hashCode, isOk, OK, reset, setCode, setError, setError, setErrorMsg, toString

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.io.Closeable

close

从接口继承的方法 com.alipay.sofa.jraft.Lifecycle

init, shutdown

构造器详细资料

SnapshotWriter

public SnapshotWriter()

方法详细资料

saveMeta

public abstract boolean saveMeta(RaftOutter.SnapshotMeta meta)

Save a snapshot metadata.

参数:

meta - snapshot metadata

返回:

true on success

addFile

public boolean addFile(String fileName)

Adds a snapshot file without metadata.

参数:

fileName - file name

返回:

true on success

addFile

public abstract boolean addFile(String fileName,
                                com.google.protobuf.Message fileMeta)

Adds a snapshot file with metadata.

参数:

fileName - file name

fileMeta - file metadata

返回:

true on success

removeFile

public abstract boolean removeFile(String fileName)

Remove a snapshot file.

参数:

fileName - file name

返回:

true on success

close

public abstract void close(boolean keepDataOnError)
                    throws IOException

Close the writer.

参数:

keepDataOnError - whether to keep data when error happens.

抛出:

IOException - if occurred an IO error