leader

Documentation

Overview

Package leader provides leader election

Index

• type ElectOption
• type ElectOptions
• type Elected
• type Leader
• type Option
  • func Group(g string) Option
  • func Nodes(a ...string) Option
• type Options

Types

type ElectOption

type ElectOption func(o *ElectOptions)

type ElectOptions

type ElectOptions struct{}

type Elected

type Elected interface {
	// id of leader
	Id() string
	// seek re-election
	Reelect() error
	// resign leadership
	Resign() error
	// observe leadership revocation
	Revoked() chan bool
}

type Leader

type Leader interface {
	// elect leader
	Elect(id string, opts ...ElectOption) (Elected, error)
	// follow the leader
	Follow() chan string
}

Leader provides leadership election

type Option

type Option func(o *Options)

func Group

func Group(g string) Option

Group sets the group name for coordinating leadership

func Nodes

func Nodes(a ...string) Option

Nodes sets the addresses of the underlying systems

type Options

type Options struct {
	Nodes []string
	Group string
}