package ratis.common

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: RaftClientReplyProto

• string exceptionClassName = 1

• string errorMsg = 2

• bytes stacktrace = 3

Used as response type in: grpc.RaftServerProtocolService.appendEntries

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto serverReply = 1

• uint64 term = 2

• uint64 nextIndex = 3

• AppendEntriesReplyProto.AppendResult result = 4

• uint64 followerCommit = 5

• uint64 matchIndex = 6

• bool isHearbeat = 7

Used in: AppendEntriesReplyProto

• SUCCESS = 0

• NOT_LEADER = 1

  the requester's term is not large enough

• INCONSISTENCY = 2

  gap between the local log and the entries or snapshot installation in progress or

Used as request type in: grpc.RaftServerProtocolService.appendEntries

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto serverRequest = 1

• uint64 leaderTerm = 2

• optional TermIndexProto previousLog = 3

• repeated LogEntryProto entries = 4

• uint64 leaderCommit = 5

• bool initializing = 6

• repeated CommitInfoProto commitInfos = 15

Used in: RoleInfoProto

• uint64 lastLeaderElapsedTimeMs = 1

Used in: RaftClientReplyProto, RaftClientRequestProto

• bytes content = 1

Used in: AppendEntriesRequestProto, DataStreamReplyHeaderProto, GroupInfoReplyProto, RaftClientReplyProto

• optional RaftPeerProto server = 1

• uint64 commitIndex = 2

Used in: DataStreamReplyHeaderProto, DataStreamRequestHeaderProto

• bytes clientId = 1

• DataStreamPacketHeaderProto.Type type = 2

• uint64 streamId = 3

• uint64 streamOffset = 4

• uint64 dataLength = 5

• repeated DataStreamPacketHeaderProto.Option options = 6

Used in: DataStreamPacketHeaderProto

• SYNC = 0

• CLOSE = 1

Used in: DataStreamPacketHeaderProto

• STREAM_HEADER = 0

• STREAM_DATA = 1

• optional DataStreamPacketHeaderProto packetHeader = 1

• uint64 bytesWritten = 2

• bool success = 3

• repeated CommitInfoProto commitInfos = 15

• optional DataStreamPacketHeaderProto packetHeader = 1

Used in: RaftClientRequestProto

(message has no fields)

Used in: InstallSnapshotRequestProto.SnapshotChunkProto

• string filename = 1

  relative to root

• uint64 totalSize = 2

• bytes fileDigest = 3

• uint32 chunkIndex = 4

• uint64 offset = 5

• bytes data = 6

• bool done = 7

Used in: RoleInfoProto

• optional ServerRpcProto leaderInfo = 1

• uint32 outstandingOp = 2

Used in: RaftClientRequestProto

(message has no fields)

A request to add a new group

Used in: GroupManagementRequestProto

• optional RaftGroupProto group = 1

  the group to be added.

• bool format = 2

  Should it format the storage?

Used as response type in: grpc.AdminProtocolService.groupInfo

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto rpcReply = 1

• optional RaftGroupProto group = 2

• optional RoleInfoProto role = 3

• bool isRaftStorageHealthy = 4

• repeated CommitInfoProto commitInfos = 5

• optional RaftConfigurationProto conf = 6

• optional LogInfoProto logInfo = 7

Used as request type in: grpc.AdminProtocolService.groupInfo

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• optional RaftGroupIdProto groupId = 2

Used as response type in: grpc.AdminProtocolService.groupList

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto rpcReply = 1

• repeated RaftGroupIdProto groupId = 2

server info requests

Used as request type in: grpc.AdminProtocolService.groupList

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

Used as request type in: grpc.AdminProtocolService.groupManagement

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• oneof Op

  • GroupAddRequestProto groupAdd = 2

  • GroupRemoveRequestProto groupRemove = 3

Used in: GroupManagementRequestProto

• optional RaftGroupIdProto groupId = 1

  the group to be removed.

• bool deleteDirectory = 2

  delete the directory for that group?

• bool renameDirectory = 3

  rename the directory if not deleted.

Used as response type in: grpc.RaftServerProtocolService.installSnapshot

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto serverReply = 1

• uint64 term = 2

• InstallSnapshotResult result = 3

• oneof InstallSnapshotReplyBody

  • uint32 requestIndex = 4

    index of the snapshot chunk request.

  • uint64 snapshotIndex = 5

    index of snapshot installed after notification.

Used as request type in: grpc.RaftServerProtocolService.installSnapshot

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto serverRequest = 1

• uint64 leaderTerm = 2

