com.alipay.sofa.jraft.core

类 BallotBox

java.lang.Object

com.alipay.sofa.jraft.core.BallotBox

所有已实现的接口:

Lifecycle<BallotBoxOptions>, Describer

@ThreadSafe
public class BallotBox
extends Object
implements Lifecycle<BallotBoxOptions>, Describer

Ballot box for voting.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-04 2:32:10 PM

嵌套类概要

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

Describer.DefaultPrinter, Describer.Printer

构造器概要

构造器

构造器和说明
BallotBox()

方法概要

限定符和类型	方法和说明
boolean	appendPendingTask(Configuration conf, Configuration oldConf, Closure done) Called by leader, otherwise the behavior is undefined Store application context before replication.
void	clearPendingTasks() Called when the leader steps down, otherwise the behavior is undefined When a leader steps down, the uncommitted user applications should fail immediately, which the new leader will deal whether to commit or truncate.
boolean	commitAt(long firstLogIndex, long lastLogIndex, PeerId peer) Called by leader, otherwise the behavior is undefined Set logs in [first_log_index, last_log_index] are stable at |peer|.
void	describe(Describer.Printer out)
long	getLastCommittedIndex()
boolean	init(BallotBoxOptions opts) Initialize the service.
boolean	resetPendingIndex(long newPendingIndex) Called when a candidate becomes the new leader, otherwise the behavior is undefined.
boolean	setLastCommittedIndex(long lastCommittedIndex) Called by follower, otherwise the behavior is undefined.
void	shutdown() Dispose the resources for service.

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

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

构造器详细资料

BallotBox

public BallotBox()

方法详细资料

getLastCommittedIndex

public long getLastCommittedIndex()

init

public boolean init(BallotBoxOptions opts)

从接口复制的说明: Lifecycle

Initialize the service.

指定者:

init 在接口中 Lifecycle<BallotBoxOptions>

返回:

true when successes.

commitAt

public boolean commitAt(long firstLogIndex,
                        long lastLogIndex,
                        PeerId peer)

Called by leader, otherwise the behavior is undefined Set logs in [first_log_index, last_log_index] are stable at |peer|.

clearPendingTasks

public void clearPendingTasks()

Called when the leader steps down, otherwise the behavior is undefined When a leader steps down, the uncommitted user applications should fail immediately, which the new leader will deal whether to commit or truncate.

resetPendingIndex

public boolean resetPendingIndex(long newPendingIndex)

Called when a candidate becomes the new leader, otherwise the behavior is undefined. According the the raft algorithm, the logs from previous terms can't be committed until a log at the new term becomes committed, so |newPendingIndex| should be |last_log_index| + 1.

参数:

newPendingIndex - pending index of new leader

返回:

returns true if reset success

appendPendingTask

public boolean appendPendingTask(Configuration conf,
                                 Configuration oldConf,
                                 Closure done)

Called by leader, otherwise the behavior is undefined Store application context before replication.

参数:

conf - current configuration

oldConf - old configuration

done - callback

返回:

returns true on success

setLastCommittedIndex

public boolean setLastCommittedIndex(long lastCommittedIndex)

Called by follower, otherwise the behavior is undefined. Set committed index received from leader

参数:

lastCommittedIndex - last committed index

返回:

returns true if set success

shutdown

public void shutdown()

从接口复制的说明: Lifecycle

Dispose the resources for service.

指定者:

shutdown 在接口中 Lifecycle<BallotBoxOptions>

describe

public void describe(Describer.Printer out)

指定者:

describe 在接口中 Describer