background_worker

type BackgroundStopper interface {
	IsStopped() bool
}

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

type BackgroundWorker struct {
	logger.WithLoggerBase

	Period int
	Name   string

	CondChan *condchan.CondChan
	Finished chan bool
	Stopped  atomic.Bool
	Running  atomic.Bool

	JobRunner JobRunner
}

type Finisher interface {
	AddRunner(runner Runner, config ...*RunnerConfig)
	Wait()
	Shutdown(ctx context.Context) error
	RemoveRunner(name string)
}

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

type FinisherConfig struct {
	FinisherMainConfig

	// Log can be set to change where finish logs to.
	Logger logger.Logger
}

type FinisherMainConfig struct {

	// Timeout is the maximum amount of time to wait for
	// still running runners requests to finish,
	// when the shutdown signal was received for each runner.
	//
	// It defaults to DefaultTimeout which is 10 seconds.
	//
	// The timeout can be overridden on a per-server basis with passing the
	// WithTimeout() option to Add() while adding the runner.
	Timeout time.Duration

	// Signals can be used to change which signals finish catches to initiate
	// the shutdown.
	// It defaults to DefaultSignals which contains SIGINT and SIGTERM.
	Signals []os.Signal
}

type JobRunner interface {
	RunJob()
	StopJob()
	SetStopper(stopper BackgroundStopper)
	Stopper() BackgroundStopper
}

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

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

type RunnerConfig struct {
	Name    optional.String
	Timeout optional.Int
}

type WithBackgroundWorker interface {
	Worker() *BackgroundWorker
}

type WithBackgroundWorkerBase struct {
	WorkerInterface *BackgroundWorker
}