raft

Documentation

Index

• func NewRaftNode(raftnode *RaftNode, keys *keys.Keys, TLSConfig *tls.Config, id uint64, ...) (<-chan *Commit, <-chan error, <-chan *snap.Snapshotter)
• type Commit
• type KVStore
  • func NewKVStore(snapshotter *snap.Snapshotter, badger *badger.DB, mgr *manager.Manager, ...) *KVStore
  • func (s *KVStore) GetSnapshot() ([]byte, error)
  • func (s *KVStore) Propose(k string, v string)
• type RaftNode
  • func (rc *RaftNode) IsIDRemoved(_ uint64) bool
  • func (rc *RaftNode) NodeReady() <-chan raft.Ready
  • func (rc *RaftNode) Process(ctx context.Context, m raftpb.Message) error
  • func (rc *RaftNode) ReportSnapshot(id uint64, status raft.SnapshotStatus)
  • func (rc *RaftNode) ReportUnreachable(id uint64)

Functions

func NewRaftNode

func NewRaftNode(raftnode *RaftNode, keys *keys.Keys, TLSConfig *tls.Config, id uint64, peers []string, join bool, getSnapshot func() ([]byte, error), proposeC <-chan string,
	confChangeC <-chan raftpb.ConfChange) (<-chan *Commit, <-chan error, <-chan *snap.Snapshotter)

newRaftNode initiates a raft instance and returns a committed log entry channel and error channel. Proposals for log updates are sent over the provided the proposal channel. All log entries are replayed over the commit channel, followed by a nil message (to indicate the channel is current), then new log entries. To shutdown, close proposeC and read errorC.

Types

type Commit

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

type KVStore

type KVStore struct {
	ConfChangeC chan<- raftpb.ConfChange // channel for proposing updates
	// contains filtered or unexported fields
}

a key-value store backed by raft

func NewKVStore

func NewKVStore(snapshotter *snap.Snapshotter, badger *badger.DB, mgr *manager.Manager, proposeC chan<- string, commitC <-chan *Commit, errorC <-chan error) *KVStore

func (*KVStore) GetSnapshot

func (s *KVStore) GetSnapshot() ([]byte, error)

func (*KVStore) Propose

func (s *KVStore) Propose(k string, v string)

type RaftNode

type RaftNode struct {
	Peers []string // raft peer URLs

	TLSConfig *tls.Config
	// contains filtered or unexported fields
}

A key-value stream backed by raft

func (*RaftNode) IsIDRemoved

func (rc *RaftNode) IsIDRemoved(_ uint64) bool

func (*RaftNode) NodeReady

func (rc *RaftNode) NodeReady() <-chan raft.Ready

func (*RaftNode) Process

func (rc *RaftNode) Process(ctx context.Context, m raftpb.Message) error

func (*RaftNode) ReportSnapshot

func (rc *RaftNode) ReportSnapshot(id uint64, status raft.SnapshotStatus)

func (*RaftNode) ReportUnreachable

func (rc *RaftNode) ReportUnreachable(id uint64)