package sorock

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AddServer (AddServerRequest, google.protobuf.Empty)

  sorock.proto:117

  message AddServerRequest

  sorock.proto:94

  Request to add a Raft process with `server_id` to a shard.

  • uint32 shard_id = 1

  • string server_id = 2

• rpc GetSnapshot (GetSnapshotRequest, stream SnapshotChunk)

  sorock.proto:120

  message GetSnapshotRequest

  sorock.proto:62

  • uint32 shard_id = 1

  • uint64 index = 2

  message SnapshotChunk

  sorock.proto:67

  • bytes data = 1

• rpc ProcessKernRequest (KernRequest, google.protobuf.Empty)

  sorock.proto:115

  message KernRequest

  sorock.proto:36

  • uint32 shard_id = 1

  • bytes message = 2

• rpc Read (ReadRequest, Response)

  sorock.proto:114

  message ReadRequest

  sorock.proto:20

  Read-only request to the `RaftApp`. This type of request is processed in optimized path.

  • uint32 shard_id = 1

  • bytes message = 2

  • bool read_locally = 3

• rpc RemoveServer (RemoveServerRequest, google.protobuf.Empty)

  sorock.proto:118

  message RemoveServerRequest

  sorock.proto:100

  Request to remove a Raft process with `server_id` from a shard.

  • uint32 shard_id = 1

  • string server_id = 2

• rpc RequestVote (VoteRequest, VoteResponse)

  sorock.proto:116

  message VoteRequest

  sorock.proto:71

  • uint32 shard_id = 1

  • uint64 vote_term = 2

  • string candidate_id = 3

  • optional Clock candidate_clock = 4

  • bool force_vote = 5

  • bool pre_vote = 6

  message VoteResponse

  sorock.proto:80

  • bool vote_granted = 1

• rpc SendHeartbeat (Heartbeat, google.protobuf.Empty)

  sorock.proto:121

  message Heartbeat

  sorock.proto:88

  • string leader_id = 1

  • map<uint32, LeaderCommitState> leader_commit_states = 2

• rpc SendReplicationStream (stream ReplicationStreamChunk, ReplicationStreamResponse)

  sorock.proto:119

  message ReplicationStreamChunk

  sorock.proto:50

  • oneof elem

    • ReplicationStreamHeader header = 1

    • ReplicationStreamEntry entry = 2

  message ReplicationStreamResponse

  sorock.proto:57

  • uint64 n_inserted = 1

  • uint64 log_last_index = 2

• rpc SendTimeoutNow (TimeoutNow, google.protobuf.Empty)

  sorock.proto:122

  message TimeoutNow

  sorock.proto:108

  On receiving this request, a server starts a new election to become a leader disregarding the election timeout. You can use this request to rebalance the leaders in the cluster.

  • uint32 shard_id = 1

• rpc Write (WriteRequest, Response)

  sorock.proto:113

  message WriteRequest

  sorock.proto:12

  Update request to the `RaftApp`. This type of request is serialized in the log and processed sequentially. `request_id` is unique identifier of the request to avoid executing duplicating requests. Client may send a write requests twice but they are executed only once as long as they have the same `request_id`.

  • uint32 shard_id = 1

  • bytes message = 2

  • string request_id = 3

Used in: ReplicationStreamEntry, ReplicationStreamHeader, VoteRequest

• uint64 term = 1

• uint64 index = 2

Used in: Heartbeat

• uint64 leader_term = 1

• uint64 leader_commit_index = 2

Used in: ReplicationStreamChunk

• optional Clock clock = 1

• bytes command = 2

Used in: ReplicationStreamChunk

• uint32 shard_id = 1

• string sender_id = 2

• optional Clock prev_clock = 3

Response from the `RaftApp`.

Used as response type in: Raft.Read, Raft.Write

• bytes message = 1