nim-raft/raft/protocol.nim

59 lines
2.4 KiB
Nim
Raw Normal View History

# nim-raft
# Copyright (c) 2023 Status Research & Development GmbH
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
# * MIT license ([LICENSE-MIT](LICENSE-MIT))
# at your option.
# This file may not be copied, modified, or distributed except according to
# those terms.
2023-09-04 09:47:27 +00:00
# **************************** #
2023-08-14 20:49:21 +00:00
# Raft Protocol definition #
2023-09-04 09:47:27 +00:00
# **************************** #
import types
type
2023-08-14 20:49:21 +00:00
RaftMessageRespoonseError* = enum # Raft message response errors
rmreSuccess = 0,
rmreFail = 1
2023-08-14 20:49:21 +00:00
RaftMessageRequestVote* = ref object of RaftMessageBase
lastLogTerm*: RaftNodeTerm
lastLogIndex*: RaftLogIndex
2023-09-01 02:55:55 +00:00
senderTerm*: RaftNodeTerm # Sender Raft Node Term
2023-08-14 20:49:21 +00:00
RaftMessageRequestVoteResponse* = ref object of RaftMessageResponseBase
granted*: bool # Is vote granted by the Raft node, from we requested vote?
2023-08-14 20:49:21 +00:00
RaftMessageAppendEntries*[SmCommandType] = ref object of RaftMessageBase
prevLogIndex*: RaftLogIndex
prevLogTerm*: RaftNodeTerm
commitIndex*: RaftLogIndex
logEntries*: Option[seq[RaftNodeLogEntry[SmCommandType]]] # Optional log entry(ies). Will be empty for a Heart-Beat
2023-09-01 02:55:55 +00:00
senderTerm*: RaftNodeTerm # Sender Raft Node Term
2023-08-14 20:49:21 +00:00
RaftMessageAppendEntriesResponse*[SmStateType] = ref object of RaftMessageResponseBase
success*: bool
lastLogIndex*: RaftLogIndex
state*: Option[SmStateType] # Optional Raft Abstract State Machine State
# Raft Node Client Request/Response definitions
2023-08-14 20:49:21 +00:00
RaftNodeClientRequestOps* = enum
rncroRequestSmState = 0,
rncroExecSmCommand = 1
2023-09-02 21:16:26 +00:00
RaftNodeClientResponseError* = enum
rncreSuccess = 0,
rncreFail = 1,
rncreNotLeader = 2
2023-08-14 20:49:21 +00:00
RaftNodeClientRequest*[SmCommandType] = ref object
op*: RaftNodeClientRequestOps
2023-08-31 20:52:52 +00:00
nodeId*: RaftNodeId
2023-08-14 20:49:21 +00:00
payload*: Option[SmCommandType] # Optional RaftMessagePayload carrying a Log Entry
RaftNodeClientResponse*[SmStateType] = ref object
2023-09-04 09:47:27 +00:00
nodeId*: RaftNodeId
2023-08-14 20:49:21 +00:00
error*: RaftNodeClientResponseError
state*: Option[SmStateType] # Optional Raft Abstract State Machine State
raftNodeRedirectId*: Option[RaftNodeId] # Optional Raft Node ID to redirect the request to in case of failure