org.apache.ratis.server.raftlog

Class RaftLogBase

java.lang.Object

org.apache.ratis.server.raftlog.RaftLogBase

All Implemented Interfaces:

Closeable, AutoCloseable, RaftLog

Direct Known Subclasses:

MemoryRaftLog, SegmentedRaftLog

public abstract class RaftLogBase
extends Object
implements RaftLog

Base class of RaftLog. Currently we provide two types of RaftLog implementation: 1. MemoryRaftLog: all the log entries are stored in memory. This is only used for testing. 2. Segmented RaftLog: the log entries are persisted on disk, and are stored in segments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftLogSequentialOps.Runner

Nested classes/interfaces inherited from interface org.apache.ratis.server.raftlog.RaftLog

RaftLog.EntryWithData

Field Summary

Fields

Modifier and Type	Field and Description
static long	INVALID_LOG_INDEX
static long	LEAST_VALID_LOG_INDEX The least valid log index, i.e.

Fields inherited from interface org.apache.ratis.server.raftlog.RaftLog

LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RaftLogBase(RaftGroupMemberId memberId, LongSupplier getSnapshotIndexFromStateMachine, RaftProperties properties)

Method Summary

Modifier and Type	Method and Description
List<CompletableFuture<Long>>	append(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)
long	append(long term, RaftConfiguration configuration)
long	append(long term, TransactionContext transaction)
default List<CompletableFuture<Long>>	append(org.apache.ratis.proto.RaftProtos.LogEntryProto... arg0) Deprecated.
CompletableFuture<Long>	appendEntry(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
protected abstract CompletableFuture<Long>	appendEntryImpl(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
protected abstract List<CompletableFuture<Long>>	appendImpl(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)
long	appendMetadata(long term, long newCommitIndex)
void	checkLogState()
void	close()
long	getLastCommittedIndex()
String	getName()
long	getSnapshotIndex()
boolean	hasReadLock()
boolean	hasWriteLock()
boolean	isOpened() Is this log already opened?
protected RaftLog.EntryWithData	newEntryWithData(org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry, CompletableFuture<org.apache.ratis.thirdparty.com.google.protobuf.ByteString> future)
void	open(long lastIndexInSnapshot, Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> consumer)
protected void	openImpl(long lastIndexInSnapshot, Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> consumer)
CompletableFuture<Long>	purge(long suggestedIndex)
protected abstract CompletableFuture<Long>	purgeImpl(long index)
AutoCloseableLock	readLock()
String	toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry)
String	toString()
CompletableFuture<Long>	truncate(long index)
protected abstract CompletableFuture<Long>	truncateImpl(long index)
boolean	updateCommitIndex(long majorityIndex, long currentTerm, boolean isLeader)
void	updateSnapshotIndex(long newSnapshotIndex)
protected void	updateSnapshotIndexFromStateMachine()
protected void	validateLogEntry(org.apache.ratis.proto.RaftProtos.LogEntryProto entry) Validate the term and index of entry w.r.t RaftLog
AutoCloseableLock	writeLock()

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.raftlog.RaftLog

contains, get, getEntries, getEntryWithData, getFlushIndex, getLastEntryTermIndex, getNextIndex, getRaftLogMetrics, getStartIndex, getTermIndex, loadMetadata, onSnapshotInstalled, persistMetadata

Field Detail

LEAST_VALID_LOG_INDEX

public static final long LEAST_VALID_LOG_INDEX

The least valid log index, i.e. the index used when writing to an empty log.

See Also:

Constant Field Values

INVALID_LOG_INDEX

public static final long INVALID_LOG_INDEX

See Also:

Constant Field Values

Constructor Detail

RaftLogBase

protected RaftLogBase(RaftGroupMemberId memberId,
                      LongSupplier getSnapshotIndexFromStateMachine,
                      RaftProperties properties)

Method Detail

getLastCommittedIndex

public long getLastCommittedIndex()

Specified by:

getLastCommittedIndex in interface RaftLog

getSnapshotIndex

public long getSnapshotIndex()

Specified by:

getSnapshotIndex in interface RaftLog

checkLogState

public void checkLogState()

isOpened

public boolean isOpened()

Is this log already opened?

updateCommitIndex

public boolean updateCommitIndex(long majorityIndex,
                                 long currentTerm,
                                 boolean isLeader)

Specified by:

updateCommitIndex in interface RaftLog

updateSnapshotIndexFromStateMachine

protected void updateSnapshotIndexFromStateMachine()

updateSnapshotIndex

public void updateSnapshotIndex(long newSnapshotIndex)

Specified by:

updateSnapshotIndex in interface RaftLog

append

public final long append(long term,
                         TransactionContext transaction)
                  throws StateMachineException

Throws:

StateMachineException

appendMetadata

public final long appendMetadata(long term,
                                 long newCommitIndex)

append

public final long append(long term,
                         RaftConfiguration configuration)

open

public final void open(long lastIndexInSnapshot,
                       Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> consumer)
                throws IOException

Specified by:

open in interface RaftLog

Throws:

IOException

openImpl

protected void openImpl(long lastIndexInSnapshot,
                        Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> consumer)
                 throws IOException

Throws:

IOException

validateLogEntry

protected void validateLogEntry(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

Validate the term and index of entry w.r.t RaftLog

truncate

public final CompletableFuture<Long> truncate(long index)

truncateImpl

protected abstract CompletableFuture<Long> truncateImpl(long index)

purge

public final CompletableFuture<Long> purge(long suggestedIndex)

Specified by:

purge in interface RaftLog

purgeImpl

protected abstract CompletableFuture<Long> purgeImpl(long index)

appendEntry

public final CompletableFuture<Long> appendEntry(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

appendEntryImpl

protected abstract CompletableFuture<Long> appendEntryImpl(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)

append

public final List<CompletableFuture<Long>> append(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)

appendImpl

protected abstract List<CompletableFuture<Long>> appendImpl(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)

toString

public String toString()

Overrides:

toString in class Object

readLock

public AutoCloseableLock readLock()

writeLock

public AutoCloseableLock writeLock()

hasWriteLock

public boolean hasWriteLock()

hasReadLock

public boolean hasReadLock()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getName

public String getName()

newEntryWithData

protected RaftLog.EntryWithData newEntryWithData(org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry,
                                                 CompletableFuture<org.apache.ratis.thirdparty.com.google.protobuf.ByteString> future)

toLogEntryString

public String toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry)

append

@Deprecated
public List<CompletableFuture<Long>> append(org.apache.ratis.proto.RaftProtos.LogEntryProto... arg0)

Deprecated.