org.apache.ratis.server.leader

Class LogAppenderBase

java.lang.Object

org.apache.ratis.server.leader.LogAppenderBase

All Implemented Interfaces:

LogAppender

public abstract class LogAppenderBase
extends Object
implements LogAppender

An abstract implementation of LogAppender.

Field Summary

Fields inherited from interface org.apache.ratis.server.leader.LogAppender

DEFAULT_CLASS, LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogAppenderBase(RaftServer.Division server, LeaderState leaderState, FollowerInfo f)

Method Summary

Modifier and Type	Method and Description
AwaitForSignal	getEventAwaitForSignal()
FollowerInfo	getFollower()
long	getHeartbeatWaitTimeMs()
LeaderState	getLeaderState()
protected LongUnaryOperator	getNextIndexForError(long newNextIndex)
protected long	getNextIndexForInconsistency(long requestFirstIndex, long replyNextIndex)
protected TimeDuration	getRemainingWaitTime()
RaftServer.Division	getServer()
protected TimeDuration	getWaitTimeMin()
boolean	hasPendingDataRequests()
boolean	isRunning()
org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto	newAppendEntriesRequest(long callId, boolean heartbeat)
org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto	newInstallSnapshotNotificationRequest(TermIndex firstAvailableLogTermIndex)
Iterable<org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto>	newInstallSnapshotRequests(String requestId, SnapshotInfo snapshot)
protected void	resetHeartbeatTrigger()
boolean	shouldSendAppendEntries()
void	start()
CompletableFuture<LifeCycle.State>	stopAsync()
String	toString()
void	triggerHeartbeat()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ratis.server.leader.LogAppender

getCallId, getCallIdComparator, getFollowerId, getRaftLog, getServerRpc, hasAppendEntries, newLogAppenderDefault, notifyLogAppender, onFollowerTerm, run, shouldInstallSnapshot, stop

Constructor Detail

LogAppenderBase

protected LogAppenderBase(RaftServer.Division server,
                          LeaderState leaderState,
                          FollowerInfo f)

Method Detail

triggerHeartbeat

public void triggerHeartbeat()

Specified by:

triggerHeartbeat in interface LogAppender

resetHeartbeatTrigger

protected void resetHeartbeatTrigger()

shouldSendAppendEntries

public boolean shouldSendAppendEntries()

Specified by:

shouldSendAppendEntries in interface LogAppender

getHeartbeatWaitTimeMs

public long getHeartbeatWaitTimeMs()

Specified by:

getHeartbeatWaitTimeMs in interface LogAppender

getEventAwaitForSignal

public AwaitForSignal getEventAwaitForSignal()

Specified by:

getEventAwaitForSignal in interface LogAppender

getServer

public final RaftServer.Division getServer()

Specified by:

getServer in interface LogAppender

toString

public String toString()

Overrides:

toString in class Object

start

public void start()

Specified by:

start in interface LogAppender

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LogAppender

stopAsync

public CompletableFuture<LifeCycle.State> stopAsync()

Specified by:

stopAsync in interface LogAppender

getWaitTimeMin

protected TimeDuration getWaitTimeMin()

getRemainingWaitTime

protected TimeDuration getRemainingWaitTime()

getFollower

public final FollowerInfo getFollower()

Specified by:

getFollower in interface LogAppender

getLeaderState

public final LeaderState getLeaderState()

Specified by:

getLeaderState in interface LogAppender

hasPendingDataRequests

public boolean hasPendingDataRequests()

getNextIndexForInconsistency

protected long getNextIndexForInconsistency(long requestFirstIndex,
                                            long replyNextIndex)

getNextIndexForError

protected LongUnaryOperator getNextIndexForError(long newNextIndex)

newAppendEntriesRequest

public org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto newAppendEntriesRequest(long callId,
                                                                                           boolean heartbeat)
                                                                                    throws RaftLogIOException

Specified by:

newAppendEntriesRequest in interface LogAppender

Throws:

RaftLogIOException

newInstallSnapshotNotificationRequest

public org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto newInstallSnapshotNotificationRequest(TermIndex firstAvailableLogTermIndex)

Specified by:

newInstallSnapshotNotificationRequest in interface LogAppender

newInstallSnapshotRequests

public Iterable<org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto> newInstallSnapshotRequests(String requestId,
                                                                                                          SnapshotInfo snapshot)

Specified by:

newInstallSnapshotRequests in interface LogAppender