raftkv

Documentation

Index

• Constants
• func DPrintf(format string, a ...interface{}) (n int, err error)
• type Clerk
  • func MakeClerk(servers []*labrpc.ClientEnd) *Clerk
  • func (ck *Clerk) Append(key string, value string)
  • func (ck *Clerk) Get(key string) string
  • func (ck *Clerk) Put(key string, value string)
  • func (ck *Clerk) PutAppend(key string, value string, op string)
• type Err
• type GetArgs
• type GetReply
• type Op
• type PutAppendArgs
• type PutAppendReply
• type RaftKV
  • func StartKVServer(servers []*labrpc.ClientEnd, me int, persister *raft.Persister, ...) *RaftKV
  • func (kv *RaftKV) Get(args *GetArgs, reply *GetReply)
  • func (kv *RaftKV) Kill()
  • func (kv *RaftKV) PutAppend(args *PutAppendArgs, reply *PutAppendReply)

Constants

const (
	OK       = "OK"
	ErrNoKey = "ErrNoKey"
	TimeOut  = "TimeOut"
	Error    = "Error"
)

const Debug = 0

Functions

func DPrintf

func DPrintf(format string, a ...interface{}) (n int, err error)

Types

type Clerk

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

func MakeClerk

func MakeClerk(servers []*labrpc.ClientEnd) *Clerk

func (*Clerk) Append

func (ck *Clerk) Append(key string, value string)

func (*Clerk) Get

func (ck *Clerk) Get(key string) string

fetch the current value for a key. returns "" if the key does not exist. keeps trying forever in the face of all other errors.

you can send an RPC with code like this: ok := ck.servers[i].Call("RaftKV.Get", &args, &reply)

the types of args and reply (including whether they are pointers) must match the declared types of the RPC handler function's arguments. and reply must be passed as a pointer.

func (*Clerk) Put

func (ck *Clerk) Put(key string, value string)

func (*Clerk) PutAppend

func (ck *Clerk) PutAppend(key string, value string, op string)

shared by Put and Append.

you can send an RPC with code like this: ok := ck.servers[i].Call("RaftKV.PutAppend", &args, &reply)

the types of args and reply (including whether they are pointers) must match the declared types of the RPC handler function's arguments. and reply must be passed as a pointer.

type Err

type Err string

type GetArgs

type GetArgs struct {
	Key string
	// You'll have to add definitions here.
	Cid int64
	Seq int64
}

type GetReply

type GetReply struct {
	WrongLeader bool
	Err         Err
	Value       string
}

type Op

type Op struct {
	Key    string
	Value  string
	Cid    int64
	Seq    int64
	Action string
}

type PutAppendArgs

type PutAppendArgs struct {
	// You'll have to add definitions here.
	Key   string
	Value string
	Op    string // "Put" or "Append"
	// You'll have to add definitions here.
	// Field names must start with capital letters,
	// otherwise RPC will break.
	Cid int64
	Seq int64
}

Put or Append

type PutAppendReply

type PutAppendReply struct {
	WrongLeader bool
	Err         Err
}

type RaftKV

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

func StartKVServer

func StartKVServer(servers []*labrpc.ClientEnd, me int, persister *raft.Persister, maxraftstate int) *RaftKV

servers[] contains the ports of the set of servers that will cooperate via Raft to form the fault-tolerant key/value service. me is the index of the current server in servers[]. the k/v server should store snapshots with persister.SaveSnapshot(), and Raft should save its state (including log) with persister.SaveRaftState(). the k/v server should snapshot when Raft's saved state exceeds maxraftstate bytes, in order to allow Raft to garbage-collect its log. if maxraftstate is -1, you don't need to snapshot. StartKVServer() must return quickly, so it should start goroutines for any long-running work.

func (*RaftKV) Get

func (kv *RaftKV) Get(args *GetArgs, reply *GetReply)

func (*RaftKV) Kill

func (kv *RaftKV) Kill()

the tester calls Kill() when a RaftKV instance won't be needed again. you are not required to do anything in Kill(), but it might be convenient to (for example) turn off debug output from this instance.

func (*RaftKV) PutAppend

func (kv *RaftKV) PutAppend(args *PutAppendArgs, reply *PutAppendReply)