com.alipay.sofa.jraft.core

Class FSMCallerImpl

java.lang.Object

com.alipay.sofa.jraft.core.FSMCallerImpl

All Implemented Interfaces:

FSMCaller, Lifecycle<FSMCallerOptions>, Describer

public class FSMCallerImpl
extends Object
implements FSMCaller

The finite state machine caller implementation.

Author:

boyan (boyan@alibaba-inc.com) 2018-Apr-03 11:12:14 AM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FSMCallerImpl.OnErrorClosure Closure runs with an error.

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

FSMCaller.LastAppliedLogIndexListener

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

Describer.DefaultPrinter, Describer.Printer

Constructor Summary

Constructors

Constructor and Description
FSMCallerImpl()

Method Summary

Modifier and Type	Method and Description
void	addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener) Adds a LastAppliedLogIndexListener.
void	describe(Describer.Printer out)
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.
NodeImpl	getNode()
boolean	hasAvailableCapacity(int requiredCapacity) Given specified requiredCapacity determines if that amount of space is available to submit new tasks to fsm.
boolean	init(FSMCallerOptions opts) Initialize the service.
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.
void	shutdown() Dispose the resources for service.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FSMCallerImpl

public FSMCallerImpl()

Method Detail

init

public boolean init(FSMCallerOptions opts)

Description copied from interface: Lifecycle

Initialize the service.

Specified by:

init in interface Lifecycle<FSMCallerOptions>

Returns:

true when successes.

shutdown

public void shutdown()

Description copied from interface: Lifecycle

Dispose the resources for service.

Specified by:

shutdown in interface Lifecycle<FSMCallerOptions>

addLastAppliedLogIndexListener

public void addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener)

Description copied from interface: FSMCaller

Adds a LastAppliedLogIndexListener.

Specified by:

addLastAppliedLogIndexListener in interface FSMCaller

hasAvailableCapacity

public boolean hasAvailableCapacity(int requiredCapacity)

Description copied from interface: FSMCaller

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

Specified by:

hasAvailableCapacity in interface FSMCaller

Returns:

Returns true when available.

onCommitted

public boolean onCommitted(long committedIndex)

Description copied from interface: FSMCaller

Called when log entry committed

Specified by:

onCommitted in interface FSMCaller

Parameters:

committedIndex - committed log index

onSnapshotLoad

public boolean onSnapshotLoad(LoadSnapshotClosure done)

Description copied from interface: FSMCaller

Called when loading snapshot.

Specified by:

onSnapshotLoad in interface FSMCaller

Parameters:

done - callback

onSnapshotSave

public boolean onSnapshotSave(SaveSnapshotClosure done)

Description copied from interface: FSMCaller

Called when saving snapshot.

Specified by:

onSnapshotSave in interface FSMCaller

Parameters:

done - callback

onLeaderStop

public boolean onLeaderStop(Status status)

Description copied from interface: FSMCaller

Called when the leader stops.

Specified by:

onLeaderStop in interface FSMCaller

Parameters:

status - status info

onLeaderStart

public boolean onLeaderStart(long term)

Description copied from interface: FSMCaller

Called when the leader starts.

Specified by:

onLeaderStart in interface FSMCaller

Parameters:

term - current term

onStartFollowing

public boolean onStartFollowing(LeaderChangeContext ctx)

Description copied from interface: FSMCaller

Called when start following a leader.

Specified by:

onStartFollowing in interface FSMCaller

Parameters:

ctx - context of leader change

onStopFollowing

public boolean onStopFollowing(LeaderChangeContext ctx)

Description copied from interface: FSMCaller

Called when stop following a leader.

Specified by:

onStopFollowing in interface FSMCaller

Parameters:

ctx - context of leader change

onError

public boolean onError(RaftException error)

Description copied from interface: FSMCaller

Called when error happens.

Specified by:

onError in interface FSMCaller

Parameters:

error - error info

getLastCommittedIndex

public long getLastCommittedIndex()

Description copied from interface: FSMCaller

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

Specified by:

getLastCommittedIndex in interface FSMCaller

getLastAppliedIndex

public long getLastAppliedIndex()

Description copied from interface: FSMCaller

Returns the last log entry index to apply state machine.

Specified by:

getLastAppliedIndex in interface FSMCaller

getNode

public NodeImpl getNode()

join

public void join()
          throws InterruptedException

Description copied from interface: FSMCaller

Called after shutdown to wait it terminates.

Specified by:

join in interface FSMCaller

Throws:

InterruptedException - if the current thread is interrupted while waiting

isRunningOnFSMThread

public boolean isRunningOnFSMThread()

Description copied from interface: FSMCaller

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

Specified by:

isRunningOnFSMThread in interface FSMCaller

Returns:

onSnapshotSaveSync

public void onSnapshotSaveSync(SaveSnapshotClosure done)

Description copied from interface: FSMCaller

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

Specified by:

onSnapshotSaveSync in interface FSMCaller

toString

public String toString()

Overrides:

toString in class Object

describe

public void describe(Describer.Printer out)

Specified by:

describe in interface Describer