switcher

Documentation

Overview

Package switcher contains a meta-Sequencer that switches between various modes of operation.

Index

• Variables
• type Mode
  • func (i Mode) String() string
• type Switcher
  • func ProvideSequencer(best *besteffort.BestEffort, core *core.Core, diags *diag.Diagnostics, ...) *Switcher
  • func (s *Switcher) Start(ctx *stopper.Context, opts *sequencer.StartOptions) (types.MultiAcceptor, *notify.Var[sequencer.Stat], error)
  • func (s *Switcher) WithMode(mode *notify.Var[Mode]) *Switcher

Variables

var Set = wire.NewSet(
	besteffort.Set,
	chaos.Set,
	core.Set,
	immediate.Set,
	script.Set,
	scheduler.Set,

	ProvideSequencer,
)

Set is used by Wire.

Types

type Mode

type Mode int

Mode describes a strategy using another sequencer.

const (
	ModeUnknown Mode = iota
	ModeBestEffort
	ModeConsistent
	ModeImmediate

	MaxMode = iota - 1 // Used for testing all modes.
	MinMode = Mode(1)  // Used for testing all modes.
)

The modes of operation that can be dynamically selected from.

func (Mode) String

func (i Mode) String() string

type Switcher

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

Switcher switches between delegate sequencers. It also adds script bindings into the sequencer stack.

func ProvideSequencer

func ProvideSequencer(
	best *besteffort.BestEffort,
	core *core.Core,
	diags *diag.Diagnostics,
	imm *immediate.Immediate,
	script *script.Sequencer,
	stagingPool *types.StagingPool,
	targetPool *types.TargetPool,
) *Switcher

ProvideSequencer is called by Wire.

func (*Switcher) Start

func (s *Switcher) Start(
	ctx *stopper.Context, opts *sequencer.StartOptions,
) (types.MultiAcceptor, *notify.Var[sequencer.Stat], error)

Start a sequencer that can switch between various modes of operation. Callers must call Switcher.WithMode before calling this method.

func (*Switcher) WithMode

func (s *Switcher) WithMode(mode *notify.Var[Mode]) *Switcher

WithMode returns a copy of the Switcher that uses the given variable for mode control. This method exists so that Switcher can satisfy the sequencer.Sequencer interface.