leadership

Documentation

Index

• type Config
• type Elector
  • func NewElector(archetype *baseservice.Archetype, exec riverdriver.Executor, ...) *Elector
  • func (e *Elector) Listen() *Subscription
  • func (e *Elector) Start(ctx context.Context) error
• type Notification
• type Subscription
  • func (s *Subscription) C() <-chan *Notification
  • func (s *Subscription) Unlisten()

Types

type Config

type Config struct {
	ClientID            string
	ElectInterval       time.Duration // period on which each elector attempts elect even without having received a resignation notification
	ElectIntervalJitter time.Duration
}

type Elector

type Elector struct {
	baseservice.BaseService
	startstop.BaseStartStop
	// contains filtered or unexported fields
}

func NewElector

func NewElector(archetype *baseservice.Archetype, exec riverdriver.Executor, notifier *notifier.Notifier, config *Config) *Elector

NewElector returns an Elector using the given adapter. The name should correspond to the name of the database + schema combo and should be shared across all Clients running with that combination. The id should be unique to the Client.

func (*Elector) Listen

func (e *Elector) Listen() *Subscription

func (*Elector) Start

func (e *Elector) Start(ctx context.Context) error

type Notification

type Notification struct {
	IsLeader  bool
	Timestamp time.Time
}

type Subscription

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

func (*Subscription) C

func (s *Subscription) C() <-chan *Notification

func (*Subscription) Unlisten

func (s *Subscription) Unlisten()