leadership

Documentation

Index

• type AvailabilityCriteria
• type Candidate
• type State

Types

type AvailabilityCriteria

type AvailabilityCriteria func() bool

type Candidate

type Candidate interface {
	Init(context.Context)
	Deinit(context.Context)
	AddAvailabilityCriteria(AvailabilityCriteria)
	TryBecomeLeader(context.Context) bool
	RenewLeadershipLease(context.Context)
	IsAvailable() bool
	IsCurrentLeader(context.Context) bool
	UpdateCandidateStatus(context.Context, bool)
	TrimCandidates(context.Context)
	GetLeaderCandidates(context.Context) []string
	SetState(context.Context, State)
	SetLeaderAndCandidateFields(context.Context)
	DoWork(context.Context)

	LosingLeadership() signalslots.Signal
	BecameLeader() signalslots.Signal
	BecameFollower() signalslots.Signal
	BecameUnavailable() signalslots.Signal

	CandidateUpdate() <-chan time.Time
	LeaderAttempt() <-chan time.Time
	LeaseRenewal() <-chan time.Time
}

type State

type State interface {
	DoWork(context.Context, Candidate)
	OnEnterState(context.Context, Candidate, State)
	Name() string
}