raft

Documentation

Index

• Constants
• type AppendEntriesArgs
• type AppendEntriesReply
• type ApplyMsg
• type Log
• type Raft
  • func Make(peers []*labrpc.ClientEnd, me int, persister *Persister, applyCh chan ApplyMsg) *Raft
  • func (rf *Raft) AppendEntries(args AppendEntriesArgs, reply *AppendEntriesReply)
  • func (rf *Raft) GetState() (int, bool)
  • func (rf *Raft) Kill()
  • func (rf *Raft) RequestVote(args RequestVoteArgs, reply *RequestVoteReply)
  • func (rf *Raft) Start(command interface{}) (int, int, bool)
• type RequestVoteArgs
• type RequestVoteReply

Constants

const (
	Follower = iota
	Candidate
	Leader
)

Server Roles

Types

type AppendEntriesArgs

type AppendEntriesArgs struct {
	LeaderTerm         int
	LeaderID           int
	LeaderCommitIndex  int
	LeaderPrevLogIndex int
	LeaderPrevLogTerm  int
	LeaderCurEnrtyLog  []Log
}

AppendEntriesArgs args for Append Entries RPC

type AppendEntriesReply

type AppendEntriesReply struct {
	Term    int
	Success bool
	Len     int
}

AppendEntriesReply reply for Append Entries RPC

type ApplyMsg

type ApplyMsg struct {
	Index       int
	Command     interface{}
	UseSnapshot bool   // ignore for Assignment2; only used in Assignment3
	Snapshot    []byte // ignore for Assignment2; only used in Assignment3
}

ApplyMsg struct for Assignment 3

type Log

type Log struct {
	Term    int
	Command interface{}
}

Log struct for logs

type Raft

type Raft struct {
	// contains filtered or unexported fields
}

Raft struct for Raft Node

func Make

func Make(peers []*labrpc.ClientEnd, me int,
	persister *Persister, applyCh chan ApplyMsg) *Raft

Make for tester to make Raft Nodes

func (*Raft) AppendEntries

func (rf *Raft) AppendEntries(args AppendEntriesArgs, reply *AppendEntriesReply)

AppendEntries executes Append Entries RPC on Receiver

func (*Raft) GetState

func (rf *Raft) GetState() (int, bool)

GetState fetches state for tester

func (*Raft) Kill

func (rf *Raft) Kill()

Kill for removing debug log for dead nodes

func (*Raft) RequestVote

func (rf *Raft) RequestVote(args RequestVoteArgs, reply *RequestVoteReply)

RequestVote executes Request Vote RPC on Receiver

func (*Raft) Start

func (rf *Raft) Start(command interface{}) (int, int, bool)

Start for tester to append a command into the logs of the server If node is Leader, then send command to append channel for appending into the logs Otherwise don't append Also returns valid index, term, isLeader values

type RequestVoteArgs

type RequestVoteArgs struct {
	CandidateTerm         int
	CandidateID           int
	CandidateLastLogIndex int
	CandidateLastLogTerm  int
}

RequestVoteArgs args for Request Vote RPC

type RequestVoteReply

type RequestVoteReply struct {
	Term        int
	VoteGranted bool
}

RequestVoteReply reply for Request Vote RPC