elect

Documentation

Index

• func NewElection(lg *zap.Logger, etcdCli *clientv3.Client, cfg ElectionConfig, id, key string, ...) *election
• type Election
• type ElectionConfig
  • func DefaultElectionConfig(sessionTTL int) ElectionConfig
• type Member

Functions

func NewElection

func NewElection(lg *zap.Logger, etcdCli *clientv3.Client, cfg ElectionConfig, id, key string, member Member) *election

NewElection creates an Election.

Types

type Election

type Election interface {
	// Start starts compaining the owner.
	Start(context.Context)
	// ID returns the member ID.
	ID() string
	// GetOwnerID gets the owner ID.
	GetOwnerID(ctx context.Context) (string, error)
	// Close resigns and but doesn't retire.
	Close()
}

Election is used to campaign the owner and manage the owner information.

type ElectionConfig

type ElectionConfig struct {
	Timeout          time.Duration
	RetryIntvl       time.Duration
	QueryIntvl       time.Duration
	WaitBeforeRetire time.Duration
	RetryCnt         uint64
	SessionTTL       int
}

func DefaultElectionConfig

func DefaultElectionConfig(sessionTTL int) ElectionConfig

type Member

type Member interface {
	OnElected()
	OnRetired()
}