com.alipay.sofa.jraft.storage.snapshot

类 SnapshotExecutorImpl

java.lang.Object

com.alipay.sofa.jraft.storage.snapshot.SnapshotExecutorImpl

所有已实现的接口:

Lifecycle<SnapshotExecutorOptions>, SnapshotExecutor, Describer

public class SnapshotExecutorImpl
extends Object
implements SnapshotExecutor

Snapshot executor implementation.

作者:

boyan (boyan@alibaba-inc.com) 2018-Mar-22 5:38:56 PM

嵌套类概要

从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

构造器概要

构造器

构造器和说明
SnapshotExecutorImpl()

方法概要

限定符和类型	方法和说明
void	describe(Describer.Printer out)
void	doSnapshot(Closure done) Start to snapshot StateMachine, and |done| is called after the execution finishes or fails.
long	getLastSnapshotIndex() Only for test
long	getLastSnapshotTerm() Only for test
NodeImpl	getNode() Return the owner NodeImpl
SnapshotStorage	getSnapshotStorage() Returns the backing snapshot storage
boolean	init(SnapshotExecutorOptions opts) Initialize the service.
void	installSnapshot(RpcRequests.InstallSnapshotRequest request, RpcRequests.InstallSnapshotResponse.Builder response, RpcRequestClosure done) Install snapshot according to the very RPC from leader After the installing succeeds (StateMachine is reset with the snapshot) or fails, done will be called to respond Errors: - Term mismatches: which happens interrupt_downloading_snapshot was called before install_snapshot, indicating that this RPC was issued by the old leader
void	interruptDownloadingSnapshots(long newTerm) Interrupt the downloading if possible.
boolean	isInstallingSnapshot() Returns true if this is currently installing a snapshot, either downloading or loading.
void	join() Block the current thread until all the running job finishes (including failure)
void	shutdown() Dispose the resources for service.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SnapshotExecutorImpl

public SnapshotExecutorImpl()

方法详细资料

getLastSnapshotTerm

@OnlyForTest
public long getLastSnapshotTerm()

Only for test

getLastSnapshotIndex

@OnlyForTest
public long getLastSnapshotIndex()

Only for test

init

public boolean init(SnapshotExecutorOptions opts)

从接口复制的说明: Lifecycle

Initialize the service.

指定者:

init 在接口中 Lifecycle<SnapshotExecutorOptions>

返回:

true when successes.

shutdown

public void shutdown()

从接口复制的说明: Lifecycle

Dispose the resources for service.

指定者:

shutdown 在接口中 Lifecycle<SnapshotExecutorOptions>

getNode

public NodeImpl getNode()

从接口复制的说明: SnapshotExecutor

Return the owner NodeImpl

指定者:

getNode 在接口中 SnapshotExecutor

doSnapshot

public void doSnapshot(Closure done)

从接口复制的说明: SnapshotExecutor

Start to snapshot StateMachine, and |done| is called after the execution finishes or fails.

指定者:

doSnapshot 在接口中 SnapshotExecutor

参数:

done - snapshot callback

installSnapshot

public void installSnapshot(RpcRequests.InstallSnapshotRequest request,
                            RpcRequests.InstallSnapshotResponse.Builder response,
                            RpcRequestClosure done)

从接口复制的说明: SnapshotExecutor

Install snapshot according to the very RPC from leader After the installing succeeds (StateMachine is reset with the snapshot) or fails, done will be called to respond Errors: - Term mismatches: which happens interrupt_downloading_snapshot was called before install_snapshot, indicating that this RPC was issued by the old leader. - Interrupted: happens when interrupt_downloading_snapshot is called or a new RPC with the same or newer snapshot arrives - Busy: the state machine is saving or loading snapshot

指定者:

installSnapshot 在接口中 SnapshotExecutor

interruptDownloadingSnapshots

public void interruptDownloadingSnapshots(long newTerm)

从接口复制的说明: SnapshotExecutor

Interrupt the downloading if possible. This is called when the term of node increased to |new_term|, which happens when receiving RPC from new peer. In this case, it's hard to determine whether to keep downloading snapshot as the new leader possibly contains the missing logs and is going to send AppendEntries. To make things simplicity and leader changing during snapshot installing is very rare. So we interrupt snapshot downloading when leader changes, and let the new leader decide whether to install a new snapshot or continue appending log entries. NOTE: we can't interrupt the snapshot installing which has finished downloading and is reseting the State Machine.

指定者:

interruptDownloadingSnapshots 在接口中 SnapshotExecutor

参数:

newTerm - new term num

isInstallingSnapshot

public boolean isInstallingSnapshot()

从接口复制的说明: SnapshotExecutor

Returns true if this is currently installing a snapshot, either downloading or loading.

指定者:

isInstallingSnapshot 在接口中 SnapshotExecutor

getSnapshotStorage

public SnapshotStorage getSnapshotStorage()

从接口复制的说明: SnapshotExecutor

Returns the backing snapshot storage

指定者:

getSnapshotStorage 在接口中 SnapshotExecutor

join

public void join()
          throws InterruptedException

从接口复制的说明: SnapshotExecutor

Block the current thread until all the running job finishes (including failure)

指定者:

join 在接口中 SnapshotExecutor

抛出:

InterruptedException

describe

public void describe(Describer.Printer out)

指定者:

describe 在接口中 Describer