com.alipay.sofa.jraft

Interface FSMCaller

All Superinterfaces:

Describer, Lifecycle<FSMCallerOptions>

All Known Implementing Classes:

FSMCallerImpl

public interface FSMCaller
extends Lifecycle<FSMCallerOptions>, Describer

Finite state machine caller.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FSMCaller.LastAppliedLogIndexListener Listen on lastAppliedLogIndex update events.

Nested classes/interfaces inherited from interface com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

Method Summary

Modifier and Type	Method and Description
void	addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener) Adds a LastAppliedLogIndexListener.
long	getLastAppliedIndex() Returns the last log entry index to apply state machine.
long	getLastCommittedIndex() Returns the last log entry that was committed to raft group.
boolean	hasAvailableCapacity(int requiredCapacity) Given specified requiredCapacity determines if that amount of space is available to submit new tasks to fsm.
boolean	isRunningOnFSMThread() Returns true when current thread is the thread that calls state machine callback methods.
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 when loading snapshot.
boolean	onSnapshotSave(SaveSnapshotClosure done) Called when saving snapshot.
void	onSnapshotSaveSync(SaveSnapshotClosure done) Called when saving snapshot synchronously, it MUST be called in state machine methods.
boolean	onStartFollowing(LeaderChangeContext ctx) Called when start following a leader.
boolean	onStopFollowing(LeaderChangeContext ctx) Called when stop following a leader.

Methods inherited from interface com.alipay.sofa.jraft.Lifecycle

init, shutdown

Methods inherited from interface com.alipay.sofa.jraft.util.Describer

describe

Method Detail

isRunningOnFSMThread

boolean isRunningOnFSMThread()

Returns true when current thread is the thread that calls state machine callback methods.

Returns:

addLastAppliedLogIndexListener

void addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener)

Adds a LastAppliedLogIndexListener.

onCommitted

boolean onCommitted(long committedIndex)

Called when log entry committed

Parameters:

committedIndex - committed log index

hasAvailableCapacity

boolean hasAvailableCapacity(int requiredCapacity)

Given specified requiredCapacity determines if that amount of space is available to submit new tasks to fsm. Returns true when available.

Parameters:

requiredCapacity -

Returns:

Returns true when available.

onSnapshotLoad

boolean onSnapshotLoad(LoadSnapshotClosure done)

Called when loading snapshot.

Parameters:

done - callback

onSnapshotSaveSync

void onSnapshotSaveSync(SaveSnapshotClosure done)

Called when saving snapshot synchronously, it MUST be called in state machine methods.

Parameters:

done -

onSnapshotSave

boolean onSnapshotSave(SaveSnapshotClosure done)

Called when saving snapshot.

Parameters:

done - callback

onLeaderStop

boolean onLeaderStop(Status status)

Called when the leader stops.

Parameters:

status - status info

onLeaderStart

boolean onLeaderStart(long term)

Called when the leader starts.

Parameters:

term - current term

onStartFollowing

boolean onStartFollowing(LeaderChangeContext ctx)

Called when start following a leader.

Parameters:

ctx - context of leader change

onStopFollowing

boolean onStopFollowing(LeaderChangeContext ctx)

Called when stop following a leader.

Parameters:

ctx - context of leader change

onError

boolean onError(RaftException error)

Called when error happens.

Parameters:

error - error info

getLastAppliedIndex

long getLastAppliedIndex()

Returns the last log entry index to apply state machine.

getLastCommittedIndex

long getLastCommittedIndex()

Returns the last log entry that was committed to raft group.

join

void join()
   throws InterruptedException

Called after shutdown to wait it terminates.

Throws:

InterruptedException - if the current thread is interrupted while waiting