org.apache.ratis.statemachine.impl

Class BaseStateMachine

java.lang.Object

org.apache.ratis.statemachine.impl.BaseStateMachine

All Implemented Interfaces:

Closeable, AutoCloseable, StateMachine, StateMachine.DataApi, StateMachine.EventApi, StateMachine.FollowerEventApi, StateMachine.LeaderEventApi

public class BaseStateMachine
extends Object
implements StateMachine, StateMachine.DataApi, StateMachine.EventApi, StateMachine.LeaderEventApi, StateMachine.FollowerEventApi

Base implementation for StateMachines.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	BaseStateMachine.Task

Nested classes/interfaces inherited from interface org.apache.ratis.statemachine.StateMachine

StateMachine.DataApi, StateMachine.DataChannel, StateMachine.DataStream, StateMachine.EventApi, StateMachine.FollowerEventApi, StateMachine.LeaderEventApi, StateMachine.Registry

Field Summary

Fields inherited from interface org.apache.ratis.statemachine.StateMachine

LOG

Fields inherited from interface org.apache.ratis.statemachine.StateMachine.DataApi

DEFAULT

Fields inherited from interface org.apache.ratis.statemachine.StateMachine.EventApi

DEFAULT

Fields inherited from interface org.apache.ratis.statemachine.StateMachine.LeaderEventApi

DEFAULT

Fields inherited from interface org.apache.ratis.statemachine.StateMachine.FollowerEventApi

DEFAULT

Constructor Summary

Constructors

Constructor and Description
BaseStateMachine()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Message>	applyTransaction(TransactionContext trx)
TransactionContext	applyTransactionSerial(TransactionContext trx)
TransactionContext	cancelTransaction(TransactionContext trx)
void	close()
RaftGroupId	getGroupId()
RaftPeerId	getId()
TermIndex	getLastAppliedTermIndex()
SnapshotInfo	getLatestSnapshot()
LifeCycle	getLifeCycle()
LifeCycle.State	getLifeCycleState()
CompletableFuture<RaftServer>	getServer()
StateMachineStorage	getStateMachineStorage()
void	initialize(RaftServer raftServer, RaftGroupId raftGroupId, RaftStorage storage)
void	notifyTermIndexUpdated(long term, long index)
void	pause()
TransactionContext	preAppendTransaction(TransactionContext trx)
CompletableFuture<Message>	query(Message request)
CompletableFuture<Message>	queryStale(Message request, long minIndex)
protected CompletableFuture<Message>	recordTime(com.codahale.metrics.Timer timer, BaseStateMachine.Task task)
void	reinitialize()
protected void	setLastAppliedTermIndex(TermIndex newTI)
TransactionContext	startTransaction(RaftClientRequest request)
long	takeSnapshot()
String	toString()
protected boolean	updateLastAppliedTermIndex(long term, long index)
protected boolean	updateLastAppliedTermIndex(TermIndex newTI)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ratis.statemachine.StateMachine

data, event, followerEvent, leaderEvent, toStateMachineLogEntryString

Methods inherited from interface org.apache.ratis.statemachine.StateMachine.DataApi

flush, link, read, stream, truncate, write

Methods inherited from interface org.apache.ratis.statemachine.StateMachine.EventApi

notifyConfigurationChanged, notifyGroupRemove, notifyLeaderChanged, notifyLogFailed, notifyServerShutdown, notifySnapshotInstalled

Methods inherited from interface org.apache.ratis.statemachine.StateMachine.LeaderEventApi

notifyFollowerSlowness, notifyFollowerSlowness, notifyNotLeader

Methods inherited from interface org.apache.ratis.statemachine.StateMachine.FollowerEventApi

notifyExtendedNoLeader, notifyInstallSnapshotFromLeader

Constructor Detail

BaseStateMachine

public BaseStateMachine()

Method Detail

getId

public RaftPeerId getId()

getLifeCycle

public LifeCycle getLifeCycle()

getServer

public CompletableFuture<RaftServer> getServer()

getGroupId

public RaftGroupId getGroupId()

getLifeCycleState

public LifeCycle.State getLifeCycleState()

Specified by:

getLifeCycleState in interface StateMachine

initialize

public void initialize(RaftServer raftServer,
                       RaftGroupId raftGroupId,
                       RaftStorage storage)
                throws IOException

Specified by:

initialize in interface StateMachine

Throws:

IOException

getLatestSnapshot

public SnapshotInfo getLatestSnapshot()

Specified by:

getLatestSnapshot in interface StateMachine

pause

public void pause()

Specified by:

pause in interface StateMachine

reinitialize

public void reinitialize()
                  throws IOException

Specified by:

reinitialize in interface StateMachine

Throws:

IOException

applyTransactionSerial

public TransactionContext applyTransactionSerial(TransactionContext trx)
                                          throws org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException

Specified by:

applyTransactionSerial in interface StateMachine

Throws:

org.apache.ratis.thirdparty.com.google.protobuf.InvalidProtocolBufferException

applyTransaction

public CompletableFuture<Message> applyTransaction(TransactionContext trx)

Specified by:

applyTransaction in interface StateMachine

getLastAppliedTermIndex

public TermIndex getLastAppliedTermIndex()

Specified by:

getLastAppliedTermIndex in interface StateMachine

setLastAppliedTermIndex

protected void setLastAppliedTermIndex(TermIndex newTI)

notifyTermIndexUpdated

public void notifyTermIndexUpdated(long term,
                                   long index)

Specified by:

notifyTermIndexUpdated in interface StateMachine.EventApi

updateLastAppliedTermIndex

protected boolean updateLastAppliedTermIndex(long term,
                                             long index)

updateLastAppliedTermIndex

protected boolean updateLastAppliedTermIndex(TermIndex newTI)

takeSnapshot

public long takeSnapshot()
                  throws IOException

Specified by:

takeSnapshot in interface StateMachine

Throws:

IOException

getStateMachineStorage

public StateMachineStorage getStateMachineStorage()

Specified by:

getStateMachineStorage in interface StateMachine

queryStale

public CompletableFuture<Message> queryStale(Message request,
                                             long minIndex)

Specified by:

queryStale in interface StateMachine

query

public CompletableFuture<Message> query(Message request)

Specified by:

query in interface StateMachine

startTransaction

public TransactionContext startTransaction(RaftClientRequest request)
                                    throws IOException

Specified by:

startTransaction in interface StateMachine

Throws:

IOException

cancelTransaction

public TransactionContext cancelTransaction(TransactionContext trx)
                                     throws IOException

Specified by:

cancelTransaction in interface StateMachine

Throws:

IOException

preAppendTransaction

public TransactionContext preAppendTransaction(TransactionContext trx)
                                        throws IOException

Specified by:

preAppendTransaction in interface StateMachine

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

recordTime

protected CompletableFuture<Message> recordTime(com.codahale.metrics.Timer timer,
                                                BaseStateMachine.Task task)