• oneof InstallSnapshotRequestBody

  • InstallSnapshotRequestProto.SnapshotChunkProto snapshotChunk = 3

  • InstallSnapshotRequestProto.NotificationProto notification = 4

• optional LogEntryProto lastRaftConfigurationLogEntryProto = 5

Used in: InstallSnapshotRequestProto

• optional TermIndexProto firstAvailableTermIndex = 1

  first available log index to notify Follower to install snapshot.

Used in: InstallSnapshotRequestProto

• string requestId = 1

  an identifier for chunked-requests.

• uint32 requestIndex = 2

  the index for this request chunk. Starts from 0.

• optional RaftConfigurationProto raftConfiguration = 3

• optional TermIndexProto termIndex = 4

• repeated FileChunkProto fileChunks = 5

• uint64 totalSize = 6

• bool done = 7

  whether this is the final chunk for the same req.

Used in: InstallSnapshotReplyProto

• SUCCESS = 0

• NOT_LEADER = 1

• IN_PROGRESS = 2

• ALREADY_INSTALLED = 3

• CONF_MISMATCH = 4

• SNAPSHOT_INSTALLED = 5

• SNAPSHOT_UNAVAILABLE = 6

• SNAPSHOT_EXPIRED = 7

leader election request

Used as request type in: grpc.AdminProtocolService.leaderElectionManagement

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• oneof Op

  • LeaderElectionPauseRequestProto pause = 2

  • LeaderElectionResumeRequestProto resume = 3

Used in: LeaderElectionManagementRequestProto

(message has no fields)

Used in: LeaderElectionManagementRequestProto

(message has no fields)

Used in: RoleInfoProto

• repeated ServerRpcProto followerInfo = 1

• uint64 term = 2

Used in: RaftClientReplyProto

• optional RaftGroupMemberIdProto serverId = 1

  id of the leader

Used in: AppendEntriesRequestProto, InstallSnapshotRequestProto

• uint64 term = 1

• uint64 index = 2

• oneof LogEntryBody

  • StateMachineLogEntryProto stateMachineLogEntry = 3

  • RaftConfigurationProto configurationEntry = 4

  • MetadataProto metadataEntry = 5

* Add new LogInfoProto for RATIS-2030, allow GroupInfoCommand to show each server's last committed log, last applied log, last snapshot log, last entry log.

Used in: GroupInfoReplyProto

• optional TermIndexProto lastSnapshot = 1

• optional TermIndexProto applied = 2

• optional TermIndexProto committed = 3

• optional TermIndexProto lastEntry = 4

Used in: RaftClientRequestProto

• uint64 streamId = 1

  the id of this stream

• uint64 messageId = 2

  the message id within a particular stream.

• bool endOfRequest = 3

  Is this the end-of-request?

Used in: LogEntryProto

• uint64 commitIndex = 1

Used in: RaftClientReplyProto

• optional RaftPeerProto suggestedLeader = 1

• repeated RaftPeerProto peersInConf = 2

Used in: RaftClientReplyProto

• uint64 callId = 1

• ReplicationLevel replication = 2

• uint64 logIndex = 3

Used as response type in: grpc.AdminProtocolService.groupManagement, grpc.AdminProtocolService.leaderElectionManagement, grpc.AdminProtocolService.setConfiguration, grpc.AdminProtocolService.snapshotManagement, grpc.AdminProtocolService.transferLeadership, grpc.RaftClientProtocolService.ordered, grpc.RaftClientProtocolService.unordered

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto rpcReply = 1

• optional ClientMessageEntryProto message = 2

• oneof ExceptionDetails

  • NotLeaderExceptionProto notLeaderException = 3

  • NotReplicatedExceptionProto notReplicatedException = 4

  • StateMachineExceptionProto stateMachineException = 5

  • LeaderNotReadyExceptionProto leaderNotReadyException = 6

  • AlreadyClosedExceptionProto alreadyClosedException = 7

  • ThrowableProto dataStreamException = 8

  • ThrowableProto leaderSteppingDownException = 9

  • ThrowableProto transferLeadershipException = 10

  • ThrowableProto readException = 11

  • ThrowableProto readIndexException = 12

• uint64 logIndex = 14

  When the request is a write request and the reply is success, the log index of the transaction

• repeated CommitInfoProto commitInfos = 15

normal client request

Used as request type in: grpc.RaftClientProtocolService.ordered, grpc.RaftClientProtocolService.unordered

Used as field type in: ReadIndexRequestProto, netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• optional ClientMessageEntryProto message = 2

