package openraftpb

Get desktop application:
View/edit binary Protocol Buffers messages

ApiService provides the key-value store API operations and Raft cluster management operations

• rpc Get (GetRequest, Response)

  app.proto:54

  Get retrieves the value associated with a given key

  message GetRequest

  app_types.proto:12

  GetRequest represents a key lookup request

  • string key = 1

    Key to look up

• rpc Set (SetRequest, Response)

  app.proto:57

  Set stores a key-value pair in the distributed store

• rpc Init (InitRequest, google.protobuf.Empty)

  app.proto:60

  Init initializes a new Raft cluster with the given nodes

  message InitRequest

  app.proto:11

  InitRequest contains the initial set of nodes for cluster initialization

  • repeated Node nodes = 1

    List of initial cluster nodes

• rpc AddLearner (AddLearnerRequest, ClientWriteResponse)

  app.proto:63

  AddLearner adds a new learner node to the Raft cluster

  message AddLearnerRequest

  app.proto:17

  AddLearnerRequest specifies parameters for adding a learner node

  • optional Node node = 1

    Node to be added as a learner

• rpc ChangeMembership (ChangeMembershipRequest, ClientWriteResponse)

  app.proto:66

  ChangeMembership modifies the cluster membership configuration

  message ChangeMembershipRequest

  app.proto:23

  ChangeMembershipRequest specifies parameters for modifying cluster membership

  • repeated uint64 members = 1

    New set of voter node IDs

  • bool retain = 2

    Whether to retain existing configuration

• rpc Metrics (google.protobuf.Empty, MetricsResponse)

  app.proto:69

  Metrics retrieves cluster metrics and status information

  message MetricsResponse

  app.proto:41

  • optional Membership membership = 1

    Cluster membership config

  • string other_metrics = 2

    In this example, only membership is used. Other metrics are just encoded in string for simplicity. In real-world scenarios, metrics should be encoded in a more structured format.

InternalService handles internal Raft cluster communication

• rpc Vote (VoteRequest, VoteResponse)

  raft.proto:150

  Vote handles vote requests between Raft nodes during leader election

  message VoteRequest

  raft.proto:61

  VoteRequest represents a request for votes during leader election

  • optional Vote vote = 1

  • optional LogId last_log_id = 2

  message VoteResponse

  raft.proto:67

  VoteResponse represents the response to a vote request

  • optional Vote vote = 1

  • bool vote_granted = 2

  • optional LogId last_log_id = 3

• rpc AppendEntries (AppendEntriesRequest, AppendEntriesResponse)

  raft.proto:153

  AppendEntries handles call related to append entries RPC

  message AppendEntriesRequest

  raft.proto:73

  • optional Vote vote = 1

    The leader's vote, used to identify the leader, and must be committed

  • optional LogId prev_log_id = 2

    The previous log id the leader has sent to the follower

  • repeated Entry entries = 3

    The entries to be appended to the follower's log

  • optional LogId leader_commit = 4

    The leader's last committed log id

  message AppendEntriesResponse

  raft.proto:87

  • optional Vote rejected_by = 1

    If not None, the follower rejected the AppendEntries request due to having a higher vote. All other fields are valid only when this field is None

  • bool conflict = 2

    The follower accepts this AppendEntries request's vote, but the prev_log_id conflicts with the follower's log. The leader should retry with a smaller prev_log_id that matches the follower's log. All subsequent fields are valid only when this field is false

  • optional LogId last_log_id = 3

    The last log id the follower accepted from this request. If None, all input entries were accepted and persisted. Otherwise, only entries up to and including this id were accepted

• rpc Snapshot (stream SnapshotRequest, SnapshotResponse)

  raft.proto:156

  Snapshot handles install snapshot RPC

  message SnapshotRequest

  raft.proto:121

  The item of snapshot chunk stream. The first item contains `meta`, including the leader vote and snapshot-meta. Since the second item, the chunk contains the snapshot data.

  • oneof payload

    • SnapshotRequestMeta meta = 1

    • bytes chunk = 2

  message SnapshotResponse

  raft.proto:128

  • optional Vote vote = 1

Used as response type in: AppService.AddLearner, AppService.ChangeMembership

• optional LogId log_id = 1

  The log id of the committed log entry.

• optional Response data = 2

  If the committed log entry is a normal one.

• optional Membership membership = 3

  If the committed log entry is a change-membership entry.

Used in: AppendEntriesRequest

• uint64 term = 1

• uint64 index = 2

• optional SetRequest app_data = 12

  Optional Application data

• optional Membership membership = 13

  Optional Membership config

LeaderId represents the leader identifier in Raft

Used in: Vote

• uint64 term = 1

• uint64 node_id = 2

LogId represents the log identifier in Raft

Used in: AppendEntriesRequest, AppendEntriesResponse, ClientWriteResponse, SnapshotRequestMeta, StateMachineData, VoteRequest, VoteResponse

• uint64 term = 1

• uint64 index = 2

Membership config

Used in: ClientWriteResponse, Entry, MetricsResponse, SnapshotRequestMeta, StateMachineData

• repeated NodeIdSet configs = 1

  Joint(includes more than one NodeIdSet) or uniform(one NodeIdSet) config.

• map<uint64, Node> nodes = 2

  All of the nodes in the cluster, including voters and learners. A node id that is included in `configs` is a voter, otherwise it is a learner.

Node represents a single node in the Raft cluster

Used in: AddLearnerRequest, InitRequest, Membership

• uint64 node_id = 1

  Unique identifier for the node

• string rpc_addr = 2

  RPC address for node communication

NodeIds is a set of NodeIds

Used in: Membership

• map<uint64, google.protobuf.Empty> node_ids = 1

GetResponse contains the value associated with the requested key

Used as response type in: AppService.Get, AppService.Set

Used as field type in: ClientWriteResponse

• optional string value = 1

  Retrieved value

SetRequest represents a key-value pair to be stored

Used as request type in: AppService.Set

Used as field type in: Entry

• string key = 1

  Key to store

• string value = 2

  Value to associate with the key

The first chunk of snapshot transmission, which contains the snapshot meta.

Used in: SnapshotRequest

• optional Vote vote = 1

• optional LogId last_log_id = 2

• optional LogId last_membership_log_id = 3

• optional Membership last_membership = 4

• string snapshot_id = 5

All the data in a state machine, including user defined data and membership data.

• optional LogId last_applied = 1

  The last log id that has been applied to the state machine

• map<string, string> data = 2

  User data in a map

• optional LogId last_membership_log_id = 3

  The id of the last membership config log entry that is applied.

• optional Membership last_membership = 4

  The last membership config that is applied.

Vote represents the voting information in Raft leader election

Used in: AppendEntriesRequest, AppendEntriesResponse, SnapshotRequestMeta, SnapshotResponse, VoteRequest, VoteResponse

• optional LeaderId leader_id = 1

• bool committed = 2