package eraftpb

Get desktop application:
View/edit binary Protocol Buffers messages

ConfChange is the data that attach on entry with EntryConfChange type

• ConfChangeType change_type = 1

• uint64 node_id = 2

  node will be add/remove

• bytes context = 3

Used in: ConfChange, raft_cmdpb.ChangePeerRequest, schedulerpb.ChangePeer

• AddNode = 0

• RemoveNode = 1

ConfState contains the current membership information of the raft group

Used in: SnapshotMetadata

• repeated uint64 nodes = 1

  all node id

The entry is a type of change that needs to be applied. It contains two data fields. While the fields are built into the model; their usage is determined by the entry_type. For normal entries, the data field should contain the data change that should be applied. The context field can be used for any contextual data that might be relevant to the application of the data. For configuration changes, the data will contain the ConfChange message and the context will provide anything needed to assist the configuration change. The context is for the user to set and use in this case.

Used in: Message

• EntryType entry_type = 1

• uint64 term = 2

• uint64 index = 3

• bytes data = 4

Used in: Entry

• EntryNormal = 0

• EntryConfChange = 1

HardState contains the state of a node need to be peristed, including the current term, commit index and the vote record

Used in: raft_serverpb.RaftLocalState

• uint64 term = 1

• uint64 vote = 2

• uint64 commit = 3

Used in: raft_serverpb.RaftMessage

• MessageType msg_type = 1

• uint64 to = 2

• uint64 from = 3

• uint64 term = 4

• uint64 log_term = 5

• uint64 index = 6

• repeated Entry entries = 7

• uint64 commit = 8

• optional Snapshot snapshot = 9

• bool reject = 10

Some MessageType defined here are local messages which not come from the network, but should also use the Step method to handle

Used in: Message

• MsgHup = 0

  'MessageType_MsgHup' is a local message used for election. If an election timeout happened, the node should pass 'MessageType_MsgHup' to its Step method and start a new election.

• MsgBeat = 1

  'MessageType_MsgBeat' is a local message that signals the leader to send a heartbeat of the 'MessageType_MsgHeartbeat' type to its followers.

• MsgPropose = 2

  'MessageType_MsgPropose' is a local message that proposes to append data to the leader's log entries.

• MsgAppend = 3

  'MessageType_MsgAppend' contains log entries to replicate.

• MsgAppendResponse = 4

  'MessageType_MsgAppendResponse' is response to log replication request('MessageType_MsgAppend').

• MsgRequestVote = 5

  'MessageType_MsgRequestVote' requests votes for election.

• MsgRequestVoteResponse = 6

  'MessageType_MsgRequestVoteResponse' contains responses from voting request.

• MsgSnapshot = 7

  'MessageType_MsgSnapshot' requests to install a snapshot message.

• MsgHeartbeat = 8

  'MessageType_MsgHeartbeat' sends heartbeat from leader to its followers.

• MsgHeartbeatResponse = 9

  'MessageType_MsgHeartbeatResponse' is a response to 'MessageType_MsgHeartbeat'.

• MsgTransferLeader = 11

  'MessageType_MsgTransferLeader' requests the leader to transfer its leadership.

• MsgTimeoutNow = 12

  'MessageType_MsgTimeoutNow' send from the leader to the leadership transfer target, to let the transfer target timeout immediately and start a new election.

Used in: Message

• bytes data = 1

• optional SnapshotMetadata metadata = 2

SnapshotMetadata contains the log index and term of the last log applied to this Snapshot, along with the membership information of the time the last log applied.

Used in: Snapshot

• optional ConfState conf_state = 1

• uint64 index = 2

• uint64 term = 3