org.apache.ratis.statemachine

接口 StateMachine.EventApi

封闭接口:

StateMachine

public static interface StateMachine.EventApi

An optional API for event notifications.

字段概要

字段

限定符和类型	字段和说明
static StateMachine.EventApi	DEFAULT A noop implementation of StateMachine.EventApi.

方法概要

限定符和类型	方法和说明
default void	notifyConfigurationChanged(long term, long index, org.apache.ratis.proto.RaftProtos.RaftConfigurationProto newRaftConfiguration) Notify the StateMachine a configuration change.
default void	notifyGroupRemove() Notify the StateMachine a group removal event.
default void	notifyLeaderChanged(RaftGroupMemberId groupMemberId, RaftPeerId newLeaderId) Notify the StateMachine that a new leader has been elected.
default void	notifyLogFailed(Throwable cause, org.apache.ratis.proto.RaftProtos.LogEntryProto failedEntry) Notify the StateMachine that a log operation failed.
default void	notifyServerShutdown(org.apache.ratis.proto.RaftProtos.RoleInfoProto roleInfo) 已过时。
default void	notifyServerShutdown(org.apache.ratis.proto.RaftProtos.RoleInfoProto roleInfo, boolean allServer) Notify the StateMachine that either the server for this division or all the servers have been shut down.
default void	notifySnapshotInstalled(org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result, long snapshotIndex, RaftPeer peer) Notify the StateMachine that the progress of install snapshot is completely done.
default void	notifyTermIndexUpdated(long term, long index) Notify the StateMachine a term-index update event.

字段详细资料

DEFAULT

static final StateMachine.EventApi DEFAULT

A noop implementation of StateMachine.EventApi.

方法详细资料

notifyLeaderChanged

default void notifyLeaderChanged(RaftGroupMemberId groupMemberId,
                                 RaftPeerId newLeaderId)

Notify the StateMachine that a new leader has been elected. Note that the new leader can possibly be this server.

参数:

groupMemberId - The id of this server.

newLeaderId - The id of the new leader.

notifyTermIndexUpdated

default void notifyTermIndexUpdated(long term,
                                    long index)

Notify the StateMachine a term-index update event. This method will be invoked when a RaftProtos.MetadataProto or RaftProtos.RaftConfigurationProto is processed. For RaftProtos.StateMachineLogEntryProto, this method will not be invoked.

参数:

term - The term of the log entry

index - The index of the log entry

notifyConfigurationChanged

default void notifyConfigurationChanged(long term,
                                        long index,
                                        org.apache.ratis.proto.RaftProtos.RaftConfigurationProto newRaftConfiguration)

Notify the StateMachine a configuration change. This method will be invoked when a RaftProtos.RaftConfigurationProto is processed.

参数:

term - term of the current log entry

index - index which is being updated

newRaftConfiguration - new configuration

notifyGroupRemove

default void notifyGroupRemove()

Notify the StateMachine a group removal event. This method is invoked after all the pending transactions have been applied by the StateMachine.

notifyLogFailed

default void notifyLogFailed(Throwable cause,
                             org.apache.ratis.proto.RaftProtos.LogEntryProto failedEntry)

Notify the StateMachine that a log operation failed.

参数:

cause - The cause of the failure.

failedEntry - The failed log entry, if there is any.

notifySnapshotInstalled

default void notifySnapshotInstalled(org.apache.ratis.proto.RaftProtos.InstallSnapshotResult result,
                                     long snapshotIndex,
                                     RaftPeer peer)

Notify the StateMachine that the progress of install snapshot is completely done. Could trigger the cleanup of snapshots.

参数:

result - RaftProtos.InstallSnapshotResult

snapshotIndex - the index of installed snapshot

peer - the peer who installed the snapshot

notifyServerShutdown

@Deprecated
default void notifyServerShutdown(org.apache.ratis.proto.RaftProtos.RoleInfoProto roleInfo)

已过时。

Notify the StateMachine that the server for this division has been shut down.

notifyServerShutdown

default void notifyServerShutdown(org.apache.ratis.proto.RaftProtos.RoleInfoProto roleInfo,
                                  boolean allServer)

Notify the StateMachine that either the server for this division or all the servers have been shut down.

参数:

roleInfo - roleInfo this server

allServer - whether all raft servers will be shutdown at this time