• oneof Type

  • WriteRequestTypeProto write = 3

  • ReadRequestTypeProto read = 4

  • StaleReadRequestTypeProto staleRead = 5

  • WatchRequestTypeProto watch = 6

  • MessageStreamRequestTypeProto messageStream = 7

  • DataStreamRequestTypeProto dataStream = 8

  • ForwardRequestTypeProto forward = 9

Used in: GroupInfoReplyProto, InstallSnapshotRequestProto.SnapshotChunkProto, LogEntryProto

• repeated RaftPeerProto peers = 1

  the peers in the current or new conf

• repeated RaftPeerProto oldPeers = 2

  the peers in the old conf

• repeated RaftPeerProto listeners = 3

• repeated RaftPeerProto oldListeners = 4

Used in: GroupInfoRequestProto, GroupListReplyProto, GroupRemoveRequestProto, RaftGroupMemberIdProto, RaftGroupProto, RaftRpcReplyProto, RaftRpcRequestProto

• bytes id = 1

Used in: LeaderNotReadyExceptionProto

• bytes peerId = 1

• optional RaftGroupIdProto groupId = 2

Used in: GroupAddRequestProto, GroupInfoReplyProto

• optional RaftGroupIdProto groupId = 1

• repeated RaftPeerProto peers = 2

Used in: RouteProto

• bytes id = 1

  id of the peer

Used in: CommitInfoProto, NotLeaderExceptionProto, RaftConfigurationProto, RaftGroupProto, RoleInfoProto, ServerRpcProto, SetConfigurationRequestProto, TransferLeadershipRequestProto

• bytes id = 1

  id of the peer

• string address = 2

  e.g. address of the RPC server

• uint32 priority = 3

  priority of the peer

• string dataStreamAddress = 4

  address of the data stream server

• string clientAddress = 5

  address of the client RPC server

• string adminAddress = 6

  address of the admin RPC server

• optional RaftPeerRole startupRole = 7

  peer start up role

* Role of raft peer

Used in: RaftPeerProto, RoleInfoProto

• LEADER = 0

• CANDIDATE = 1

• FOLLOWER = 2

• LISTENER = 3

Used in: AppendEntriesReplyProto, GroupInfoReplyProto, GroupListReplyProto, InstallSnapshotReplyProto, RaftClientReplyProto, ReadIndexReplyProto, RequestVoteReplyProto, StartLeaderElectionReplyProto, netty.RaftNettyExceptionReplyProto

• bytes requestorId = 1

• bytes replyId = 2

• optional RaftGroupIdProto raftGroupId = 3

• uint64 callId = 4

• bool success = 15

Used in: AppendEntriesRequestProto, GroupInfoRequestProto, GroupListRequestProto, GroupManagementRequestProto, InstallSnapshotRequestProto, LeaderElectionManagementRequestProto, RaftClientRequestProto, ReadIndexRequestProto, RequestVoteRequestProto, SetConfigurationRequestProto, SnapshotManagementRequestProto, StartLeaderElectionRequestProto, TransferLeadershipRequestProto

• bytes requestorId = 1

• bytes replyId = 2

• optional RaftGroupIdProto raftGroupId = 3

• uint64 callId = 4

• bool toLeader = 5

• repeated uint64 repliedCallIds = 12

  The call ids of the replied requests

• uint64 timeoutMs = 13

• optional RoutingTableProto routingTable = 14

• optional SlidingWindowEntry slidingWindowEntry = 15

Used as response type in: grpc.RaftServerProtocolService.readIndex

• optional RaftRpcReplyProto serverReply = 1

• uint64 readIndex = 2

Used as request type in: grpc.RaftServerProtocolService.readIndex

• optional RaftRpcRequestProto serverRequest = 1

• optional RaftClientRequestProto clientRequest = 2

  clientRequest is used to support read-after-write consistency

Used in: RaftClientRequestProto

• bool preferNonLinearizable = 1

• bool readAfterWriteConsistent = 2

Used in: NotReplicatedExceptionProto, WatchRequestTypeProto, WriteRequestTypeProto

• MAJORITY = 0

  * Committed at the leader and replicated to the majority of peers.

• ALL = 1

  * Committed at the leader and replicated to all peers. Note that ReplicationLevel.ALL implies ReplicationLevel.MAJORITY.

• MAJORITY_COMMITTED = 2

  * Committed at majority peers. Note that ReplicationLevel.MAJORITY_COMMITTED implies ReplicationLevel.MAJORITY.

• ALL_COMMITTED = 3

  * Committed at all peers. Note that ReplicationLevel.ALL_COMMITTED implies ReplicationLevel.ALL and ReplicationLevel.MAJORITY_COMMITTED

