Merge pull request #2988 from xiang90/raft-doc

raft: fix usage section of doc
release-2.1
Xiang Li 2015-06-15 10:39:40 -07:00
commit b69d52e5ac
1 changed files with 10 additions and 2 deletions

View File

@ -19,8 +19,16 @@ Usage
The primary object in raft is a Node. You either start a Node from scratch
using raft.StartNode or start a Node from some initial state using raft.RestartNode.
storage := raft.NewMemoryStorage()
n := raft.StartNode(0x01, []raft.Peer{{ID: 0x02}, {ID: 0x03}}, 3, 1, storage)
storage := raft.NewMemoryStorage()
c := &Config{
ID: 0x01,
ElectionTick: 10,
HeartbeatTick: 1,
Storage: storage,
MaxSizePerMsg: 4096,
MaxInflightMsgs: 256,
}
n := raft.StartNode(c, []raft.Peer{{ID: 0x02}, {ID: 0x03}})
Now that you are holding onto a Node you have a few responsibilities: