Skip navigation links
A B C D E F G H I L M N O P Q R S T U V W 

A

addClosedSegmentsNum(SegmentedRaftLogCache) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
addClosedSegmentsSizeInBytes(SegmentedRaftLogCache) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
addDataQueueSizeGauge(DataQueue) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
addFlushBatchSizeGauge(MetricRegistry.MetricSupplier<Gauge>) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
addFollower(RaftPeer) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
Register a follower with this Leader Metrics registry instance.
addFollowerGauges(FollowerInfo) - Method in class org.apache.ratis.server.metrics.LogAppenderMetrics
 
addGroup(RaftGroup) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
addLogWorkerQueueSizeGauge(Queue) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
addOpenSegmentSizeInBytes(SegmentedRaftLogCache) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
addPeerCommitIndexGauge(RaftPeerId) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
Register a commit index tracker for the peer in cluster.
addPeers(Iterable<RaftPeer>) - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
addPeers(Iterable<RaftPeer>) - Method in interface org.apache.ratis.server.RaftServerRpc
add information of the given peers
addStateMachineData(ByteString, RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
Return a new log entry based on the input log entry with stateMachineData added.
append(long, TransactionContext) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
append(long, RaftConfiguration) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
append(RaftProtos.LogEntryProto...) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
APPEND_PLACEHOLDER - Static variable in class org.apache.ratis.server.impl.LeaderState
 
appendEntries(RaftProtos.AppendEntriesRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
appendEntries(RaftProtos.AppendEntriesRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
appendEntries(RaftProtos.AppendEntriesRequestProto) - Method in interface org.apache.ratis.server.protocol.RaftServerProtocol
 
appendEntriesAsync(RaftProtos.AppendEntriesRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
appendEntriesAsync(RaftProtos.AppendEntriesRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
appendEntriesAsync(RaftProtos.AppendEntriesRequestProto) - Method in interface org.apache.ratis.server.protocol.RaftServerAsynchronousProtocol
 
appendEntry(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
appendEntryImpl(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
appendEntryImpl(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
appendEntryImpl(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
appendImpl(RaftProtos.LogEntryProto...) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
appendImpl(RaftProtos.LogEntryProto...) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
appendImpl(RaftProtos.LogEntryProto...) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
appendMetadata(long, long) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
applyHeaderTo(CheckedFunction<byte[], T, IOException>) - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
applyTransaction(TransactionContext) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
applyTransaction(TransactionContext) - Method in interface org.apache.ratis.statemachine.StateMachine
Apply a committed log entry to the state machine.
applyTransactionSerial(TransactionContext) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
applyTransactionSerial(TransactionContext) - Method in interface org.apache.ratis.statemachine.StateMachine
Called for transactions that have been committed to the RAFT log.
AUTO_TRIGGER_ENABLED_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
by default let the state machine to decide when to do checkpoint
AUTO_TRIGGER_ENABLED_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
whether trigger snapshot when log size exceeds limit
AUTO_TRIGGER_THRESHOLD_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
AUTO_TRIGGER_THRESHOLD_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
log size limit (in number of log entries) that triggers the snapshot
autoTriggerEnabled(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
autoTriggerThreshold(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 

B

BaseFactory() - Constructor for class org.apache.ratis.server.impl.ServerFactory.BaseFactory
 
BaseStateMachine - Class in org.apache.ratis.statemachine.impl
Base implementation for StateMachines.
BaseStateMachine() - Constructor for class org.apache.ratis.statemachine.impl.BaseStateMachine
 
BaseStateMachine.Task - Interface in org.apache.ratis.statemachine.impl
 
BUFFER_BYTE_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
BUFFER_BYTE_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
BUFFER_ELEMENT_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
0 means no limit.
BUFFER_ELEMENT_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
bufferByteLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
bufferElementLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
build() - Method in class org.apache.ratis.server.impl.RaftConfiguration.Builder
build() - Method in class org.apache.ratis.server.RaftServer.Builder
 
build() - Method in class org.apache.ratis.server.RaftServerRpc.Builder
 
build() - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
Builder() - Constructor for class org.apache.ratis.server.RaftServer.Builder
 
Builder() - Constructor for class org.apache.ratis.server.RaftServerRpc.Builder
 
Builder() - Constructor for class org.apache.ratis.statemachine.TransactionContext.Builder
 
BYTE_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
BYTE_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
byteLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 

C

CacheInvalidationPolicy - Interface in org.apache.ratis.server.raftlog.segmented
 
CacheInvalidationPolicy.CacheInvalidationPolicyDefault - Class in org.apache.ratis.server.raftlog.segmented
 
CacheInvalidationPolicyDefault() - Constructor for class org.apache.ratis.server.raftlog.segmented.CacheInvalidationPolicy.CacheInvalidationPolicyDefault
 
CACHING_ENABLED_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
CACHING_ENABLED_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
cachingEnabled(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
cancelTransaction(TransactionContext) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
cancelTransaction() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
cancelTransaction(TransactionContext) - Method in interface org.apache.ratis.statemachine.StateMachine
Called to notify the state machine that the Transaction passed cannot be appended (or synced).
cancelTransaction() - Method in interface org.apache.ratis.statemachine.TransactionContext
Called to notify the state machine that the Transaction passed cannot be appended (or synced).
cast(RpcFactory) - Static method in interface org.apache.ratis.server.impl.ServerFactory
 
checkLogState() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
checkResponseTerm(long) - Method in class org.apache.ratis.server.impl.LogAppender
 
checkSlowness() - Method in class org.apache.ratis.server.impl.LogAppender
 
cleanUp() - Method in interface org.apache.ratis.statemachine.StateMachine.DataStream
Clean up asynchronously this stream.
cleanupOldSnapshots(SnapshotRetentionPolicy) - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
cleanupOldSnapshots(SnapshotRetentionPolicy) - Method in interface org.apache.ratis.statemachine.StateMachineStorage
 
close() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
close() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
close() - Method in class org.apache.ratis.server.impl.RetryCache
 
close() - Method in class org.apache.ratis.server.impl.ServerState
 
close() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
close() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
close() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogInputStream
 
close() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogOutputStream
 
close() - Method in class org.apache.ratis.server.storage.RaftStorage
 
close() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
closeImpl() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
compareTo(PendingRequest) - Method in class org.apache.ratis.server.impl.PendingRequest
 
compareTo(Long) - Method in class org.apache.ratis.server.raftlog.segmented.LogSegment
 
CONFIG_LOG_ENTRY_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
ConfigurationManager - Class in org.apache.ratis.server.impl
Maintain the mappings between log index and corresponding raft configuration.
contains(TermIndex) - Method in class org.apache.ratis.server.raftlog.RaftLog
Does the log contains the given term and index? Used to check the consistency between the local log of a follower and the log entries sent by the leader.
containsGroup(RaftGroupId) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
CORRUPTION_POLICY_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
CORRUPTION_POLICY_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
corruptionPolicy(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
createInstallSnapshotNotificationRequest(TermIndex) - Method in class org.apache.ratis.server.impl.LogAppender
 
createRequest(long) - Method in class org.apache.ratis.server.impl.LogAppender
 

D

data() - Method in interface org.apache.ratis.statemachine.StateMachine
Get the optional StateMachine.DataApi object.
decreaseNextIndex(long) - Method in class org.apache.ratis.server.impl.FollowerInfo
 
DEFAULT - Static variable in interface org.apache.ratis.statemachine.StateMachine.DataApi
A noop implementation of StateMachine.DataApi.
DEFAULT_ALL_SNAPSHOTS_RETAINED - Static variable in interface org.apache.ratis.statemachine.impl.SnapshotRetentionPolicy
 
DEFAULT_CALLID - Static variable in class org.apache.ratis.server.impl.RaftServerConstants
 

E

ELEMENT_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
ELEMENT_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
ELEMENT_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
ELEMENT_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
elementLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
elementLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
EMPTY_TERMINDEX_ARRAY - Static variable in interface org.apache.ratis.server.protocol.TermIndex
 
EntryWithData(RaftProtos.LogEntryProto, CompletableFuture<ByteString>) - Constructor for class org.apache.ratis.server.raftlog.RaftLog.EntryWithData
 
equals(Object) - Method in class org.apache.ratis.server.impl.RaftConfiguration
 
evict(long[], long, long, SegmentedRaftLogCache.LogSegmentList, int) - Method in class org.apache.ratis.server.raftlog.segmented.CacheInvalidationPolicy.CacheInvalidationPolicyDefault
 
evict(long[], long, long, SegmentedRaftLogCache.LogSegmentList, int) - Method in interface org.apache.ratis.server.raftlog.segmented.CacheInvalidationPolicy
Determine which log segments should evict their log entry cache
EXPIRY_TIME_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.RetryCache
 
EXPIRY_TIME_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.RetryCache
 
expiryTime(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.RetryCache
 

F

FileInfo - Class in org.apache.ratis.server.storage
Metadata about a file.
FileInfo(Path, MD5Hash) - Constructor for class org.apache.ratis.server.storage.FileInfo
 
FileListSnapshotInfo - Class in org.apache.ratis.statemachine.impl
Each snapshot has a list of files.
FileListSnapshotInfo(List<FileInfo>, long, long) - Constructor for class org.apache.ratis.statemachine.impl.FileListSnapshotInfo
 
findLatestSnapshot() - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
flush() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogOutputStream
Flush data to persistent store.
flush(long) - Method in interface org.apache.ratis.statemachine.StateMachine.DataApi
Flush the state machine data till the given log index.
FOLLOWER_APPEND_ENTRIES_LATENCY - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
FOLLOWER_LAST_HEARTBEAT_ELAPSED_TIME_METRIC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
FOLLOWER_MATCH_INDEX - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
FOLLOWER_NEXT_INDEX - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
FOLLOWER_RPC_RESP_TIME - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
FollowerInfo - Class in org.apache.ratis.server.impl
 
FORCE_SYNC_NUM_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
FORCE_SYNC_NUM_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
forceSyncNum(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
format() - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
format() - Method in interface org.apache.ratis.statemachine.StateMachineStorage
 

G

get(long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
get(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
Get the log entry of the given index.
get() - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
get(long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
get(T, Function<T, RaftServerConfigKeys.Log.CorruptionPolicy>) - Static method in enum org.apache.ratis.server.RaftServerConfigKeys.Log.CorruptionPolicy
 
getCachedSegmentNum() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogCache
 
getClientRequest() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
getClientRequest() - Method in interface org.apache.ratis.statemachine.TransactionContext
Returns the original request from the RaftClientRequest
getClientRequestTimer(RaftClientRequest) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
 
getClosedLogFile(long, long) - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
getClosedSegmentsSizeInBytes() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogCache
 
getCommitInfoCache() - Method in class org.apache.ratis.server.impl.RaftServerImpl
return ref to the commit info cache.
getCorruptSnapshotFile(long, long) - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getCorruptSnapshotFileName(long, long) - Static method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getCounter(String) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
 
getCurrentTerm() - Method in class org.apache.ratis.server.impl.ServerState
 
getCurrentTerm() - Method in interface org.apache.ratis.server.RaftServerMXBean
Latest RAFT term.
getDefault() - Static method in enum org.apache.ratis.server.RaftServerConfigKeys.Log.CorruptionPolicy
 
getDefaultLog() - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
getEndIndex() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory.LogPathAndIndex
 
getEntries(long, long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getEntries(long, long) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getEntries(long, long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
getEntry(TimeDuration) - Method in class org.apache.ratis.server.raftlog.RaftLog.EntryWithData
 
getEntryString() - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getEntryWithData(long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getEntryWithData(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
Get the log entry of the given index along with the state machine data.
getEntryWithData(long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
getException() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
getException() - Method in interface org.apache.ratis.statemachine.TransactionContext
Returns the exception from the StateMachine or the log
getFactory() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getFactory() - Method in interface org.apache.ratis.server.RaftServer
 
getFile() - Method in class org.apache.ratis.statemachine.impl.SingleFileSnapshotInfo
 
getFileDigest() - Method in class org.apache.ratis.server.storage.FileInfo
 
getFiles() - Method in class org.apache.ratis.statemachine.impl.FileListSnapshotInfo
 
getFiles() - Method in interface org.apache.ratis.statemachine.SnapshotInfo
Returns a list of files corresponding to this snapshot.
getFileSize() - Method in class org.apache.ratis.server.storage.FileInfo
 
getFlushIndex() - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getFlushIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getFlushIndex() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
getFlushTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getFollower() - Method in class org.apache.ratis.server.impl.LogAppender
 
getFollowerAppendEntryTimer(boolean) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
 
getFollowerId() - Method in class org.apache.ratis.server.impl.LogAppender
 
getFollowerNextIndices() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getFollowers() - Method in interface org.apache.ratis.server.RaftServerMXBean
Addresses of the followers, only for leaders
getFuture() - Method in class org.apache.ratis.server.impl.PendingRequest
 
getGroupId() - Method in interface org.apache.ratis.server.RaftServerMXBean
Cluster identifier.
getGroupId() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getGroupIds() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getGroupIds() - Method in interface org.apache.ratis.server.RaftServer
 
getGroupInfo(GroupInfoRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getGroupInfoAsync(GroupInfoRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getGroupList(GroupListRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getGroupListAsync(GroupListRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getGroups() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getGroups() - Method in interface org.apache.ratis.server.RaftServer
 
getHalfMinTimeoutMs() - Method in class org.apache.ratis.server.impl.LogAppender
 
getHeaderLength() - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
getHeartbeatRemainingTime() - Method in class org.apache.ratis.server.impl.LogAppender
 
getId() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getId() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getId() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
getId() - Method in interface org.apache.ratis.server.RaftServer
 
getId() - Method in interface org.apache.ratis.server.RaftServerMXBean
Identifier of the current server.
getId() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getImpl(RaftGroupId) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getIndex() - Method in interface org.apache.ratis.server.protocol.TermIndex
 
getIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog.EntryWithData
 
getIndex() - Method in class org.apache.ratis.statemachine.impl.FileListSnapshotInfo
 
getIndex() - Method in interface org.apache.ratis.statemachine.SnapshotInfo
Returns the index corresponding to this snapshot.
getInetSocketAddress() - Method in interface org.apache.ratis.server.RaftServerRpc
 
getLastAppliedIndex() - Method in class org.apache.ratis.server.impl.ServerState
 
getLastAppliedTermIndex() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getLastAppliedTermIndex() - Method in interface org.apache.ratis.statemachine.StateMachine
 
getLastCommittedIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getLastEntryTermIndex() - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getLastEntryTermIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getLastEntryTermIndex() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
getLastLeaderElapsedTimeMs() - Method in class org.apache.ratis.server.impl.ServerState
 
getLastRpcTime() - Method in class org.apache.ratis.server.impl.FollowerInfo
 
getLatestInstalledSnapshotIndex() - Method in class org.apache.ratis.server.impl.ServerState
 
getLatestSnapshot() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getLatestSnapshot() - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getLatestSnapshot() - Method in interface org.apache.ratis.statemachine.StateMachine
Returns the information for the latest durable snapshot.
getLatestSnapshot() - Method in interface org.apache.ratis.statemachine.StateMachineStorage
Returns the information for the latest durable snapshot.
getLeaderElectionMetrics() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getLeaderElectionMetrics(RaftServerImpl) - Static method in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
getLeaderId() - Method in interface org.apache.ratis.server.RaftServerMXBean
Identifier of the leader node.
getLifeCycle() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
getLifeCycle() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getLifeCycleState() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getLifeCycleState() - Method in interface org.apache.ratis.server.RaftServer
 
getLifeCycleState() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getLifeCycleState() - Method in interface org.apache.ratis.statemachine.StateMachine
Returns the lifecycle state for this StateMachine.
getLog() - Method in class org.apache.ratis.server.impl.ServerState
 
getLogCorruptionPolicy() - Method in class org.apache.ratis.server.storage.RaftStorage
 
getLogEntry() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
getLogEntry() - Method in interface org.apache.ratis.statemachine.TransactionContext
Returns the committed log entry
getLogSegmentFiles() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
getMatchIndex() - Method in class org.apache.ratis.server.impl.FollowerInfo
 
getMemberId() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getMetaFile() - Method in class org.apache.ratis.server.storage.RaftStorage
 
getName() - Method in class org.apache.ratis.server.impl.FollowerInfo
 
getName() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getNewTempDir() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
Returns a uniquely named temporary directory under $rootdir/tmp/
getNextIndex() - Method in class org.apache.ratis.server.impl.FollowerInfo
 
getNextIndex() - Method in class org.apache.ratis.server.impl.ServerState
 
getNextIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getNumSnapshotsRetained() - Method in interface org.apache.ratis.statemachine.impl.SnapshotRetentionPolicy
If a retention policy is configured, get the number of recent snapshots to retain.
getOpenLogFile(long) - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
getOpenSegmentSizeInBytes() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogCache
 
getOption(String) - Static method in enum org.apache.ratis.server.impl.RaftServerConstants.StartupOption
 
getOtherPeers(RaftPeerId) - Method in class org.apache.ratis.server.impl.RaftConfiguration
 
getPath() - Method in class org.apache.ratis.server.storage.FileInfo
 
getPath() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory.LogPathAndIndex
 
getPeer() - Method in class org.apache.ratis.server.impl.FollowerInfo
 
getPeer(RaftPeerId) - Method in class org.apache.ratis.server.impl.RaftConfiguration
 
getPeerCommitIndexGauge(RaftServerImpl, RaftServerImpl) - Static method in class org.apache.ratis.server.impl.RaftServerMetrics
Get the commit index gauge for the given peer of the server
getPeers() - Method in class org.apache.ratis.server.impl.RaftConfiguration
 
getProperties() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getProperties() - Method in interface org.apache.ratis.server.RaftServer
 
getProxies() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
getProxy() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getRaftLog() - Method in class org.apache.ratis.server.impl.LogAppender
 
getRaftLogAppendEntryTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogEnqueueDelayTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogLoadSegmentTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogMetrics() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getRaftLogPurgeTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogQueueTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogReadEntryTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogSyncTimer() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftLogTaskExecutionTimer(String) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
getRaftServerMetrics() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getRaftServerMetrics(RaftServerImpl) - Static method in class org.apache.ratis.server.impl.RaftServerMetrics
 
getRegistry() - Method in class org.apache.ratis.server.impl.RaftServerMetrics
 
getRetryCache() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getRole() - Method in interface org.apache.ratis.server.RaftServerMXBean
RAFT Role of the server.
getRoleInfoProto() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getRoot() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
Get root directory of this storage
getRpcType() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getSerializedSize(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
getSerializedSize() - Method in class org.apache.ratis.server.raftlog.RaftLog.EntryWithData
 
getServer() - Method in class org.apache.ratis.server.impl.LogAppender
 
getServer() - Method in class org.apache.ratis.server.RaftServerRpc.Builder
 
getServer() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getServerRole() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
getServerRole() - Method in interface org.apache.ratis.statemachine.TransactionContext
 
getServerRpc() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getServerRpc() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
getSmDir() - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getSnapshotFile(long, long) - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getSnapshotFileName(long, long) - Static method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getSnapshotIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getStartIndex() - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getStartIndex() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
getStartIndex() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
getStartIndex() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory.LogPathAndIndex
 
getState() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getStateMachine() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
getStateMachineContext() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
getStateMachineContext() - Method in interface org.apache.ratis.statemachine.TransactionContext
Returns the StateMachine the current TransactionContext specific to
getStateMachineData(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
getStateMachineDir() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
getStateMachineEntry(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
getStateMachineLogEntry() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
getStateMachineLogEntry() - Method in interface org.apache.ratis.statemachine.TransactionContext
Returns the data from the StateMachine
getStateMachineMetrics(RaftServerImpl, RaftLogIndex, StateMachine) - Static method in class org.apache.ratis.server.impl.StateMachineMetrics
 
getStateMachineStorage() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
getStateMachineStorage() - Method in interface org.apache.ratis.statemachine.StateMachine
 
getStorage() - Method in class org.apache.ratis.server.impl.ServerState
 
getStorageDir() - Method in class org.apache.ratis.server.storage.RaftStorage
 
getTakeSnapshotTimer() - Method in class org.apache.ratis.server.impl.StateMachineMetrics
 
getTerm() - Method in interface org.apache.ratis.server.protocol.TermIndex
 
getTerm() - Method in class org.apache.ratis.server.raftlog.RaftLog.Metadata
 
getTerm() - Method in class org.apache.ratis.server.storage.MetaFile
 
getTerm() - Method in class org.apache.ratis.statemachine.impl.FileListSnapshotInfo
 
getTerm() - Method in interface org.apache.ratis.statemachine.SnapshotInfo
Returns the term corresponding to this snapshot.
getTerminator() - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
getTermIndex(long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
getTermIndex(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
Get the TermIndex information of the given index.
getTermIndex(long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
getTermIndex() - Method in class org.apache.ratis.statemachine.impl.FileListSnapshotInfo
 
getTermIndex() - Method in interface org.apache.ratis.statemachine.SnapshotInfo
Returns the term and index corresponding to this snapshot.
getTermIndexFromSnapshotFile(File) - Static method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getThis() - Method in class org.apache.ratis.server.RaftServerRpc.Builder
 
getTimer(String) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
 
getTmpSnapshotFile(long, long) - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getTmpSnapshotFileName(long, long) - Static method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
getVotedFor() - Method in class org.apache.ratis.server.raftlog.RaftLog.Metadata
 
getVotedFor() - Method in class org.apache.ratis.server.storage.MetaFile
 
getWritableByteChannel() - Method in interface org.apache.ratis.statemachine.StateMachine.DataStream
 
groupManagement(GroupManagementRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
groupManagementAsync(GroupManagementRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 

H

handleException(RaftPeerId, Exception, boolean) - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
handleException(RaftPeerId, Exception, boolean) - Method in interface org.apache.ratis.server.RaftServerRpc
Handle the given exception.
hashCode() - Method in class org.apache.ratis.server.impl.RaftConfiguration
 
hasMetaFile() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
hasReadLock() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
hasWriteLock() - Method in class org.apache.ratis.server.raftlog.RaftLog
 

I

increaseNextIndex(long) - Method in class org.apache.ratis.server.impl.FollowerInfo
 
incrementAndGet(Consumer<Object>) - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
indexOfNonTerminator(byte[], int, int) - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
init(RaftStorage) - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
init(RaftStorage) - Method in interface org.apache.ratis.statemachine.StateMachineStorage
 
initialize(RaftServer, RaftGroupId, RaftStorage) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
initialize(RaftServer, RaftGroupId, RaftStorage) - Method in interface org.apache.ratis.statemachine.StateMachine
Initializes the State Machine with the given server, group and storage.
initLogEntry(long, long) - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
initLogEntry(long, long) - Method in interface org.apache.ratis.statemachine.TransactionContext
INSTALL_SNAPSHOT_ENABLED_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
INSTALL_SNAPSHOT_ENABLED_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
installSnapshot(RaftProtos.InstallSnapshotRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
installSnapshot(RaftProtos.InstallSnapshotRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
installSnapshot(RaftProtos.InstallSnapshotRequestProto) - Method in interface org.apache.ratis.server.protocol.RaftServerProtocol
 
installSnapshot(StateMachine, RaftProtos.InstallSnapshotRequestProto) - Method in class org.apache.ratis.server.storage.SnapshotManager
 
installSnapshotEnabled(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
Internal() - Constructor for class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat.Internal
 
INVALID_LOG_INDEX - Static variable in class org.apache.ratis.server.impl.RaftServerConstants
Deprecated.
INVALID_LOG_INDEX - Static variable in class org.apache.ratis.server.raftlog.RaftLog
 
isAlive() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
isAppenderRunning() - Method in class org.apache.ratis.server.impl.LogAppender
 
isCandidate() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
isConfigEntry(TermIndex) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
isConfigEntry(TermIndex) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
isConfigEntry(TermIndex) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
isFollower() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
isLeader() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
isLeaderReady() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
isOpen() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory.LogPathAndIndex
 
isOpened() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
isTerminator(byte) - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
isTerminator(byte[], int, int) - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
isValidTerm(int) - Static method in interface org.apache.ratis.server.protocol.TermIndex
A term number is valid iff it is greater than zero.
iterator() - Method in class org.apache.ratis.server.impl.LogAppender.SnapshotRequestIter
 

L

LAST_LEADER_ELAPSED_TIME - Static variable in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
LEADER_ELECTION_COUNT_METRIC - Static variable in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
LEADER_ELECTION_LATENCY - Static variable in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
LEADER_ELECTION_TIMEOUT_COUNT_METRIC - Static variable in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
LEADER_METRIC_PEER_COMMIT_INDEX - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
LeaderElectionMetrics - Class in org.apache.ratis.server.metrics
Class to update the metrics related to Leader Election.
LeaderState - Class in org.apache.ratis.server.impl
States for leader only.
LEAST_VALID_LOG_INDEX - Static variable in class org.apache.ratis.server.raftlog.RaftLog
The least valid log index, i.e.
link(StateMachine.DataStream, RaftProtos.LogEntryProto) - Method in interface org.apache.ratis.statemachine.StateMachine.DataApi
Link asynchronously the given stream with the given log entry.
loadLatestSnapshot() - Method in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
loadMetadata() - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
loadMetadata() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
loadMetadata() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
lock() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
Lock storage to provide exclusive access.
LOG - Static variable in class org.apache.ratis.server.impl.FollowerInfo
 
LOG - Static variable in class org.apache.ratis.server.impl.LogAppender
 
LOG - Static variable in class org.apache.ratis.server.impl.RaftServerImpl
 
LOG - Static variable in class org.apache.ratis.server.impl.RaftServerProxy
 
LOG - Static variable in class org.apache.ratis.server.raftlog.RaftLog
 
LOG - Static variable in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogCache
 
LOG - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
LOG - Static variable in interface org.apache.ratis.statemachine.StateMachine
 
LOG_APPENDER_INSTALL_SNAPSHOT_METRIC - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
LOG_SYNC - Static variable in class org.apache.ratis.server.raftlog.RaftLog
 
LogAppender - Class in org.apache.ratis.server.impl
A daemon thread appending log entries to a follower peer.
LogAppender(RaftServerImpl, LeaderState, FollowerInfo) - Constructor for class org.apache.ratis.server.impl.LogAppender
 
LogAppender.SnapshotRequestIter - Class in org.apache.ratis.server.impl
 
LogAppenderMetrics - Class in org.apache.ratis.server.metrics
 
LogAppenderMetrics(RaftGroupMemberId) - Constructor for class org.apache.ratis.server.metrics.LogAppenderMetrics
 
LogSegment - Class in org.apache.ratis.server.raftlog.segmented
In-memory cache for a log segment file.
LONG_TO_STRING - Static variable in interface org.apache.ratis.server.protocol.TermIndex
 

M

main(String[]) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
matchHeader(byte[], int, int) - Static method in interface org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogFormat
 
MemoryRaftLog - Class in org.apache.ratis.server.raftlog.memory
A simple RaftLog implementation in memory.
MemoryRaftLog(RaftGroupMemberId, long, RaftProperties) - Constructor for class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
Metadata(RaftPeerId, long) - Constructor for class org.apache.ratis.server.raftlog.RaftLog.Metadata
 
METADATA_LOG_ENTRY_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
MetaFile - Class in org.apache.ratis.server.storage
Class that represents a file on disk which persistently stores a single long value.

N

newBuilder() - Static method in class org.apache.ratis.server.impl.RaftConfiguration
newBuilder() - Static method in interface org.apache.ratis.server.RaftServer
 
newBuilder() - Static method in interface org.apache.ratis.statemachine.TransactionContext
 
newLogAppender(RaftServerImpl, LeaderState, FollowerInfo) - Method in class org.apache.ratis.server.impl.ServerFactory.BaseFactory
 
newLogAppender(RaftServerImpl, LeaderState, FollowerInfo) - Method in interface org.apache.ratis.server.impl.ServerFactory
Create a new LogAppender.
newRaftServer(RaftPeerId, RaftGroup, StateMachine.Registry, RaftProperties, Parameters) - Static method in class org.apache.ratis.server.impl.ServerImplUtils
For the case that all RaftServerImpl objects share the same StateMachine.
newRaftServer(RaftPeerId, StateMachine.Registry, RaftProperties, Parameters) - Static method in class org.apache.ratis.server.impl.ServerImplUtils
 
newRaftServerRpc(RaftServer) - Method in interface org.apache.ratis.server.impl.ServerFactory
 
newTermIndex(long, long) - Static method in class org.apache.ratis.server.impl.ServerImplUtils
 
newTermIndex(long, long) - Static method in interface org.apache.ratis.server.protocol.TermIndex
Create a new TermIndex instance.
nextEntry() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogInputStream
 
NO_LEADER_TIMEOUT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Notification
 
NO_LEADER_TIMEOUT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Notification
Timeout value to notify the state machine when there is no leader.
noLeaderTimeout(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Notification
 
notifyAppend() - Method in class org.apache.ratis.server.impl.LogAppender
 
notifyExtendedNoLeader(RaftProtos.RoleInfoProto) - Method in interface org.apache.ratis.statemachine.StateMachine
Notify the Leader's state machine that a leader has not been elected for a long time this notification is based on "raft.server.leader.election.timeout"
notifyGroupRemove() - Method in interface org.apache.ratis.statemachine.StateMachine
Notify about group removal in the state machine.
notifyIndexUpdate(long, long) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
notifyIndexUpdate(long, long) - Method in interface org.apache.ratis.statemachine.StateMachine
Called to notify state machine about indexes which are processed internally by Raft Server, this currently happens when conf entries are processed in raft Server.
notifyInstallSnapshotFromLeader(RaftProtos.RoleInfoProto, TermIndex) - Method in interface org.apache.ratis.statemachine.StateMachine
Notify the Follower's state machine that the leader has purged entries from its log and hence to catch up, the Follower state machine would have to install the latest snapshot.
notifyLeaderChanged(RaftGroupMemberId, RaftPeerId) - Method in interface org.apache.ratis.statemachine.StateMachine
Notify the state machine that a RaftPeer has been elected as leader.
notifyLogFailed(Throwable, RaftProtos.LogEntryProto) - Method in interface org.apache.ratis.statemachine.StateMachine
Notify the state machine that the pipeline has failed.
notifyNotLeader(RaftGroupId) - Method in interface org.apache.ratis.server.RaftServerRpc
The server role changes from leader to a non-leader role.
notifyNotLeader(Collection<TransactionContext>) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
notifyNotLeader(Collection<TransactionContext>) - Method in interface org.apache.ratis.statemachine.StateMachine
Notify the state machine that the raft peer is no longer leader.
notifySlowness(RaftProtos.RoleInfoProto) - Method in interface org.apache.ratis.statemachine.StateMachine
Notify the Leader's state machine that one of the followers is slow this notification is based on "raft.server.rpc.slowness.timeout"
notifyTruncatedLogEntry(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.impl.RaftServerImpl
The given log entry is being truncated.

O

onLeaderElectionCompletion(long) - Method in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
onLeaderElectionTimeout() - Method in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
onLogEntryCommit(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
onNewLeaderElection() - Method in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
onRaftLogAppendEntry() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
onRaftLogCacheHit() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
onRaftLogCacheMiss() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
onRaftLogFlush() - Method in class org.apache.ratis.server.metrics.RaftLogMetrics
 
onRequestQueueLimitHit() - Method in class org.apache.ratis.server.impl.RaftServerMetrics
 
open(long, Consumer<RaftProtos.LogEntryProto>) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
openImpl(long, Consumer<RaftProtos.LogEntryProto>) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
openImpl(long, Consumer<RaftProtos.LogEntryProto>) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
org.apache.ratis.server - package org.apache.ratis.server
 
org.apache.ratis.server.impl - package org.apache.ratis.server.impl
 
org.apache.ratis.server.metrics - package org.apache.ratis.server.metrics
 
org.apache.ratis.server.protocol - package org.apache.ratis.server.protocol
 
org.apache.ratis.server.raftlog - package org.apache.ratis.server.raftlog
 
org.apache.ratis.server.raftlog.memory - package org.apache.ratis.server.raftlog.memory
 
org.apache.ratis.server.raftlog.segmented - package org.apache.ratis.server.raftlog.segmented
 
org.apache.ratis.server.storage - package org.apache.ratis.server.storage
 
org.apache.ratis.statemachine - package org.apache.ratis.statemachine
 
org.apache.ratis.statemachine.impl - package org.apache.ratis.statemachine.impl
 

P

pause() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
pause() - Method in interface org.apache.ratis.statemachine.StateMachine
Pauses the state machine.
PendingRequest - Class in org.apache.ratis.server.impl
 
PREALLOCATED_SIZE_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
PREALLOCATED_SIZE_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
preallocatedSize(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
preAppendTransaction(TransactionContext) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
preAppendTransaction() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
preAppendTransaction(TransactionContext) - Method in interface org.apache.ratis.statemachine.StateMachine
This is called before the transaction passed from the StateMachine is appended to the raft log.
preAppendTransaction() - Method in interface org.apache.ratis.statemachine.TransactionContext
This is called before the transaction passed from the StateMachine is appended to the raft log.
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Notification
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.RetryCache
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
PREFIX - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
processOnePath(Path) - Static method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
purge(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
Purge asynchronously the log transactions.
PURGE_GAP_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
PURGE_GAP_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
PURGE_UPTO_SNAPSHOT_INDEX_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
PURGE_UPTO_SNAPSHOT_INDEX_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
purgeGap(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
purgeImpl(long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
purgeImpl(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
purgeImpl(long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
purgeUptoSnapshotIndex(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 

Q

query(Message) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
query(Message) - Method in interface org.apache.ratis.statemachine.StateMachine
Query the state machine.
queryStale(Message, long) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
queryStale(Message, long) - Method in interface org.apache.ratis.statemachine.StateMachine
Query the state machine, provided minIndex <= commit index.
QUEUE_BYTE_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
QUEUE_BYTE_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
QUEUE_ELEMENT_LIMIT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
QUEUE_ELEMENT_LIMIT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
queueByteLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
queueElementLimit(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 

R

RAFT_CLIENT_READ_REQUEST - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RAFT_CLIENT_STALE_READ_REQUEST - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RAFT_CLIENT_WATCH_REQUEST - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RAFT_CLIENT_WRITE_REQUEST - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RAFT_LOG_APPEND_ENTRY_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_APPEND_ENTRY_LATENCY - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_CACHE_CLOSED_SEGMENTS_NUM - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_CACHE_CLOSED_SEGMENTS_SIZE_IN_BYTES - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_CACHE_HIT_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_CACHE_MISS_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_CACHE_OPEN_SEGMENT_SIZE_IN_BYTES - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_DATA_QUEUE_SIZE - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_FLUSH_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_FLUSH_TIME - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_LOAD_SEGMENT_LATENCY - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_PURGE_METRIC - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_READ_ENTRY_LATENCY - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_SYNC_BATCH_SIZE - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_SYNC_TIME - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_TASK_ENQUEUE_DELAY - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_TASK_EXECUTION_TIME - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_TASK_QUEUE_TIME - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RAFT_LOG_WORKER_QUEUE_SIZE - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RaftConfiguration - Class in org.apache.ratis.server.impl
The configuration of the raft cluster.
RaftConfiguration.Builder - Class in org.apache.ratis.server.impl
To build RaftConfiguration objects.
RaftLog - Class in org.apache.ratis.server.raftlog
Base class of RaftLog.
RaftLog(RaftGroupMemberId, long, RaftProperties) - Constructor for class org.apache.ratis.server.raftlog.RaftLog
 
RaftLog.EntryWithData - Class in org.apache.ratis.server.raftlog
Holds proto entry along with future which contains read state machine data
RaftLog.Metadata - Class in org.apache.ratis.server.raftlog
 
RaftLogIndex - Class in org.apache.ratis.server.raftlog
Indices of RaftLog such as commit index, match index, etc.
RaftLogIndex(Object, long) - Constructor for class org.apache.ratis.server.raftlog.RaftLogIndex
 
RaftLogIOException - Exception in org.apache.ratis.server.raftlog
Exception while reading/writing RaftLog
RaftLogIOException(Throwable) - Constructor for exception org.apache.ratis.server.raftlog.RaftLogIOException
 
RaftLogIOException(String) - Constructor for exception org.apache.ratis.server.raftlog.RaftLogIOException
 
RaftLogIOException(String, Throwable) - Constructor for exception org.apache.ratis.server.raftlog.RaftLogIOException
 
RaftLogMetrics - Class in org.apache.ratis.server.metrics
 
RaftLogMetrics(String) - Constructor for class org.apache.ratis.server.metrics.RaftLogMetrics
 
RaftServer - Interface in org.apache.ratis.server
Raft server interface
RaftServer.Builder - Class in org.apache.ratis.server
To build RaftServer objects.
RaftServerAsynchronousProtocol - Interface in org.apache.ratis.server.protocol
 
RaftServerConfigKeys - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.Log - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.Log.Appender - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.Log.CorruptionPolicy - Enum in org.apache.ratis.server
The policy to handle corrupted raft log.
RaftServerConfigKeys.Log.StateMachineData - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.Notification - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.RetryCache - Interface in org.apache.ratis.server
server retry cache related
RaftServerConfigKeys.Rpc - Interface in org.apache.ratis.server
server rpc timeout related
RaftServerConfigKeys.Snapshot - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.Watch - Interface in org.apache.ratis.server
 
RaftServerConfigKeys.Write - Interface in org.apache.ratis.server
 
RaftServerConstants - Class in org.apache.ratis.server.impl
 
RaftServerConstants.StartupOption - Enum in org.apache.ratis.server.impl
 
RaftServerImpl - Class in org.apache.ratis.server.impl
 
RaftServerMetrics - Class in org.apache.ratis.server.impl
Metric Registry for Raft Group Server.
RaftServerMXBean - Interface in org.apache.ratis.server
JMX information about the state of the current raft cluster.
RaftServerProtocol - Interface in org.apache.ratis.server.protocol
 
RaftServerProtocol.Op - Enum in org.apache.ratis.server.protocol
 
RaftServerProxy - Class in org.apache.ratis.server.impl
 
RaftServerRpc - Interface in org.apache.ratis.server
An server-side interface for supporting different RPC implementations such as Netty, gRPC and Hadoop.
RaftServerRpc.Builder<B extends RaftServerRpc.Builder,RPC extends RaftServerRpc> - Class in org.apache.ratis.server
To build RaftServerRpc objects.
RaftServerRpcWithProxy<PROXY extends Closeable,PROXIES extends PeerProxyMap<PROXY>> - Class in org.apache.ratis.server.impl
Implementing RaftServerRpc using a PeerProxyMap.
RaftServerRpcWithProxy(Supplier<RaftPeerId>, Function<RaftPeerId, PROXIES>) - Constructor for class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
RaftStorage - Class in org.apache.ratis.server.storage
 
RaftStorage(File, RaftServerConstants.StartupOption) - Constructor for class org.apache.ratis.server.storage.RaftStorage
 
RaftStorage(File, RaftServerConstants.StartupOption, RaftServerConfigKeys.Log.CorruptionPolicy) - Constructor for class org.apache.ratis.server.storage.RaftStorage
 
RaftStorageDirectory - Class in org.apache.ratis.server.storage
 
RaftStorageDirectory.LogPathAndIndex - Class in org.apache.ratis.server.storage
 
RATIS_LEADER_ELECTION_METRICS - Static variable in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
RATIS_LEADER_ELECTION_METRICS_DESC - Static variable in class org.apache.ratis.server.metrics.LeaderElectionMetrics
 
RATIS_LOG_APPENDER_METRICS - Static variable in class org.apache.ratis.server.metrics.LogAppenderMetrics
 
RATIS_LOG_APPENDER_METRICS_DESC - Static variable in class org.apache.ratis.server.metrics.LogAppenderMetrics
 
RATIS_LOG_WORKER_METRICS - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RATIS_LOG_WORKER_METRICS_DESC - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
RATIS_SERVER_METRICS - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RATIS_SERVER_METRICS_DESC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RATIS_STATEMACHINE_METRICS - Static variable in class org.apache.ratis.server.impl.StateMachineMetrics
 
RATIS_STATEMACHINE_METRICS_DESC - Static variable in class org.apache.ratis.server.impl.StateMachineMetrics
 
read(RaftProtos.LogEntryProto) - Method in interface org.apache.ratis.statemachine.StateMachine.DataApi
Read asynchronously the state machine data from this state machine.
readLock() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
readRaftConfiguration() - Method in class org.apache.ratis.server.storage.RaftStorage
 
readSegmentFile(File, long, long, boolean, RaftServerConfigKeys.Log.CorruptionPolicy, RaftLogMetrics, Consumer<RaftProtos.LogEntryProto>) - Static method in class org.apache.ratis.server.raftlog.segmented.LogSegment
 
rebuildLogEntryProto(RaftProtos.LogEntryProto, RaftProtos.StateMachineEntryProto.Builder) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
recordFollowerHeartbeatElapsedTime(RaftPeer, long) - Method in class org.apache.ratis.server.impl.RaftServerMetrics
Record heartbeat elapsed time for a follower within a Raft group.
recordTime(Timer, BaseStateMachine.Task) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
reinitialize() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
reinitialize() - Method in interface org.apache.ratis.statemachine.StateMachine
Re-initializes the State Machine in PAUSED state.
relativizeToRoot(Path) - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
removeRaftServerMetrics(RaftServerImpl) - Static method in class org.apache.ratis.server.impl.RaftServerMetrics
 
removeStateMachineData(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
If the given entry has state machine log entry and it has state machine data, build a new entry without the state machine data.
REQUEST_BYTE_SIZE - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
REQUEST_BYTE_SIZE_LIMIT_HIT_COUNTER - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
REQUEST_QUEUE_LIMIT_HIT_COUNTER - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
REQUEST_QUEUE_SIZE - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
REQUEST_TIMEOUT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
REQUEST_TIMEOUT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
requestTimeout(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
requestVote(RaftProtos.RequestVoteRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
requestVote(RaftProtos.RequestVoteRequestProto) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
requestVote(RaftProtos.RequestVoteRequestProto) - Method in interface org.apache.ratis.server.protocol.RaftServerProtocol
 
RESOURCE_LIMIT_HIT_COUNTER - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RETENTION_FILE_NUM_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
RETENTION_FILE_NUM_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
retentionFileNum(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
RETRY_CACHE_ENTRY_COUNT_METRIC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RETRY_CACHE_HIT_COUNT_METRIC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RETRY_CACHE_HIT_RATE_METRIC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RETRY_CACHE_MISS_COUNT_METRIC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RETRY_CACHE_MISS_RATE_METRIC - Static variable in class org.apache.ratis.server.impl.RaftServerMetrics
 
RetryCache - Class in org.apache.ratis.server.impl
 
RetryCache.CacheEntry - Class in org.apache.ratis.server.impl
CacheEntry is tracked using unique client ID and callId of the RPC request
run() - Method in interface org.apache.ratis.statemachine.impl.BaseStateMachine.Task
 
runAppenderImpl() - Method in class org.apache.ratis.server.impl.LogAppender
Check and send appendEntries RPC

S

SEGMENT_CACHE_NUM_MAX_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
SEGMENT_CACHE_NUM_MAX_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
Besides the open segment, the max number of segments caching log entries.
SEGMENT_SIZE_MAX_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
SEGMENT_SIZE_MAX_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
segmentCacheNumMax(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
SegmentedRaftLog - Class in org.apache.ratis.server.raftlog.segmented
The RaftLog implementation that writes log entries into segmented files in local disk.
SegmentedRaftLog(RaftGroupMemberId, RaftServerImpl, RaftStorage, long, RaftProperties) - Constructor for class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
SegmentedRaftLogCache - Class in org.apache.ratis.server.raftlog.segmented
In-memory RaftLog Cache.
SegmentedRaftLogFormat - Interface in org.apache.ratis.server.raftlog.segmented
 
SegmentedRaftLogFormat.Internal - Class in org.apache.ratis.server.raftlog.segmented
 
SegmentedRaftLogInputStream - Class in org.apache.ratis.server.raftlog.segmented
 
SegmentedRaftLogInputStream(File, long, long, boolean) - Constructor for class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogInputStream
 
SegmentedRaftLogOutputStream - Class in org.apache.ratis.server.raftlog.segmented
 
SegmentedRaftLogOutputStream(File, boolean, long, long, ByteBuffer) - Constructor for class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogOutputStream
 
segmentSizeMax(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
ServerFactory - Interface in org.apache.ratis.server.impl
A factory interface for creating server components.
ServerFactory.BaseFactory - Class in org.apache.ratis.server.impl
 
ServerImplUtils - Class in org.apache.ratis.server.impl
Server utilities for internal use.
ServerProtoUtils - Interface in org.apache.ratis.server.impl
Server proto utilities for internal use.
ServerState - Class in org.apache.ratis.server.impl
Common states of a raft peer.
set(long, String) - Method in class org.apache.ratis.server.storage.MetaFile
 
setAutoTriggerEnabled(RaftProperties, boolean) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
setAutoTriggerThreshold(RaftProperties, long) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
setBufferByteLimit(RaftProperties, SizeInBytes) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
setBufferElementLimit(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
setByteLimit(RaftProperties, SizeInBytes) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
setCachingEnabled(RaftProperties, boolean) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
setClientRequest(RaftClientRequest) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setConf(PeerConfiguration) - Method in class org.apache.ratis.server.impl.RaftConfiguration.Builder
 
setConf(Iterable<RaftPeer>) - Method in class org.apache.ratis.server.impl.RaftConfiguration.Builder
 
setConfiguration(SetConfigurationRequest) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
setConfiguration(SetConfigurationRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
setConfigurationAsync(SetConfigurationRequest) - Method in class org.apache.ratis.server.impl.RaftServerImpl
Handle a raft configuration change request from client.
setConfigurationAsync(SetConfigurationRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
Handle a raft configuration change request from client.
setCorruptionPolicy(RaftProperties, RaftServerConfigKeys.Log.CorruptionPolicy) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setElementLimit(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
setElementLimit(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Write
 
setException(Exception) - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
setException(Exception) - Method in interface org.apache.ratis.statemachine.TransactionContext
Set exception in case of failure.
setExpiryTime(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.RetryCache
 
setForceSyncNum(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setGroup(RaftGroup) - Method in class org.apache.ratis.server.RaftServer.Builder
Set all the peers (including the server being built) in the Raft cluster.
setInstallSnapshotEnabled(RaftProperties, boolean) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
setLastAppliedTermIndex(TermIndex) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
setLogData(ByteString) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setLogEntry(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setLogEntryIndex(long) - Method in class org.apache.ratis.server.impl.RaftConfiguration.Builder
 
setNoLeaderTimeout(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Notification
 
setOldConf(PeerConfiguration) - Method in class org.apache.ratis.server.impl.RaftConfiguration.Builder
 
setOldConf(Iterable<RaftPeer>) - Method in class org.apache.ratis.server.impl.RaftConfiguration.Builder
 
setParameters(Parameters) - Method in class org.apache.ratis.server.RaftServer.Builder
setPreallocatedSize(RaftProperties, SizeInBytes) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setProperties(RaftProperties) - Method in class org.apache.ratis.server.RaftServer.Builder
setPurgeGap(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setPurgeUptoSnapshotIndex(RaftProperties, boolean) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setQueueByteLimit(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setQueueElementLimit(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setRequestTimeout(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
setRetentionFileNum(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Snapshot
 
setSegmentCacheNumMax(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setSegmentSizeMax(RaftProperties, SizeInBytes) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setServer(RaftServer) - Method in class org.apache.ratis.server.RaftServerRpc.Builder
 
setServerId(RaftPeerId) - Method in class org.apache.ratis.server.RaftServer.Builder
Set the server ID.
setServerRole(RaftProtos.RaftPeerRole) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setShouldCommit(boolean) - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
setShouldCommit(boolean) - Method in interface org.apache.ratis.statemachine.TransactionContext
Sets whether to commit the transaction to the RAFT log or not
setSleepDeviationThreshold(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
setSleepTime(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
setSlownessTimeout(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
setSnapshotChunkSizeMax(RaftProperties, SizeInBytes) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
setSnapshotIndex(long) - Method in class org.apache.ratis.server.impl.FollowerInfo
 
setStagingCatchupGap(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
setStateMachine(StateMachine) - Method in class org.apache.ratis.server.RaftServer.Builder
Set the StateMachine of the server.
setStateMachine(StateMachine) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setStateMachineContext(Object) - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
setStateMachineContext(Object) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setStateMachineContext(Object) - Method in interface org.apache.ratis.statemachine.TransactionContext
Sets the StateMachine the TransactionContext is specific to, the method would not create a new transaction context, it updates the StateMachine it associates with
setStateMachineData(ByteString) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setStateMachineLogEntry(RaftProtos.StateMachineLogEntryProto) - Method in class org.apache.ratis.statemachine.TransactionContext.Builder
 
setStateMachineLogEntryProto(RaftProtos.StateMachineLogEntryProto) - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
setStateMachineLogEntryProto(RaftProtos.StateMachineLogEntryProto) - Method in interface org.apache.ratis.statemachine.TransactionContext
Sets the data from the StateMachine
setStateMachineRegistry(StateMachine.Registry) - Method in class org.apache.ratis.server.RaftServer.Builder
Set the StateMachine.Registry of the server.
setStorageDir(RaftProperties, List<File>) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
setSync(RaftProperties, boolean) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
setSyncTimeout(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
setSyncTimeoutRetry(RaftProperties, int) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
setTimeout(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
setTimeoutDenomination(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
setTimeoutMax(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
setTimeoutMin(RaftProperties, TimeDuration) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
setUnconditionally(long, Consumer<Object>) - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
setUseMemory(RaftProperties, boolean) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
setWriteBufferSize(RaftProperties, SizeInBytes) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
shouldCommit() - Method in class org.apache.ratis.statemachine.impl.TransactionContextImpl
 
shouldCommit() - Method in interface org.apache.ratis.statemachine.TransactionContext
It indicates if the transaction should be committed to the RAFT log
shouldHeartbeat() - Method in class org.apache.ratis.server.impl.LogAppender
 
shouldInstallSnapshot() - Method in class org.apache.ratis.server.impl.LogAppender
 
shouldReadStateMachineData(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
shouldSendRequest() - Method in class org.apache.ratis.server.impl.LogAppender
Should the leader send appendEntries RPC to this follower?
shutdown(boolean) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
SimpleStateMachineStorage - Class in org.apache.ratis.statemachine.impl
A StateMachineStorage that stores the snapshot in a single file.
SimpleStateMachineStorage() - Constructor for class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
 
SingleFileSnapshotInfo - Class in org.apache.ratis.statemachine.impl
Each snapshot only has a single file.
SingleFileSnapshotInfo(FileInfo, long, long) - Constructor for class org.apache.ratis.statemachine.impl.SingleFileSnapshotInfo
 
size() - Method in class org.apache.ratis.server.impl.RetryCache
 
SLEEP_DEVIATION_THRESHOLD_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
SLEEP_DEVIATION_THRESHOLD_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
SLEEP_TIME_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
SLEEP_TIME_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
sleepDeviationThreshold(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
sleepTime(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
SLOWNESS_TIMEOUT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
SLOWNESS_TIMEOUT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
slownessTimeout(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
SNAPSHOT_CHUNK_SIZE_MAX_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
SNAPSHOT_CHUNK_SIZE_MAX_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
SNAPSHOT_REGEX - Static variable in class org.apache.ratis.statemachine.impl.SimpleStateMachineStorage
snapshot.term_index
snapshotChunkSizeMax(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.Appender
 
SnapshotInfo - Interface in org.apache.ratis.statemachine
SnapshotInfo represents a durable state by the state machine.
SnapshotManager - Class in org.apache.ratis.server.storage
Manage snapshots of a raft peer.
SnapshotManager(RaftStorage, RaftPeerId) - Constructor for class org.apache.ratis.server.storage.SnapshotManager
 
SnapshotRequestIter(SnapshotInfo, String) - Constructor for class org.apache.ratis.server.impl.LogAppender.SnapshotRequestIter
 
SnapshotRetentionPolicy - Interface in org.apache.ratis.statemachine.impl
Policy for retention of Ratis snapshot files.
STAGING_CATCHUP_GAP_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
STAGING_CATCHUP_GAP_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
When bootstrapping a new peer, If the gap between the match index of the peer and the leader's latest committed index is less than this gap, we treat the peer as caught-up.
stagingCatchupGap(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
start() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
start() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
start() - Method in interface org.apache.ratis.server.RaftServer
Start this server.
start() - Method in interface org.apache.ratis.server.RaftServerRpc
Start the RPC service.
startImpl() - Method in class org.apache.ratis.server.impl.RaftServerRpcWithProxy
 
startTransaction(RaftClientRequest) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
startTransaction(RaftClientRequest) - Method in interface org.apache.ratis.statemachine.StateMachine
Validate/pre-process the incoming update request in the state machine.
STATE_MACHINE_LOG_ENTRY_COUNT - Static variable in class org.apache.ratis.server.metrics.RaftLogMetrics
 
StateMachine - Interface in org.apache.ratis.statemachine
StateMachine is the entry point for the custom implementation of replicated state as defined in the "State Machine Approach" in the literature (see https://en.wikipedia.org/wiki/State_machine_replication).
StateMachine.DataApi - Interface in org.apache.ratis.statemachine
 
StateMachine.DataStream - Interface in org.apache.ratis.statemachine
For streaming state machine data.
StateMachine.Registry - Interface in org.apache.ratis.statemachine
A registry to support different state machines in multi-raft environment.
STATEMACHINE_APPLIED_INDEX_GAUGE - Static variable in class org.apache.ratis.server.impl.StateMachineMetrics
 
STATEMACHINE_APPLY_COMPLETED_GAUGE - Static variable in class org.apache.ratis.server.impl.StateMachineMetrics
 
STATEMACHINE_TAKE_SNAPSHOT_TIMER - Static variable in class org.apache.ratis.server.impl.StateMachineMetrics
 
StateMachineMetrics - Class in org.apache.ratis.server.impl
Metrics Registry for the State Machine Updater.
StateMachineStorage - Interface in org.apache.ratis.statemachine
 
stats() - Method in class org.apache.ratis.server.impl.RetryCache
 
stopAppender() - Method in class org.apache.ratis.server.impl.LogAppender
 
STORAGE_DIR_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
STORAGE_DIR_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys
 
storageDir(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys
 
stream(RaftClientRequest) - Method in interface org.apache.ratis.statemachine.StateMachine.DataApi
Create asynchronously a StateMachine.DataStream to stream state machine data.
submitClientRequest(RaftClientRequest) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
submitClientRequest(RaftClientRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
submitClientRequestAsync(RaftClientRequest) - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
submitClientRequestAsync(RaftClientRequest) - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
submitEventOnSuccessAppend() - Method in class org.apache.ratis.server.impl.LogAppender
 
submitUpdateCommitEvent() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
sync(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
SYNC_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
SYNC_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
SYNC_TIMEOUT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
SYNC_TIMEOUT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
SYNC_TIMEOUT_RETRY_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
SYNC_TIMEOUT_RETRY_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
-1: retry indefinitely 0: no retry >0: the number of retries
syncTimeout(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
syncTimeoutRetry(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData
 
syncWithSnapshot(long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
syncWithSnapshot(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
syncWithSnapshot(long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 

T

takeSnapshot() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
takeSnapshot() - Method in interface org.apache.ratis.statemachine.StateMachine
Dump the in-memory state into a snapshot file in the RaftStorage.
TermIndex - Interface in org.apache.ratis.server.protocol
The term and the log index defined in the Raft consensus algorithm.
timeout(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
TIMEOUT_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
TIMEOUT_DENOMINATION_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
TIMEOUT_DENOMINATION_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
TIMEOUT_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
Timeout for watch requests.
TIMEOUT_MAX_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
TIMEOUT_MAX_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
TIMEOUT_MIN_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
TIMEOUT_MIN_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
timeoutDenomination(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Watch
 
timeoutMax(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
timeoutMin(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Rpc
 
toAppendEntriesReplyProto(RaftPeerId, RaftGroupMemberId, long, long, long, RaftProtos.AppendEntriesReplyProto.AppendResult, long, long, boolean) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toAppendEntriesRequestProto(RaftGroupMemberId, RaftPeerId, long, List<RaftProtos.LogEntryProto>, long, boolean, TermIndex, Collection<RaftProtos.CommitInfoProto>, long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toInstallSnapshotReplyProto(RaftPeerId, RaftGroupMemberId, long, int, RaftProtos.InstallSnapshotResult) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toInstallSnapshotReplyProto(RaftPeerId, RaftGroupMemberId, long, RaftProtos.InstallSnapshotResult, long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toInstallSnapshotReplyProto(RaftPeerId, RaftGroupMemberId, RaftProtos.InstallSnapshotResult) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toInstallSnapshotRequestProto(RaftGroupMemberId, RaftPeerId, String, int, long, TermIndex, List<RaftProtos.FileChunkProto>, long, boolean) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toInstallSnapshotRequestProto(RaftGroupMemberId, RaftPeerId, long, TermIndex) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toLogEntryProto(RaftConfiguration, long, long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toLogEntryProto(RaftProtos.StateMachineLogEntryProto, long, long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toLogEntryProto(long, long, long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toLogEntryString(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toLogEntryString(RaftProtos.LogEntryProto, Function<RaftProtos.StateMachineLogEntryProto, String>) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toLogEntryString(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
toLogEntryString(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
toMetadataEntryBuilder(long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toRaftConfiguration(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toRaftConfigurationProto(RaftConfiguration) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toRaftRpcReplyProtoBuilder(RaftPeerId, RaftGroupMemberId, boolean) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toRaftRpcRequestProtoBuilder(RaftGroupMemberId, RaftPeerId) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toRequestVoteReplyProto(RaftPeerId, RaftGroupMemberId, boolean, long, boolean) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toRequestVoteRequestProto(RaftGroupMemberId, RaftPeerId, long, TermIndex) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toServerRpcProto(RaftPeer, long) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toShortString(List<RaftProtos.LogEntryProto>) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toStateMachineEntryProtoBuilder(ByteString) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toStateMachineEntryProtoBuilder(int) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toStateMachineLogEntryProto(RaftClientRequest, ByteString, ByteString) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toStateMachineLogEntryProto(ClientId, long, ByteString, ByteString) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toStateMachineLogEntryString(RaftProtos.StateMachineLogEntryProto, Function<RaftProtos.StateMachineLogEntryProto, String>) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toStateMachineLogEntryString(RaftProtos.StateMachineLogEntryProto) - Method in interface org.apache.ratis.statemachine.StateMachine
Converts the proto object into a useful log string to add information about state machine data.
toString() - Method in class org.apache.ratis.server.impl.ConfigurationManager
 
toString() - Method in class org.apache.ratis.server.impl.FollowerInfo
 
toString() - Method in class org.apache.ratis.server.impl.LeaderState
 
toString() - Method in class org.apache.ratis.server.impl.LogAppender
 
toString() - Method in class org.apache.ratis.server.impl.PendingRequest
 
toString() - Method in class org.apache.ratis.server.impl.RaftConfiguration
 
toString() - Method in class org.apache.ratis.server.impl.RaftServerImpl
 
toString() - Method in class org.apache.ratis.server.impl.RaftServerProxy
 
toString() - Method in class org.apache.ratis.server.impl.RetryCache.CacheEntry
 
toString(RaftProtos.LogEntryProto...) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toString(RaftProtos.AppendEntriesRequestProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toString(RaftProtos.AppendEntriesReplyProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toString(RaftProtos.RequestVoteReplyProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toString(RaftProtos.InstallSnapshotRequestProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toString(RaftProtos.InstallSnapshotReplyProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toString() - Method in class org.apache.ratis.server.impl.ServerState
 
toString(long, long) - Static method in interface org.apache.ratis.server.protocol.TermIndex
 
toString() - Method in class org.apache.ratis.server.raftlog.RaftLog.EntryWithData
 
toString() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
toString() - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
toString() - Method in class org.apache.ratis.server.raftlog.segmented.LogSegment
 
toString() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
toString() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogInputStream
 
toString() - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogOutputStream
 
toString() - Method in class org.apache.ratis.server.storage.FileInfo
 
toString() - Method in class org.apache.ratis.server.storage.RaftStorage
 
toString() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory.LogPathAndIndex
 
toString() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
 
toString() - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
toString() - Method in class org.apache.ratis.statemachine.impl.FileListSnapshotInfo
 
toTermIndex(RaftProtos.TermIndexProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toTermIndex(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toTermIndexProto(TermIndex) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toTermIndexString(RaftProtos.LogEntryProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
toTermIndexString(RaftProtos.TermIndexProto) - Static method in interface org.apache.ratis.server.impl.ServerProtoUtils
 
TransactionContext - Interface in org.apache.ratis.statemachine
Context for a transaction.
TransactionContext.Builder - Class in org.apache.ratis.statemachine
 
TransactionContextImpl - Class in org.apache.ratis.statemachine.impl
Implementation of TransactionContext This is a private API.
TransactionContextImpl(StateMachine, RaftClientRequest, RaftProtos.StateMachineLogEntryProto, Object) - Constructor for class org.apache.ratis.statemachine.impl.TransactionContextImpl
Construct a TransactionContext from a client request.
TransactionContextImpl(RaftProtos.RaftPeerRole, StateMachine, RaftProtos.LogEntryProto) - Constructor for class org.apache.ratis.statemachine.impl.TransactionContextImpl
truncate(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
truncate(long) - Method in interface org.apache.ratis.statemachine.StateMachine.DataApi
Truncates asynchronously the state machine data to the given log index.
truncateImpl(long) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
truncateImpl(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
 
truncateImpl(long) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 

U

unlock() - Method in class org.apache.ratis.server.storage.RaftStorageDirectory
Unlock storage.
updateCommitIndex(long) - Method in class org.apache.ratis.server.impl.LogAppender
 
updateIncreasingly(long, Consumer<Object>) - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
updateLastAppliedTermIndex(long, long) - Method in class org.apache.ratis.statemachine.impl.BaseStateMachine
 
updateLastCommitted(long, long) - Method in class org.apache.ratis.server.raftlog.RaftLog
Update the last committed index.
updateLastRpcResponseTime() - Method in class org.apache.ratis.server.impl.FollowerInfo
Update lastRpcResponseTime to the current time.
updateLastRpcSendTime() - Method in class org.apache.ratis.server.impl.FollowerInfo
Update lastRpcSendTime to the current time.
updateMatchIndex(long) - Method in class org.apache.ratis.server.impl.FollowerInfo
 
updateNextIndex(long) - Method in class org.apache.ratis.server.impl.FollowerInfo
 
updateNextIndexToMax(long) - Method in class org.apache.ratis.server.impl.FollowerInfo
 
updateSnapshotIndex(long) - Method in class org.apache.ratis.server.raftlog.RaftLog
Update the last committed index and snapshotIndex with the last index in the snapshot.
updateToMax(long, Consumer<Object>) - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
updateUnconditionally(LongUnaryOperator, Consumer<Object>) - Method in class org.apache.ratis.server.raftlog.RaftLogIndex
 
USE_MEMORY_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
USE_MEMORY_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
useMemory(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 

V

validateLogEntry(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.RaftLog
Validate the term and index of entry w.r.t RaftLog
valueOf(String) - Static method in enum org.apache.ratis.server.impl.RaftServerConstants.StartupOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.ratis.server.protocol.RaftServerProtocol.Op
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.ratis.server.RaftServerConfigKeys.Log.CorruptionPolicy
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.ratis.server.impl.RaftServerConstants.StartupOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.ratis.server.protocol.RaftServerProtocol.Op
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.ratis.server.RaftServerConfigKeys.Log.CorruptionPolicy
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLogOutputStream
Write the given entry to this output stream.
write(RaftProtos.LogEntryProto) - Method in interface org.apache.ratis.statemachine.StateMachine.DataApi
Write asynchronously the state machine data in the given log entry to this state machine.
WRITE_BUFFER_SIZE_DEFAULT - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
WRITE_BUFFER_SIZE_KEY - Static variable in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
writeBufferSize(RaftProperties) - Static method in interface org.apache.ratis.server.RaftServerConfigKeys.Log
 
writeLock() - Method in class org.apache.ratis.server.raftlog.RaftLog
 
writeMetadata(long, RaftPeerId) - Method in class org.apache.ratis.server.raftlog.memory.MemoryRaftLog
 
writeMetadata(long, RaftPeerId) - Method in class org.apache.ratis.server.raftlog.RaftLog
Write and flush the metadata (votedFor and term) into the meta file.
writeMetadata(long, RaftPeerId) - Method in class org.apache.ratis.server.raftlog.segmented.SegmentedRaftLog
 
writeRaftConfiguration(RaftProtos.LogEntryProto) - Method in class org.apache.ratis.server.storage.RaftStorage
 
A B C D E F G H I L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2017–2020 The Apache Software Foundation. All rights reserved.