leadership

Documentation

Index

• type Leadership
• type Store
  • func NewAtomixStore(cluster cluster.Cluster, config config.Config) (Store, error)
  • func NewLocalStore(clusterID string, nodeID cluster.NodeID) (Store, error)
• type Term

Types

type Leadership

type Leadership struct {
	// Term is the leadership term
	Term Term

	// Leader is the NodeID of the leader
	Leader cluster.NodeID
}

Leadership contains information about a leadership term

type Store

type Store interface {
	io.Closer

	// NodeID returns the local node identifier used in the election
	NodeID() cluster.NodeID

	// IsLeader returns a boolean indicating whether the local node is the leader
	IsLeader() (bool, error)

	// Watch watches the store for changes
	Watch(chan<- Leadership) error
}

Store is the cluster wide leadership store

func NewAtomixStore

func NewAtomixStore(cluster cluster.Cluster, config config.Config) (Store, error)

NewAtomixStore returns a new persistent Store

func NewLocalStore

func NewLocalStore(clusterID string, nodeID cluster.NodeID) (Store, error)

NewLocalStore returns a new local election store

type Term

type Term uint64

Term is a monotonically increasing leadership term