com.alipay.sofa.jraft.storage.snapshot.local

类 LocalSnapshotWriter

java.lang.Object

com.alipay.sofa.jraft.Status

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

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

com.alipay.sofa.jraft.storage.snapshot.local.LocalSnapshotWriter

所有已实现的接口:

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

public class LocalSnapshotWriter
extends SnapshotWriter

Snapshot writer to write snapshot into local file system.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-08 11:51:43 AM

字段概要

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

JRAFT_SNAPSHOT_META_FILE, JRAFT_SNAPSHOT_PREFIX, REMOTE_SNAPSHOT_URI_SCHEME

构造器概要

构造器

构造器和说明
LocalSnapshotWriter(String path, LocalSnapshotStorage snapshotStorage, RaftOptions raftOptions)

方法概要

限定符和类型	方法和说明
boolean	addFile(String fileName, com.google.protobuf.Message fileMeta) Adds a snapshot file with metadata.
void	close()
void	close(boolean keepDataOnError) Close the writer.
com.google.protobuf.Message	getFileMeta(String fileName) Get file meta by fileName.
String	getPath() Get the path of the Snapshot
long	getSnapshotIndex()
boolean	init(Void v) Initialize the service.
Set<String>	listFiles() List all the existing files in the Snapshot currently
boolean	removeFile(String fileName) Remove a snapshot file.
boolean	saveMeta(RaftOutter.SnapshotMeta meta) Save a snapshot metadata.
void	shutdown() Dispose the resources for service.
boolean	sync()

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

addFile

从类继承的方法 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

构造器详细资料

LocalSnapshotWriter

public LocalSnapshotWriter(String path,
                           LocalSnapshotStorage snapshotStorage,
                           RaftOptions raftOptions)

方法详细资料

init

public boolean init(Void v)

从接口复制的说明: Lifecycle

Initialize the service.

返回:

true when successes.

getSnapshotIndex

public long getSnapshotIndex()

shutdown

public void shutdown()

从接口复制的说明: Lifecycle

Dispose the resources for service.

close

public void close()
           throws IOException

抛出:

IOException

close

public void close(boolean keepDataOnError)
           throws IOException

从类复制的说明: SnapshotWriter

Close the writer.

指定者:

close 在类中 SnapshotWriter

参数:

keepDataOnError - whether to keep data when error happens.

抛出:

IOException - if occurred an IO error

saveMeta

public boolean saveMeta(RaftOutter.SnapshotMeta meta)

从类复制的说明: SnapshotWriter

Save a snapshot metadata.

指定者:

saveMeta 在类中 SnapshotWriter

参数:

meta - snapshot metadata

返回:

true on success

sync

public boolean sync()
             throws IOException

抛出:

IOException

addFile

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

从类复制的说明: SnapshotWriter

Adds a snapshot file with metadata.

指定者:

addFile 在类中 SnapshotWriter

参数:

fileName - file name

fileMeta - file metadata

返回:

true on success

removeFile

public boolean removeFile(String fileName)

从类复制的说明: SnapshotWriter

Remove a snapshot file.

指定者:

removeFile 在类中 SnapshotWriter

参数:

fileName - file name

返回:

true on success

getPath

public String getPath()

从类复制的说明: Snapshot

Get the path of the Snapshot

指定者:

getPath 在类中 Snapshot

listFiles

public Set<String> listFiles()

从类复制的说明: Snapshot

List all the existing files in the Snapshot currently

指定者:

listFiles 在类中 Snapshot

getFileMeta

public com.google.protobuf.Message getFileMeta(String fileName)

从类复制的说明: Snapshot

Get file meta by fileName.

指定者:

getFileMeta 在类中 Snapshot