cleaner

Documentation

Index

• func Manifold(config ManifoldConfig) dependency.Manifold
• func NewCleaner(st StateCleaner) (worker.Worker, error)
• type Cleaner
  • func (c *Cleaner) Handle(_ <-chan struct{}) error
  • func (c *Cleaner) SetUp() (watcher.NotifyWatcher, error)
  • func (c *Cleaner) TearDown() error
• type ManifoldConfig
• 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) (worker.Worker, error)

NewCleaner returns a worker.Worker that runs state.Cleanup() if 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) Handle

func (c *Cleaner) Handle(_ <-chan struct{}) error

func (*Cleaner) SetUp

func (c *Cleaner) SetUp() (watcher.NotifyWatcher, error)

func (*Cleaner) TearDown

func (c *Cleaner) TearDown() error

type ManifoldConfig

type ManifoldConfig engine.APIManifoldConfig

ManifoldConfig describes the resources used by the cleanup worker.

type StateCleaner

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