org.apache.ratis.server.raftlog.segmented

类 SegmentedRaftLog

java.lang.Object

org.apache.ratis.server.raftlog.RaftLogBase

org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog

所有已实现的接口:

Closeable, AutoCloseable, RaftLog

public class SegmentedRaftLog
extends RaftLogBase

The RaftLog implementation that writes log entries into segmented files in local disk. The max log segment size is 8MB. The real log segment size may not be exactly equal to this limit. If a log entry's size exceeds 8MB, this entry will be stored in a single segment. There are two types of segments: closed segment and open segment. The former is named as "log_startindex-endindex", the later is named as "log_inprogress_startindex". There can be multiple closed segments but there is at most one open segment. When the open segment reaches the size limit, or the log term increases, we close the open segment and start a new open segment. A closed segment cannot be appended anymore, but it can be truncated in case that a follower's log is inconsistent with the current leader. Every closed segment should be non-empty, i.e., it should contain at least one entry. There should not be any gap between segments. The first segment may not start from index 0 since there may be snapshots as log compaction. The last index in segments should be no smaller than the last index of snapshot, otherwise we may have hole when append further log.

嵌套类概要

嵌套类

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

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

RaftLog.EntryWithData

字段概要

从类继承的字段 org.apache.ratis.server.raftlog.RaftLogBase

INVALID_LOG_INDEX, LEAST_VALID_LOG_INDEX

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

LOG

构造器概要

构造器

构造器和说明
SegmentedRaftLog(RaftGroupMemberId memberId, RaftServer.Division server, StateMachine stateMachine, Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> notifyTruncatedLogEntry, Runnable submitUpdateCommitEvent, RaftStorage storage, LongSupplier snapshotIndexSupplier, RaftProperties properties)

方法概要

限定符和类型	方法和说明
default List<CompletableFuture<Long>>	append(org.apache.ratis.proto.RaftProtos.LogEntryProto... arg0) 已过时。
protected CompletableFuture<Long>	appendEntryImpl(org.apache.ratis.proto.RaftProtos.LogEntryProto entry)
List<CompletableFuture<Long>>	appendImpl(List<org.apache.ratis.proto.RaftProtos.LogEntryProto> entries)
void	close()
org.apache.ratis.proto.RaftProtos.LogEntryProto	get(long index)
LogEntryHeader[]	getEntries(long startIndex, long endIndex)
RaftLog.EntryWithData	getEntryWithData(long index)
long	getFlushIndex()
TermIndex	getLastEntryTermIndex()
SegmentedRaftLogMetrics	getRaftLogMetrics()
long	getStartIndex()
TermIndex	getTermIndex(long index)
RaftStorageMetadata	loadMetadata()
CompletableFuture<Long>	onSnapshotInstalled(long lastSnapshotIndex)
protected void	openImpl(long lastIndexInSnapshot, Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> consumer)
void	persistMetadata(RaftStorageMetadata metadata)
protected CompletableFuture<Long>	purgeImpl(long index)
String	toLogEntryString(org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry)
protected CompletableFuture<Long>	truncateImpl(long index)

从类继承的方法 org.apache.ratis.server.raftlog.RaftLogBase

append, append, append, appendEntry, appendMetadata, checkLogState, getLastCommittedIndex, getName, getSnapshotIndex, hasReadLock, hasWriteLock, isOpened, newEntryWithData, open, purge, readLock, toString, truncate, updateCommitIndex, updateSnapshotIndex, updateSnapshotIndexFromStateMachine, validateLogEntry, writeLock

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

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

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

contains, getNextIndex

构造器详细资料

SegmentedRaftLog

public SegmentedRaftLog(RaftGroupMemberId memberId,
                        RaftServer.Division server,
                        StateMachine stateMachine,
                        Consumer<org.apache.ratis.proto.RaftProtos.LogEntryProto> notifyTruncatedLogEntry,
                        Runnable submitUpdateCommitEvent,
                        RaftStorage storage,
                        LongSupplier snapshotIndexSupplier,
                        RaftProperties properties)

方法详细资料

getRaftLogMetrics

public SegmentedRaftLogMetrics getRaftLogMetrics()

openImpl

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

覆盖:

openImpl 在类中 RaftLogBase

抛出:

IOException

getStartIndex

public long getStartIndex()

get

public org.apache.ratis.proto.RaftProtos.LogEntryProto get(long index)
                                                    throws RaftLogIOException

抛出:

RaftLogIOException

getEntryWithData

public RaftLog.EntryWithData getEntryWithData(long index)
                                       throws RaftLogIOException

抛出:

RaftLogIOException

getTermIndex

public TermIndex getTermIndex(long index)

getEntries

public LogEntryHeader[] getEntries(long startIndex,
                                   long endIndex)

getLastEntryTermIndex

public TermIndex getLastEntryTermIndex()

truncateImpl

protected CompletableFuture<Long> truncateImpl(long index)

指定者:

truncateImpl 在类中 RaftLogBase

purgeImpl

protected CompletableFuture<Long> purgeImpl(long index)

指定者:

purgeImpl 在类中 RaftLogBase

appendEntryImpl

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

指定者:

appendEntryImpl 在类中 RaftLogBase

appendImpl

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

指定者:

appendImpl 在类中 RaftLogBase

getFlushIndex

public long getFlushIndex()

persistMetadata

public void persistMetadata(RaftStorageMetadata metadata)
                     throws IOException

抛出:

IOException

loadMetadata

public RaftStorageMetadata loadMetadata()
                                 throws IOException

抛出:

IOException

onSnapshotInstalled

public CompletableFuture<Long> onSnapshotInstalled(long lastSnapshotIndex)

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 RaftLogBase

抛出:

IOException

toLogEntryString

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

覆盖:

toLogEntryString 在类中 RaftLogBase

append

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

已过时。