org.apache.ratis.server.raftlog

类 RaftLogBase

java.lang.Object

org.apache.ratis.server.raftlog.RaftLogBase

所有已实现的接口:

Closeable, AutoCloseable, RaftLog

直接已知子类:

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.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	RaftLogSequentialOps.Runner

从接口继承的嵌套类/接口 org.apache.ratis.server.raftlog.RaftLog

RaftLog.EntryWithData

字段概要

字段

限定符和类型	字段和说明
static long	INVALID_LOG_INDEX
static long	LEAST_VALID_LOG_INDEX The least valid log index, i.e. the index used when writing to an empty log.

从接口继承的字段 org.apache.ratis.server.raftlog.RaftLog

LOG

构造器概要

构造器

限定符	构造器和说明
protected	RaftLogBase(RaftGroupMemberId memberId, LongSupplier getSnapshotIndexFromStateMachine, RaftProperties properties)

方法概要

限定符和类型	方法和说明
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) 已过时。
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()

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

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

从接口继承的方法 org.apache.ratis.server.raftlog.RaftLog

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

字段详细资料

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.

另请参阅:

常量字段值

INVALID_LOG_INDEX

public static final long INVALID_LOG_INDEX

另请参阅:

常量字段值

构造器详细资料

RaftLogBase

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

方法详细资料

getLastCommittedIndex

public long getLastCommittedIndex()

指定者:

getLastCommittedIndex 在接口中 RaftLog

getSnapshotIndex

public long getSnapshotIndex()

指定者:

getSnapshotIndex 在接口中 RaftLog

checkLogState

public void checkLogState()

isOpened

public boolean isOpened()

Is this log already opened?

updateCommitIndex

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

指定者:

updateCommitIndex 在接口中 RaftLog

updateSnapshotIndexFromStateMachine

protected void updateSnapshotIndexFromStateMachine()

updateSnapshotIndex

public void updateSnapshotIndex(long newSnapshotIndex)

指定者:

updateSnapshotIndex 在接口中 RaftLog

append

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

抛出:

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

指定者:

open 在接口中 RaftLog

抛出:

IOException

openImpl

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

抛出:

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)

指定者:

purge 在接口中 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()

覆盖:

toString 在类中 Object

readLock

public AutoCloseableLock readLock()

writeLock

public AutoCloseableLock writeLock()

hasWriteLock

public boolean hasWriteLock()

hasReadLock

public boolean hasReadLock()

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

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)

已过时。