Class RaftNode

Implements

RaftNodeInterface

Constructors

constructor

new RaftNode(options: RaftNodeOptions): RaftNode
Parameters
- options: RaftNodeOptions
Returns RaftNode
- Defined in packages/raft-core/src/core/RaftNode.ts:98

Methods

addServer

addServer(
    nodeId: string,
    address: string,
    asLearner?: boolean,
): Promise<boolean>
Parameters
- nodeId: string
- address: string
- asLearner: boolean = false
Returns Promise<boolean>
- Defined in packages/raft-core/src/core/RaftNode.ts:538

getApplicationState

getApplicationState(): any
Returns any
Implementation of RaftNodeInterface.getApplicationState
- Defined in packages/raft-core/src/core/RaftNode.ts:421

getCommittedIndex

getCommittedIndex(): number
Returns number
Implementation of RaftNodeInterface.getCommittedIndex
- Defined in packages/raft-core/src/core/RaftNode.ts:405

getCurrentTerm

getCurrentTerm(): number
Returns number
Implementation of RaftNodeInterface.getCurrentTerm
- Defined in packages/raft-core/src/core/RaftNode.ts:401

getEntries

getEntries(startIndex: number, endIndex: number): Promise<LogEntry[]>
Parameters
- startIndex: number
- endIndex: number
Returns Promise<LogEntry[]>
Implementation of RaftNodeInterface.getEntries
- Defined in packages/raft-core/src/core/RaftNode.ts:429

getLastApplied

getLastApplied(): number
Returns number
Implementation of RaftNodeInterface.getLastApplied
- Defined in packages/raft-core/src/core/RaftNode.ts:409

getLastLogIndex

getLastLogIndex(): number
Returns number
Implementation of RaftNodeInterface.getLastLogIndex
- Defined in packages/raft-core/src/core/RaftNode.ts:413

getLeaderId

getLeaderId(): string | null
Returns string | null
Implementation of RaftNodeInterface.getLeaderId
- Defined in packages/raft-core/src/core/RaftNode.ts:397

getNodeId

getNodeId(): string
Returns string
Implementation of RaftNodeInterface.getNodeId
- Defined in packages/raft-core/src/core/RaftNode.ts:417

getState

getState(): RaftState
Returns RaftState
Implementation of RaftNodeInterface.getState
- Defined in packages/raft-core/src/core/RaftNode.ts:389

isLeader

isLeader(): boolean
Returns boolean
Implementation of RaftNodeInterface.isLeader
- Defined in packages/raft-core/src/core/RaftNode.ts:393

isStarted

isStarted(): boolean
Returns boolean
Implementation of RaftNodeInterface.isStarted
- Defined in packages/raft-core/src/core/RaftNode.ts:425

promoteServer

promoteServer(nodeId: string): Promise<boolean>
Parameters
- nodeId: string
Returns Promise<boolean>
- Defined in packages/raft-core/src/core/RaftNode.ts:647

registerPeer

registerPeer(nodeId: string, address: string): Promise<void>
Parameters
- nodeId: string
- address: string
Returns Promise<void>
- Defined in packages/raft-core/src/core/RaftNode.ts:694

removePeer

removePeer(nodeId: string): Promise<void>
Parameters
- nodeId: string
Returns Promise<void>
- Defined in packages/raft-core/src/core/RaftNode.ts:698

removeServer

removeServer(nodeId: string): Promise<boolean>
Parameters
- nodeId: string
Returns Promise<boolean>
- Defined in packages/raft-core/src/core/RaftNode.ts:596

start

start(): Promise<void>
Returns Promise<void>
Implementation of RaftNodeInterface.start
- Defined in packages/raft-core/src/core/RaftNode.ts:186

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of RaftNodeInterface.stop
- Defined in packages/raft-core/src/core/RaftNode.ts:292

submitCommand

submitCommand(command: Command): Promise<CommandResult>
Parameters
- command: Command
Returns Promise<CommandResult>
Implementation of RaftNodeInterface.submitCommand
- Defined in packages/raft-core/src/core/RaftNode.ts:330