Interface RaftLog<T>

Abstract log persistence interface for the Raft consensus algorithm. Raft log indices are 1-based.

Type Parameters

T = unknown

Hierarchy

RaftLog

Implemented by

InMemoryRaftLog

Index

Methods

append getEntries getEntry getTerm lastIndex lastTerm length loadState saveState truncateFrom

Methods

append

append(entries): void
Append one or more entries to the end of the log
Parameters
- entries: LogEntry<T>[]
Returns void
- Defined in raft/log/RaftLog.ts:28

getEntries

getEntries(startIndex, endIndex): LogEntry<T>[]
Get all entries from startIndex to endIndex (both inclusive, 1-based)
Parameters
- startIndex: number
- endIndex: number
Returns LogEntry<T>[]
- Defined in raft/log/RaftLog.ts:37

getEntry

getEntry(index): LogEntry<T>
Get the entry at the given 1-based index, or undefined if out of range
Parameters
- index: number
Returns LogEntry<T>
- Defined in raft/log/RaftLog.ts:22

getTerm

getTerm(index): number
Get the term of the entry at the given 1-based index, or 0 if out of range
Parameters
- index: number
Returns number
- Defined in raft/log/RaftLog.ts:25

lastIndex

lastIndex(): number
Get the index of the last entry (0 if log is empty)

Returns number
- Defined in raft/log/RaftLog.ts:40

lastTerm

lastTerm(): number
Get the term of the last entry (0 if log is empty)

Returns number
- Defined in raft/log/RaftLog.ts:43

length

length(): number
Number of entries in the log

Returns number
- Defined in raft/log/RaftLog.ts:19

loadState

loadState(): RaftPersistentState
Load persistent state (currentTerm, votedFor). Returns defaults if not yet stored.

Returns RaftPersistentState
- Defined in raft/log/RaftLog.ts:11

saveState

saveState(state): void
Persist the current term and votedFor
Parameters
- state: RaftPersistentState
Returns void
- Defined in raft/log/RaftLog.ts:14

truncateFrom

truncateFrom(index): void
Delete all entries from the given 1-based index onward (inclusive). Used when resolving log conflicts.
Parameters
- index: number
Returns void
- Defined in raft/log/RaftLog.ts:34

Generated using TypeDoc