leaderelection

Documentation

Index

• type DistributedElectionParticipant
  • func NewElectionParticipant(lock dl.Lock, resourceName string, options ElectionParticipantOptions) *DistributedElectionParticipant
  • func (p *DistributedElectionParticipant) Close() error
  • func (p *DistributedElectionParticipant) IsLeader() bool
  • func (p *DistributedElectionParticipant) Start() error
• type ElectionParticipant
• type ElectionParticipantOptions

Types

type DistributedElectionParticipant

type DistributedElectionParticipant struct {
	ElectionParticipantOptions
	// contains filtered or unexported fields
}

DistributedElectionParticipant implements ElectionParticipant on top of a distributed lock.

func NewElectionParticipant

func NewElectionParticipant(lock dl.Lock, resourceName string, options ElectionParticipantOptions) *DistributedElectionParticipant

NewElectionParticipant returns a ElectionParticipant which attempts to become leader.

func (*DistributedElectionParticipant) Close

func (p *DistributedElectionParticipant) Close() error

Close implements io.Closer.

func (*DistributedElectionParticipant) IsLeader

func (p *DistributedElectionParticipant) IsLeader() bool

IsLeader returns true if this process is the leader.

func (*DistributedElectionParticipant) Start

func (p *DistributedElectionParticipant) Start() error

Start runs a background thread which attempts to acquire the leader lock.

type ElectionParticipant

type ElectionParticipant interface {
	io.Closer

	IsLeader() bool
	Start() error
}

ElectionParticipant partakes in leader election to become leader.

type ElectionParticipantOptions

type ElectionParticipantOptions struct {
	LeaderLeaseRefreshInterval   time.Duration
	FollowerLeaseRefreshInterval time.Duration
	Logger                       *zap.Logger
}

ElectionParticipantOptions control behavior of the election participant. TODO func applyDefaults(), parameter error checking, etc.