election

Documentation

Index

• func Module() fx.Option
• type Election
  • func ProvideElection(in ElectionIn) (*Election, error)
  • func (e *Election) IsLeader() bool
• type ElectionIn

Functions

func Module

func Module() fx.Option

Module is a fx module that provides etcd based leader election per agent group.

Types

type Election

type Election struct {
	Election *concurrencyv3.Election
	// contains filtered or unexported fields
}

Election is a wrapper around etcd election.

func ProvideElection

func ProvideElection(in ElectionIn) (*Election, error)

ProvideElection provides a wrapper around etcd based leader election.

func (*Election) IsLeader

func (e *Election) IsLeader() bool

IsLeader returns true if the current node is the leader.

type ElectionIn

type ElectionIn struct {
	fx.In
	Lifecycle  fx.Lifecycle
	Shutdowner fx.Shutdowner
	Client     *etcd.Client
	AgentInfo  *agentinfo.AgentInfo
}

ElectionIn holds parameters for ProvideElection.