elector

Documentation

Index

• type Elector
  • func New(store *engine.SessionStore, key string, sessionTimeout time.Duration, ...) (*Elector, error)
  • func (e *Elector) IsLeader() bool
  • func (e *Elector) Release(ctx context.Context) error
  • func (e *Elector) Resign(ctx context.Context) error
  • func (e *Elector) Run(ctx context.Context) error
  • func (e *Elector) Wait()
• type Runner

Types

type Elector

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

func New

func New(store *engine.SessionStore, key string, sessionTimeout time.Duration, runner Runner) (*Elector, error)

New is used to create an elector instance

func (*Elector) IsLeader

func (e *Elector) IsLeader() bool

IsLeader is used to check if the elector is leader

func (*Elector) Release

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

Release is used to stop the elector instance and release the session

func (*Elector) Resign

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

Resign is used to resign the leader if the elector is leader role now

func (*Elector) Run

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

Run is used to start the elector instance

func (*Elector) Wait

func (e *Elector) Wait()

type Runner

type Runner interface {
	Run(ctx context.Context) error
}