ソースを参照

Merge pull request #1022 from philips/add-ready-docs

raft: add doc for the Ready struct
Xiang Li 11 年 前
コミット
e4d2b2a06a
1 ファイル変更2 行追加0 行削除
  1. 2 0
      raft/node.go

+ 2 - 0
raft/node.go

@@ -11,6 +11,8 @@ import (
 
 
 var ErrStopped = errors.New("raft: stopped")
 var ErrStopped = errors.New("raft: stopped")
 
 
+// Ready encapsulates the entries and messages that are ready to be saved to
+// stable storage, committed or sent to other peers.
 type Ready struct {
 type Ready struct {
 	// The current state of a Node
 	// The current state of a Node
 	pb.State
 	pb.State