raftor

type Applier interface {

	// Apply processes commit messages after being processed by Raft
	Apply(Commit)
}

type Cluster interface {
	Notifier
	Applier
	Updater

	// ID represents the cluster ID.
	ID() uint64

	// Name returns the Cluster's name.
	Name() string

	// GetMember returns a Member instance based on it's ID.
	GetMember(uint64) Member

	// IsBanished checks whether the given ID has been removed from this
	// cluster at some point in the past.
	IsBanished(id uint64) bool

	// LocalNode returns the RaftNode which represents the local node of the cluster.
	LocalNode() RaftNode

	// Stop stops the cluster and triggers the context when finished.
	Stop(context.Context)
}

type ClusterChangeEvent struct {
	Type   ClusterEventType
	Member Member
}

type ClusterChangeHandler interface {

	// HandleJoin is called when a node joins the cluster.
	HandleJoin(ClusterChangeEvent)

	// HandleJoin is called when a node leaves the cluster.
	HandleLeave(ClusterChangeEvent)

	// HandleJoin is called when a node is updated.
	HandleUpdate(ClusterChangeEvent)
}

type ClusterConfig struct {
	Name string
	Raft raft.Config
}

type ClusterEventType uint8

type Commit struct {
	State    RaftState
	Entries  []raftpb.Entry
	Snapshot raftpb.Snapshot
	Messages []raftpb.Message
	Context  context.Context
}

type Member interface {
	ID() uint64
	Meta() []byte
}

type Notifier interface {

	// Notify returns a read-only channel of ClusterChangeEvents which can be read when a node joins, leaves or is updated in the cluster.
	Notify(ClusterChangeEvent)
}

type RaftNode interface {
	raft.Node
	Starter
}

type RaftState struct {
	CommitID             uint64
	Vote                 uint64
	Term                 uint64
	Lead                 uint64
	LastLeadElectionTime time.Time
	RaftState            raft.StateType
}

type Starter interface {
	Start()
}

type Stopper interface {
	Stop() <-chan struct{}
}

type Updater interface {

	// Update is called after the ClusterChangeEvent has been processed and stored by Raft.
	Update(ClusterChangeEvent)
}