pgxelection

Documentation

Index

• Constants
• type ClusterPgStore
• type FollowResult
• type Follower
• type PgNotifier
• type PgxFollower
  • func NewPgxFollower(cfg PgxFollowerConfig) *PgxFollower
  • func (p *PgxFollower) Follow() (result FollowResult)
  • func (p *PgxFollower) Promote()
• type PgxFollowerConfig
• type PgxLeader
  • func NewPgxLeader(cfg PgxLeaderConfig) *PgxLeader
  • func (p *PgxLeader) Key() string
  • func (p *PgxLeader) Lead() error
• type PgxLeaderConfig
• type PgxPgNotifier
  • func NewPgxPgNotifier(cfg PgxPgNotifierConfig) *PgxPgNotifier
  • func (p *PgxPgNotifier) Notify(channel string, msgBytes []byte) error
• type PgxPgNotifierConfig
• type Queue

Constants

const LevelTrace = slog.Level(-8)

const MaxChannelLen = 63

Types

type ClusterPgStore

type ClusterPgStore interface {
	Nodes() (map[string]*electiontypes.ClusterNode, error)
}

ClusterPgStore provides an interface that is used to enumerate a secondary list of nodes. Typically, this list comes from a database table and can be used to verify that a cluster is healthy.

type FollowResult

type FollowResult bool

const (
	FollowResultPromote FollowResult = true
	FollowResultStop    FollowResult = false
)

type Follower

type Follower interface {
	Follow() FollowResult
	Promote()
}

type PgNotifier

type PgNotifier interface {
	Notify(channel string, msgBytes []byte) error
}

type PgxFollower

type PgxFollower struct {
	// contains filtered or unexported fields
}

func NewPgxFollower

func NewPgxFollower(cfg PgxFollowerConfig) *PgxFollower

func (*PgxFollower) Follow

func (p *PgxFollower) Follow() (result FollowResult)

func (*PgxFollower) Promote

func (p *PgxFollower) Promote()

type PgxFollowerConfig

type PgxFollowerConfig struct {
	Queue         Queue
	Broadcaster   broadcaster.Broadcaster
	Notifier      PgNotifier
	LeaderChannel string
	Address       string
	StopChan      chan bool
	Timeout       time.Duration
}

type PgxLeader

type PgxLeader struct {
	// contains filtered or unexported fields
}

func NewPgxLeader

func NewPgxLeader(cfg PgxLeaderConfig) *PgxLeader

func (*PgxLeader) Key

func (p *PgxLeader) Key() string

func (*PgxLeader) Lead

func (p *PgxLeader) Lead() error

type PgxLeaderConfig

type PgxLeaderConfig struct {
	Store           ClusterPgStore
	Broadcaster     broadcaster.Broadcaster
	Notifier        PgNotifier
	TaskHandler     rselection.TaskHandler
	LeaderChannel   string
	FollowerChannel string
	MessagesChannel string
	Address         string
	StopChan        chan bool
	PingInterval    time.Duration
	SweepInterval   time.Duration
	MaxPingAge      time.Duration
}

type PgxPgNotifier

type PgxPgNotifier struct {
	// contains filtered or unexported fields
}

func NewPgxPgNotifier

func NewPgxPgNotifier(cfg PgxPgNotifierConfig) *PgxPgNotifier

func (*PgxPgNotifier) Notify

func (p *PgxPgNotifier) Notify(channel string, msgBytes []byte) error

type PgxPgNotifierConfig

type PgxPgNotifierConfig struct {
	Pool *pgxpool.Pool
}

type Queue

type Queue interface {
	Push(assumeLeader electiontypes.AssumeLeader) error
}

Queue is not provided by the election library. Implement this interface. When new leadership is needed, an `electiontypes.AssumeLeader` job will be pushed to the queue.