leadership

Documentation

Index

• Constants
• type LeaderElection
  • func NewLeaderElection(props LeaderElectionProps) *LeaderElection
  • func (l *LeaderElection) Members() ([]Member, error)
  • func (l *LeaderElection) Start()
• type LeaderElectionProps
• type Member

Constants

const DEFAULT_HEARTBEAT = 60 * time.Second

const RESULT_ELECTED = "elected"

Types

type LeaderElection

type LeaderElection struct {
	Id      string
	Leader  Member
	Results chan string
	// contains filtered or unexported fields
}

LeaderElection provides methods for electing a leader out of eligible cluster members

func NewLeaderElection

func NewLeaderElection(props LeaderElectionProps) *LeaderElection

NewLeaderElection creates an instance of a LeaderElection struct

func (*LeaderElection) Members

func (l *LeaderElection) Members() ([]Member, error)

Members returns a list of cluster members

func (*LeaderElection) Start

func (l *LeaderElection) Start()

Start triggers a new leader election

type LeaderElectionProps

type LeaderElectionProps struct {
	HeartbeatInterval time.Duration
	StorageAdapter    storage.StorageAdapter
	AdditionalProps   map[string]any
}

LeaderElectionProps represents the properties required to instantiate new leader election

type Member

type Member struct {
	Id           string
	Registration int64
	Heartbeat    int64
}

Member represents a leadership eligible cluster node