cleaner

Documentation

Index

• func Manifold(config ManifoldConfig) dependency.Manifold
• func NewCleaner(st StateCleaner, clock clock.Clock, logger Logger) (worker.Worker, error)
• type Cleaner
  • func (c *Cleaner) Kill()
  • func (c *Cleaner) Wait() error
• type Logger
• type ManifoldConfig
  • func (config ManifoldConfig) Validate() error
• type StateCleaner

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a Manifold that encapsulates the cleanup worker.

func NewCleaner

func NewCleaner(st StateCleaner, clock clock.Clock, logger Logger) (worker.Worker, error)

NewCleaner returns a worker.Worker that runs state.Cleanup() periodically, and whenever the CleanupWatcher signals documents marked for deletion.

Types

type Cleaner

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

Cleaner is responsible for cleaning up the state.

func (*Cleaner) Kill

func (c *Cleaner) Kill()

Kill is part of the worker.Worker interface.

func (*Cleaner) Wait

func (c *Cleaner) Wait() error

Wait is part of the worker.Worker interface.

type Logger

type Logger interface {
	Errorf(string, ...interface{})
}

Logger represents the methods used by the worker to log information.

type ManifoldConfig

type ManifoldConfig struct {
	APICallerName string
	Clock         clock.Clock
	Logger        Logger
}

ManifoldConfig describes the resources used by the cleanup worker.

func (ManifoldConfig) Validate

func (config ManifoldConfig) Validate() error

Validate is called by start to check for bad configuration.

type StateCleaner

type StateCleaner interface {
	Cleanup() error
	WatchCleanups() (watcher.NotifyWatcher, error)
}