1// Copyright 2015 The etcd Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package raft
16
17import (
18	pb "go.etcd.io/etcd/raft/raftpb"
19)
20
21func applyToStore(ents []pb.Entry)    {}
22func sendMessages(msgs []pb.Message)  {}
23func saveStateToDisk(st pb.HardState) {}
24func saveToDisk(ents []pb.Entry)      {}
25
26func ExampleNode() {
27	c := &Config{}
28	n := StartNode(c, nil)
29	defer n.Stop()
30
31	// stuff to n happens in other goroutines
32
33	// the last known state
34	var prev pb.HardState
35	for {
36		// Ready blocks until there is new state ready.
37		rd := <-n.Ready()
38		if !isHardStateEqual(prev, rd.HardState) {
39			saveStateToDisk(rd.HardState)
40			prev = rd.HardState
41		}
42
43		saveToDisk(rd.Entries)
44		go applyToStore(rd.CommittedEntries)
45		sendMessages(rd.Messages)
46	}
47}
48