com.alipay.sofa.jraft

接口 FSMCaller

所有超级接口:

Describer, Lifecycle<FSMCallerOptions>

所有已知实现类:

FSMCallerImpl

public interface FSMCaller
extends Lifecycle<FSMCallerOptions>, Describer

Finite state machine caller.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-03 11:07:52 AM

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	FSMCaller.LastAppliedLogIndexListener Listen on lastAppliedLogIndex update events.

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

Describer.DefaultPrinter, Describer.Printer

方法概要

限定符和类型	方法和说明
void	addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener) Adds a LastAppliedLogIndexListener.
long	getLastAppliedIndex() Returns the last log entry index to apply state machine.
void	join() Called after shutdown to wait it terminates.
boolean	onCommitted(long committedIndex) Called when log entry committed
boolean	onError(RaftException error) Called when error happens.
boolean	onLeaderStart(long term) Called when the leader starts.
boolean	onLeaderStop(Status status) Called when the leader stops.
boolean	onSnapshotLoad(LoadSnapshotClosure done) Called after loading snapshot.
boolean	onSnapshotSave(SaveSnapshotClosure done) Called after saving snapshot.
boolean	onStartFollowing(LeaderChangeContext ctx) Called when start following a leader.
boolean	onStopFollowing(LeaderChangeContext ctx) Called when stop following a leader.

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

init, shutdown

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

describe

方法详细资料

addLastAppliedLogIndexListener

void addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener)

Adds a LastAppliedLogIndexListener.

onCommitted

boolean onCommitted(long committedIndex)

Called when log entry committed

参数:

committedIndex - committed log index

onSnapshotLoad

boolean onSnapshotLoad(LoadSnapshotClosure done)

Called after loading snapshot.

参数:

done - callback

onSnapshotSave

boolean onSnapshotSave(SaveSnapshotClosure done)

Called after saving snapshot.

参数:

done - callback

onLeaderStop

boolean onLeaderStop(Status status)

Called when the leader stops.

参数:

status - status info

onLeaderStart

boolean onLeaderStart(long term)

Called when the leader starts.

参数:

term - current term

onStartFollowing

boolean onStartFollowing(LeaderChangeContext ctx)

Called when start following a leader.

参数:

ctx - context of leader change

onStopFollowing

boolean onStopFollowing(LeaderChangeContext ctx)

Called when stop following a leader.

参数:

ctx - context of leader change

onError

boolean onError(RaftException error)

Called when error happens.

参数:

error - error info

getLastAppliedIndex

long getLastAppliedIndex()

Returns the last log entry index to apply state machine.

join

void join()
   throws InterruptedException

Called after shutdown to wait it terminates.

抛出:

InterruptedException - if the current thread is interrupted while waiting