driver

Documentation

Index

• func Do(ctx context.Context, config Config, planner Planner) (ReportFunc, WaitFunc)
• type Config
  • func (c Config) Validate() error
• type FS
• type Planner
• type ReportFunc
• type Step
• type StepCompletedFunc
• type WaitFunc

Functions

func Do

func Do(ctx context.Context, config Config, planner Planner) (ReportFunc, WaitFunc)

caller must ensure config.Validate() == nil

Types

type Config

type Config struct {
	StepQueueConcurrency     int           `validate:"gte=1"`
	MaxAttempts              int           `validate:"eq=-1|gt=0"`
	ReconnectHardFailTimeout time.Duration `validate:"gt=0"`
}

func (Config) Validate

func (c Config) Validate() error

type FS

type FS interface {
	// Returns true if this FS and fs refer to the same filesystem returned
	// by Planner.Plan in a previous attempt.
	EqualToPreviousAttempt(fs FS) bool
	// The returned steps are assumed to be dependent on exactly
	// their direct predecessors in the returned list.
	PlanFS(context.Context) ([]Step, error)
	ReportInfo() *report.FilesystemInfo
}

type Planner

type Planner interface {
	Plan(context.Context) ([]FS, error)
	WaitForConnectivity(context.Context) error
}

type ReportFunc

type ReportFunc func() *report.Report

type Step

type Step interface {
	// Returns true iff the target snapshot is the same for this Step and other.
	// We do not use TargetDate to avoid problems with wrong system time on
	// snapshot creation.
	//
	// Implementations can assume that `other` is a step of the same filesystem,
	// although maybe from a previous attempt.
	// (`same` as defined by FS.EqualToPreviousAttempt)
	//
	// Note that TargetEquals should return true in a situation with one
	// originally sent snapshot and a subsequent attempt's step that uses
	// resumable send & recv.
	TargetEquals(other Step) bool
	TargetDate() time.Time
	Step(context.Context) error
	ReportInfo() *report.StepInfo
}

type StepCompletedFunc

type StepCompletedFunc func()

type WaitFunc

type WaitFunc func(block bool) (done bool)