Interface ApplicationStateMachine

Application state machine contract used by the Raft node.

Remarks

Implementations must be deterministic for replicated commands in order to keep state consistent across all nodes.

interface ApplicationStateMachine {
    apply(command: Command): Promise<any>;
    getState(): any;
    installSnapshot(data: Buffer): Promise<void>;
    takeSnapshot(): Promise<Buffer<ArrayBufferLike>>;
}

Index

Methods

apply getState installSnapshot takeSnapshot

Methods

apply

apply(command: Command): Promise<any>
Applies a replicated command to application state.
Parameters
- command: Command
Returns Promise<any>
- Defined in packages/raft-core/src/core/RaftNode.ts:47

getState

getState(): any
Returns an observable view of the current application state.

Returns any
- Defined in packages/raft-core/src/core/RaftNode.ts:49

installSnapshot

installSnapshot(data: Buffer): Promise<void>
Replaces current application state from snapshot bytes.
Parameters
- data: Buffer
Returns Promise<void>
- Defined in packages/raft-core/src/core/RaftNode.ts:53

takeSnapshot

takeSnapshot(): Promise<Buffer<ArrayBufferLike>>
Serializes current application state into snapshot bytes.

Returns Promise<Buffer<ArrayBufferLike>>
- Defined in packages/raft-core/src/core/RaftNode.ts:51

Interface ApplicationStateMachine

Remarks

Index

Methods

Methods

apply

Parameters

Returns Promise<any>

getState

Returns any

installSnapshot

Parameters

Returns Promise<void>

takeSnapshot

Returns Promise<Buffer<ArrayBufferLike>>

Settings

On This Page