com.alipay.sofa.jraft.core

类 StateMachineAdapter

java.lang.Object

com.alipay.sofa.jraft.core.StateMachineAdapter

所有已实现的接口:

StateMachine

public abstract class StateMachineAdapter
extends Object
implements StateMachine

State machine adapter that implements all methods with default behavior except StateMachine.onApply(com.alipay.sofa.jraft.Iterator).

作者:

boyan (boyan@alibaba-inc.com) 2018-Mar-30 10:32:27 AM

构造器概要

构造器

构造器和说明
StateMachineAdapter()

方法概要

限定符和类型	方法和说明
void	onConfigurationCommitted(Configuration conf) Invoked when a configuration has been committed to the group.
void	onError(RaftException e) This method is called when a critical error was encountered, after this point, no any further modification is allowed to applied to this node until the error is fixed and this node restarts.
void	onLeaderStart(long term) Invoked when the belonging node becomes the leader of the group at |term| Default: Do nothing
void	onLeaderStop(Status status) Invoked when this node steps down from the leader of the replication group and |status| describes detailed information
void	onShutdown() Invoked once when the raft node was shut down.
boolean	onSnapshotLoad(SnapshotReader reader) User defined snapshot load function get and load snapshot Default: Load nothing and returns error.
void	onSnapshotSave(SnapshotWriter writer, Closure done) User defined snapshot generate function, this method will block StateMachine#onApply(Iterator).
void	onStartFollowing(LeaderChangeContext ctx) This method is called when a follower or candidate starts following a leader and its leaderId (should be NULL before the method is called) is set to the leader's id, situations including: 1. a candidate receives appendEntries request from a leader 2. a follower(without leader) receives appendEntries from a leader the parameter ctx gives the information(leaderId, term and status) about the very leader whom the follower starts to follow.
void	onStopFollowing(LeaderChangeContext ctx) This method is called when a follower stops following a leader and its leaderId becomes null, situations including: 1. handle election timeout and start preVote 2. receive requests with higher term such as VoteRequest from a candidate or appendEntries request from a new leader 3. receive timeoutNow request from current leader and start request vote.

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

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

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

onApply

构造器详细资料

StateMachineAdapter

public StateMachineAdapter()

方法详细资料

onShutdown

public void onShutdown()

从接口复制的说明: StateMachine

Invoked once when the raft node was shut down. Default do nothing

指定者:

onShutdown 在接口中 StateMachine

onSnapshotSave

public void onSnapshotSave(SnapshotWriter writer,
                           Closure done)

从接口复制的说明: StateMachine

User defined snapshot generate function, this method will block StateMachine#onApply(Iterator). user can make snapshot async when fsm can be cow(copy-on-write). call done.run(status) when snapshot finished. Default: Save nothing and returns error.

指定者:

onSnapshotSave 在接口中 StateMachine

参数:

writer - snapshot writer

done - callback

onSnapshotLoad

public boolean onSnapshotLoad(SnapshotReader reader)

从接口复制的说明: StateMachine

User defined snapshot load function get and load snapshot Default: Load nothing and returns error.

指定者:

onSnapshotLoad 在接口中 StateMachine

参数:

reader - snapshot reader

返回:

true on success

onLeaderStart

public void onLeaderStart(long term)

从接口复制的说明: StateMachine

Invoked when the belonging node becomes the leader of the group at |term| Default: Do nothing

指定者:

onLeaderStart 在接口中 StateMachine

参数:

term - new term num

onLeaderStop

public void onLeaderStop(Status status)

从接口复制的说明: StateMachine

Invoked when this node steps down from the leader of the replication group and |status| describes detailed information

指定者:

onLeaderStop 在接口中 StateMachine

参数:

status - status info

onError

public void onError(RaftException e)

从接口复制的说明: StateMachine

This method is called when a critical error was encountered, after this point, no any further modification is allowed to applied to this node until the error is fixed and this node restarts.

指定者:

onError 在接口中 StateMachine

参数:

e - raft error message

onConfigurationCommitted

public void onConfigurationCommitted(Configuration conf)

从接口复制的说明: StateMachine

Invoked when a configuration has been committed to the group.

指定者:

onConfigurationCommitted 在接口中 StateMachine

参数:

conf - committed configuration

onStopFollowing

public void onStopFollowing(LeaderChangeContext ctx)

从接口复制的说明: StateMachine

This method is called when a follower stops following a leader and its leaderId becomes null, situations including: 1. handle election timeout and start preVote 2. receive requests with higher term such as VoteRequest from a candidate or appendEntries request from a new leader 3. receive timeoutNow request from current leader and start request vote. the parameter ctx gives the information(leaderId, term and status) about the very leader whom the follower followed before. User can reset the node's information as it stops following some leader.

指定者:

onStopFollowing 在接口中 StateMachine

参数:

ctx - context of leader change

onStartFollowing

public void onStartFollowing(LeaderChangeContext ctx)

从接口复制的说明: StateMachine

This method is called when a follower or candidate starts following a leader and its leaderId (should be NULL before the method is called) is set to the leader's id, situations including: 1. a candidate receives appendEntries request from a leader 2. a follower(without leader) receives appendEntries from a leader the parameter ctx gives the information(leaderId, term and status) about the very leader whom the follower starts to follow. User can reset the node's information as it starts to follow some leader.

指定者:

onStartFollowing 在接口中 StateMachine

参数:

ctx - context of leader change