Used as response type in: grpc.RaftServerProtocolService.requestVote

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto serverReply = 1

• uint64 term = 2

• bool shouldShutdown = 3

Used as request type in: grpc.RaftServerProtocolService.requestVote

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto serverRequest = 1

• uint64 candidateTerm = 2

• optional TermIndexProto candidateLastEntry = 3

• bool preVote = 4

Used in: GroupInfoReplyProto

• optional RaftPeerProto self = 1

• RaftPeerRole role = 2

• uint64 roleElapsedTimeMs = 3

• oneof PeerInfo

  • LeaderInfoProto leaderInfo = 4

  • FollowerInfoProto followerInfo = 5

  • CandidateInfoProto candidateInfo = 6

Used in: RoutingTableProto

• optional RaftPeerIdProto peerId = 1

• repeated RaftPeerIdProto successors = 2

Used in: RaftRpcRequestProto

• repeated RouteProto routes = 1

Used in: FollowerInfoProto, LeaderInfoProto

• optional RaftPeerProto id = 1

• uint64 lastRpcElapsedTimeMs = 2

setConfiguration request

Used as request type in: grpc.AdminProtocolService.setConfiguration

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• repeated RaftPeerProto peers = 2

• repeated RaftPeerProto listeners = 3

• optional SetConfigurationRequestProto.Mode mode = 4

• repeated RaftPeerProto currentPeers = 5

• repeated RaftPeerProto currentListeners = 6

Used in: SetConfigurationRequestProto

• SET_UNCONDITIONALLY = 0

• ADD = 1

• COMPARE_AND_SET = 2

Used in: RaftRpcRequestProto

• uint64 seqNum = 1

  0 for non-sliding-window requests; >= 1 for sliding-window requests

• bool isFirst = 2

  Is this the first request of the sliding window?

Used in: SnapshotManagementRequestProto

• uint64 creationGap = 1

snapshot request

Used as request type in: grpc.AdminProtocolService.snapshotManagement

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• oneof Op

  • SnapshotCreateRequestProto create = 2

Used in: RaftClientRequestProto

• uint64 minIndex = 1

Used as response type in: grpc.RaftServerProtocolService.startLeaderElection

Used as field type in: netty.RaftNettyServerReplyProto

• optional RaftRpcReplyProto serverReply = 1

Used as request type in: grpc.RaftServerProtocolService.startLeaderElection

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto serverRequest = 1

• optional TermIndexProto leaderLastEntry = 2

Used in: StateMachineLogEntryProto

• bytes stateMachineData = 1

  * StateMachine specific data which is not written to log. Unlike logEntryData, stateMachineData is managed and stored by the StateMachine but not the RaftLog.

• uint32 logEntryProtoSerializedSize = 2

  * When stateMachineData is missing, it is the size of the serialized LogEntryProto along with stateMachineData. When stateMachineData is not missing, it must be set to zero.

Used in: RaftClientReplyProto

• string exceptionClassName = 1

• string errorMsg = 2

• bytes stacktrace = 3

TODO: This is not super efficient if the SM itself uses PB to serialize its own data for a

Used in: LogEntryProto

• bytes logData = 1

  * RaftLog entry data

• optional StateMachineEntryProto stateMachineEntry = 2

  * StateMachine entry. StateMachine implementation may use this field to separate StateMachine specific data from the RaftLog data.

• StateMachineLogEntryProto.Type type = 13

• bytes clientId = 14

  clientId and callId are used to rebuild the retry cache.

• uint64 callId = 15

Used in: StateMachineLogEntryProto

• WRITE = 0

• DATASTREAM = 1

Used in: AppendEntriesRequestProto, InstallSnapshotRequestProto.NotificationProto, InstallSnapshotRequestProto.SnapshotChunkProto, LogInfoProto, RequestVoteRequestProto, StartLeaderElectionRequestProto

• uint64 term = 1

• uint64 index = 2

Used in: RaftClientReplyProto

• string className = 1

• string errorMessage = 2

• bytes stackTrace = 3

• bytes cause = 4

transfer leadership request

Used as request type in: grpc.AdminProtocolService.transferLeadership

Used as field type in: netty.RaftNettyServerRequestProto

• optional RaftRpcRequestProto rpcRequest = 1

• optional RaftPeerProto newLeader = 2

Used in: RaftClientRequestProto

• uint64 index = 1

• ReplicationLevel replication = 2

Used in: RaftClientRequestProto

• ReplicationLevel replication = 1