Interface ConfigStorage

Storage contract for committed cluster configuration.

interface ConfigStorage {
    close(): Promise<void>;
    isOpen(): boolean;
    open(): Promise<void>;
    read(): Promise<ConfigStorageData | null>;
    write(voters: ClusterMember[], learners: ClusterMember[]): Promise<void>;
}

Index

Methods

close isOpen open read write

Methods

close

close(): Promise<void>
Closes storage resources.

Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/ConfigStorage.ts:20

isOpen

isOpen(): boolean
Returns true when storage is open.

Returns boolean
- Defined in packages/raft-core/src/storage/interfaces/ConfigStorage.ts:22

open

open(): Promise<void>
Opens storage resources.

Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/ConfigStorage.ts:18

read

read(): Promise<ConfigStorageData | null>
Reads persisted committed configuration, or null when absent.

Returns Promise<ConfigStorageData | null>
- Defined in packages/raft-core/src/storage/interfaces/ConfigStorage.ts:25

write

write(voters: ClusterMember[], learners: ClusterMember[]): Promise<void>
Persists full committed membership set.
Parameters
- voters: ClusterMember[]
- learners: ClusterMember[]
Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/ConfigStorage.ts:28